vlink::Status::SubscriptionMatched Struct Reference

Status event fired when a DataReader gains or loses a matching DataWriter. More...

#include <status_detail.h>

Inheritance diagram for vlink::Status::SubscriptionMatched:

Collaboration diagram for vlink::Status::SubscriptionMatched:

Public Member Functions
Type	get_type () const override
	Returns kSubscriptionMatched.
std::string	get_string () const override
	Returns a human-readable summary of this status.
Public Member Functions inherited from vlink::Status::Base
template<typename T>
std::shared_ptr< T >	as () const
	Safely downcasts this status to a concrete type T.

Public Attributes
int32_t	total_count {0}
	Cumulative number of writers ever matched.
int32_t	total_count_change {0}
	Change in total_count since last callback.
int32_t	current_count {0}
	Number of writers currently matched.
int32_t	current_count_change {0}
	Change in current_count since last callback.
InstanceHandle	last_publication_handle {nullptr}
	Handle of the most recently matched writer.

Friends
VLINK_EXPORT friend std::ostream &	operator<< (std::ostream &ostream, const SubscriptionMatched &status) noexcept
	Writes the status fields to ostream.

Additional Inherited Members
Protected Member Functions inherited from vlink::Status::Base
	Base ()
virtual	~Base ()

Detailed Description

Status event fired when a DataReader gains or loses a matching DataWriter.

Delivered to the reader's status callback whenever a publisher that matches the topic name and QoS policy appears or disappears.

Member Function Documentation

get_string()

std::string vlink::Status::SubscriptionMatched::get_string ( ) const

nodiscardoverridevirtual

Returns a human-readable summary of this status.

Returns

String describing total and current matched writer counts.

Implements vlink::Status::Base.

get_type()

Type vlink::Status::SubscriptionMatched::get_type ( ) const

nodiscardoverridevirtual

Returns kSubscriptionMatched.

Returns

Status type identifier.

Implements vlink::Status::Base.

Friends And Related Symbol Documentation

operator<<

VLINK_EXPORT friend std::ostream & operator<< ( std::ostream & ostream, const SubscriptionMatched & status )

friend

Writes the status fields to ostream.

Parameters

ostream	Output stream.
status	This SubscriptionMatched status.

Returns

Reference to ostream.

Member Data Documentation

current_count

int32_t vlink::Status::SubscriptionMatched::current_count {0}

Number of writers currently matched.

current_count_change

int32_t vlink::Status::SubscriptionMatched::current_count_change {0}

Change in current_count since last callback.

last_publication_handle

InstanceHandle vlink::Status::SubscriptionMatched::last_publication_handle {nullptr}

Handle of the most recently matched writer.

total_count

int32_t vlink::Status::SubscriptionMatched::total_count {0}

Cumulative number of writers ever matched.

total_count_change

int32_t vlink::Status::SubscriptionMatched::total_count_change {0}

Change in total_count since last callback.

---

The documentation for this struct was generated from the following file:

• include/vlink/extension/status_detail.h