Reader-side event raised when the liveliness of a matched publisher changes. More...

#include <status_detail.h>

Inheritance diagram for vlink::Status::LivelinessChanged:

Collaboration diagram for vlink::Status::LivelinessChanged:

Public Member Functions
Type	get_type () const override
	Returns `kLivelinessChanged`. More...

std::string	get_string () const override
	Returns the literal `"LivelinessChanged"`. 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	alive_count {0}
	Matched publishers currently considered alive. More...

int32_t	not_alive_count {0}
	Matched publishers currently considered not alive. More...

int32_t	alive_count_change {0}
	Delta in `alive_count` since the last notification. More...

int32_t	not_alive_count_change {0}
	Delta in `not_alive_count` since the last notification. More...

InstanceHandle	last_publication_handle {nullptr}
	Opaque handle of the publisher whose state changed. More...

Friends
VLINK_EXPORT friend std::ostream &	operator<< (std::ostream &ostream, const LivelinessChanged &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 the liveliness of a matched publisher changes.

The alive_count and not_alive_count fields hold the current totals; the matching *_change fields hold the delta since the last notification.

Member Function Documentation

◆ get_string()

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

overridevirtual

Returns the literal "LivelinessChanged".

Returns: Event name string.

Implements vlink::Status::Base.

◆ get_type()

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

overridevirtual

Returns kLivelinessChanged.

Returns: Status type discriminator.

Implements vlink::Status::Base.

Friends And Related Function Documentation

◆ operator<<

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

friend

Streams the counter fields to ostream.

Parameters

ostream	Output stream.
status	Event to print.

Returns: Reference to ostream.

Member Data Documentation

◆ alive_count

int32_t vlink::Status::LivelinessChanged::alive_count {0}

Matched publishers currently considered alive.

◆ alive_count_change

int32_t vlink::Status::LivelinessChanged::alive_count_change {0}

Delta in alive_count since the last notification.

◆ last_publication_handle

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

Opaque handle of the publisher whose state changed.

◆ not_alive_count

int32_t vlink::Status::LivelinessChanged::not_alive_count {0}

Matched publishers currently considered not alive.

◆ not_alive_count_change

int32_t vlink::Status::LivelinessChanged::not_alive_count_change {0}

Delta in not_alive_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