OpenSplice ISO C++ 2 DCPS  v6.x
ISO C++ 2 OpenSplice Data Distribution Service Data-Centric Publish-Subscribe API
dds::core::status::LivelinessChangedStatus Class Reference

More...

#include "Status.hpp"

Inheritance diagram for dds::core::status::LivelinessChangedStatus:
Inheritance graph

Public Member Functions

 LivelinessChangedStatus ()
 
int32_t alive_count () const
 
int32_t alive_count_change () const
 
const dds::core::InstanceHandle last_publication_handle () const
 
int32_t not_alive_count () const
 
int32_t not_alive_count_change () const
 
bool operator!= (const Value &other) const
 
D * operator-> ()
 
const D * operator-> () const
 
bool operator== (const Value &other) const
 

Detailed Description

Attribute Attribute Meaning
alive_count The total number of currently active DataWriters that write the Topic read by the DataReader. This count increases when a newly matched DataWriter asserts its liveliness for the first time or when a DataWriter previously considered to be not alive reasserts its liveliness. The count decreases when a DataWriter considered alive fails to assert its liveliness and becomes not alive, whether because it was deleted normally or for some other reason.
not_alive_count The total count of currently DataWriters that write the Topic read by the DataReader that are no longer asserting their liveliness. This count increases when a DataWriter considered alive fails to assert its liveliness and becomes not alive for some reason other than the normal deletion of that DataWriter. It decreases when a previously not alive DataWriter either reasserts its liveliness or is deleted normally.
alive_count_change The change in the alive_count since the last time the listener was called or the status was read.
not_alive_count_change The change in the not_alive_count since the last time the listener was called or the status was read.
last_publication_handle Handle to the last DataWriter whose change in liveliness caused this status to change.

The liveliness of one or more DataWriter that were writing instances have become "active" or "inactive"

Definition at line 145 of file Status.hpp.

Constructor & Destructor Documentation

◆ LivelinessChangedStatus()

dds::core::status::LivelinessChangedStatus::LivelinessChangedStatus ( )

Definition at line 122 of file StatusImpl.hpp.

Member Function Documentation

◆ alive_count()

int32_t dds::core::status::LivelinessChangedStatus::alive_count ( ) const
Returns
The total number of currently active DataWriters that write the Topic read by the DataReader. This count increases when a newly-matched DataWriter asserts its liveliness for the first time or when a DataWriter previously considered to be not alive reasserts its liveliness. The count decreases when a DataWriter considered alive fails to assert its liveliness and becomes not alive, whether because it was deleted normally or for some other reason.

Definition at line 125 of file StatusImpl.hpp.

◆ alive_count_change()

int32_t dds::core::status::LivelinessChangedStatus::alive_count_change ( ) const
Returns
The change in the alive_count since the last time the listener was called or the status was read.

Definition at line 137 of file StatusImpl.hpp.

◆ last_publication_handle()

const dds::core::InstanceHandle dds::core::status::LivelinessChangedStatus::last_publication_handle ( ) const
Returns
Handle to the last DataWriter whose change in liveliness caused this status to change.

Definition at line 149 of file StatusImpl.hpp.

◆ not_alive_count()

int32_t dds::core::status::LivelinessChangedStatus::not_alive_count ( ) const
Returns
The total count of currently DataWriters that write the Topic read by the DataReader that are no longer asserting their liveliness. This count increases when a DataWriter considered alive fails to assert its liveliness and becomes not alive for some reason other than the normal deletion of that DataWriter. It decreases when a previously not alive DataWriter either reasserts its liveliness or is deleted normally.

Definition at line 131 of file StatusImpl.hpp.

◆ not_alive_count_change()

int32_t dds::core::status::LivelinessChangedStatus::not_alive_count_change ( ) const
Returns
The change in the not_alive_count since the last time the listener was called or the status was read.

Definition at line 143 of file StatusImpl.hpp.

◆ operator!=()

template<typename D >
bool dds::core::Value< D >::operator!= ( const Value< D > &  other) const
inherited

Compare this Value with another Value

Parameters
otherValue
Returns
true if not equal

Definition at line 99 of file Value.hpp.

◆ operator->() [1/2]

template<typename D >
D * dds::core::Value< D >::operator-> ( )
inherited

The operator->() is provided to be able to directly invoke functions on the delegate.

The decision to provide direct access to the delegate was motivated by the need for providing a way that was not invasive with respect to the CXXDDS API and yet would allow for vendor-specific extension. Thus vendor-specific extensions can be invoked on the Value and on all its subclasses as follows:

my_dds_value.standard_function();
my_dds_value->vendor_specific_extension();
Returns
a reference to delegate.

Definition at line 111 of file Value.hpp.

◆ operator->() [2/2]

template<typename D >
const D * dds::core::Value< D >::operator-> ( ) const
inherited

The operator->() is provided to be able to directly invoke functions on the delegate.

The decision to provide direct access to the delegate was motivated by the need for providing a way that was not invasive with respect to the CXXDDS API and yet would allow for vendor-specific extension. Thus vendor-specific extensions can be invoked on the Value and on all its subclasses as follows:

my_dds_value.standard_function();
my_dds_value->vendor_specific_extension();
Returns
a reference to delegate.

Definition at line 105 of file Value.hpp.

◆ operator==()

template<typename D >
bool dds::core::Value< D >::operator== ( const Value< D > &  other) const
inherited

Compare this Value with another Value

Parameters
otherValue
Returns
true if equal

Definition at line 93 of file Value.hpp.


The documentation for this class was generated from the following files: