dds::core::status::LivelinessChangedStatus Class Reference

Information about the status dds::core::status::StatusMask::liveliness_changed() More...

#include <TStatus.hpp>

Public Member Functions
int32_t	alive_count () const
	The total count of currently alive dds::pub::DataWriter entities that write the dds::topic::Topic the dds::sub::DataReader reads.
int32_t	not_alive_count () const
	The total count of currently not_alive dds::pub::DataWriter entities that write the dds::topic::Topic the dds::sub::DataReader reads.
int32_t	alive_count_change () const
	The change in the alive_count since the last time the listener was called or the status was read.
int32_t	not_alive_count_change () const
	The change in the not_alive_count since the last time the listener was called or the status was read.
const dds::core::InstanceHandle	last_publication_handle () const
	An instance handle to the last remote writer to change its liveliness.

Detailed Description

Information about the status dds::core::status::StatusMask::liveliness_changed()

The dds::sub::DataReaderListener::on_liveliness_changed callback may be invoked for the following reasons:

• Liveliness is truly lost - a sample has not been received within the timeframe specified in dds::core::policy::Liveliness::lease_duration

• Liveliness is recovered after being lost.

• A new matching entity has been discovered.

• A QoS has changed such that a pair of matching entities are no longer matching (such as a change to the dds::core::policy::Partition). In this case, RTI Connext will no longer keep track of the entities' liveliness. Furthermore:
  • If liveliness was maintained: dds::core::status::LivelinessChangedStatus::alive_count will decrease and dds::core::status::LivelinessChangedStatus::not_alive_count will remain the same.
  • If liveliness had been lost: dds::core::status::LivelinessChangedStatus::alive_count will remain the same and dds::core::status::LivelinessChangedStatus::not_alive_count will decrease.

Member Function Documentation

int32_t dds::core::status::LivelinessChangedStatus::alive_count ( ) const

inline

The total count of currently alive dds::pub::DataWriter entities that write the dds::topic::Topic the dds::sub::DataReader reads.

int32_t dds::core::status::LivelinessChangedStatus::not_alive_count ( ) const

inline

The total count of currently not_alive dds::pub::DataWriter entities that write the dds::topic::Topic the dds::sub::DataReader reads.

int32_t dds::core::status::LivelinessChangedStatus::alive_count_change ( ) const

inline

The change in the alive_count since the last time the listener was called or the status was read.

int32_t dds::core::status::LivelinessChangedStatus::not_alive_count_change ( ) const

inline

The change in the not_alive_count since the last time the listener was called or the status was read.

const dds::core::InstanceHandle dds::core::status::LivelinessChangedStatus::last_publication_handle ( ) const

inline

An instance handle to the last remote writer to change its liveliness.