vlink::Status::LivelinessChanged Struct Reference

Status event fired when the liveliness state of a matched DataWriter 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.
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	alive_count {0}
	Number of matched writers that are currently alive.
int32_t	not_alive_count {0}
	Number of matched writers that are not alive.
int32_t	alive_count_change {0}
	Change in alive_count since last callback.
int32_t	not_alive_count_change {0}
	Change in not_alive_count since last callback.
InstanceHandle	last_publication_handle {nullptr}
	Handle of the writer that most recently changed.

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

Tracks how many matched publishers are alive versus not alive. The last_publication_handle identifies the writer whose liveliness state most recently changed.

Member Function Documentation

get_string()

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

nodiscardoverridevirtual

Returns a human-readable summary of this status.

Returns

String describing alive and not-alive writer counts.

Implements vlink::Status::Base.

get_type()

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

nodiscardoverridevirtual

Returns kLivelinessChanged.

Returns

Status type identifier.

Implements vlink::Status::Base.

Friends And Related Symbol Documentation

operator<<

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

friend

Writes the status fields to ostream.

Parameters

ostream	Output stream.
status	This LivelinessChanged status.

Returns

Reference to ostream.

Member Data Documentation

alive_count

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

Number of matched writers that are currently alive.

alive_count_change

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

Change in alive_count since last callback.

last_publication_handle

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

Handle of the writer that most recently changed.

not_alive_count

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

Number of matched writers that are not alive.

not_alive_count_change

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

Change in not_alive_count since last callback.

---

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

• include/vlink/extension/status_detail.h