Reader-side event raised when a matching publisher appears or disappears. 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`. More...

std::string	get_string () const override
	Returns the literal `"SubscriptionMatched"`. More...

Public Member Functions inherited from vlink::Status::Base
template<typename T >
std::shared_ptr< T >	as () const
	Safely narrows this event to a concrete `Status` subclass. More...

Public Attributes
int32_t	total_count {0}
	Cumulative publishers ever matched. More...

int32_t	total_count_change {0}
	Delta in `total_count` since the last notification. More...

int32_t	current_count {0}
	Publishers currently matched. More...

int32_t	current_count_change {0}
	Delta in `current_count` since the last notification. More...

InstanceHandle	last_publication_handle {nullptr}
	Opaque handle of the publisher that triggered this event. More...

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

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

virtual	~Base ()

Detailed Description

Reader-side event raised when a matching publisher appears or disappears.

Member Function Documentation

◆ get_string()

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

overridevirtual

Returns the literal "SubscriptionMatched".

Returns: Event name string.

Implements vlink::Status::Base.

◆ get_type()

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

overridevirtual

Returns kSubscriptionMatched.

Returns: Status type discriminator.

Implements vlink::Status::Base.

Friends And Related Function Documentation

◆ operator<<

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

friend

Streams the counter fields to ostream.

Parameters

ostream	Output stream.
status	Event to print.

Returns: Reference to ostream.

Member Data Documentation

◆ current_count

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

Publishers currently matched.

◆ current_count_change

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

Delta in current_count since the last notification.

◆ last_publication_handle

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

Opaque handle of the publisher that triggered this event.

◆ total_count

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

Cumulative publishers ever matched.

◆ total_count_change

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

Delta in total_count since the last notification.

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

include/vlink/extension/status_detail.h

Public Member Functions

Public Attributes

Friends

Additional Inherited Members