RTI Connext Modern C++ API  Version 5.3.0
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
dds::core::status::PublicationMatchedStatus Class Reference

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

#include <TStatus.hpp>

Public Member Functions

int32_t total_count () const
 The total cumulative number of times the concerned dds::pub::DataWriter discovered a "match" with a dds::sub::DataReader.
 
int32_t total_count_change () const
 The incremental changes in total_count since the last time the listener was called or the status was read.
 
int32_t current_count () const
 The current number of readers with which the dds::pub::DataWriter is matched.
 
int32_t current_count_change () const
 The change in current_count since the last time the listener was called or the status was read.
 
const dds::core::InstanceHandle last_subscription_handle () const
 A handle to the last dds::sub::DataReader that caused the the dds::pub::DataWriter's status to change.
 
int32_t current_count_peak () const
 <<extension>> The highest value that current_count has reached until now.
 

Detailed Description

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

A "match" happens when the dds::pub::DataWriter finds a dds::sub::DataReader for the same dds::topic::Topic and common partition with a requested QoS that is compatible with that offered by the dds::pub::DataWriter.

This status is also changed (and the listener, if any, called) when a match is ended. A local dds::pub::DataWriter will become "unmatched" from a remote dds::sub::DataReader when that dds::sub::DataReader goes away for any reason.

Member Function Documentation

int32_t dds::core::status::PublicationMatchedStatus::total_count ( ) const
inline

The total cumulative number of times the concerned dds::pub::DataWriter discovered a "match" with a dds::sub::DataReader.

This number increases whenever a new match is discovered. It does not change when an existing match goes away.

int32_t dds::core::status::PublicationMatchedStatus::total_count_change ( ) const
inline

The incremental changes in total_count since the last time the listener was called or the status was read.

int32_t dds::core::status::PublicationMatchedStatus::current_count ( ) const
inline

The current number of readers with which the dds::pub::DataWriter is matched.

This number increases when a new match is discovered and decreases when an existing match goes away.

int32_t dds::core::status::PublicationMatchedStatus::current_count_change ( ) const
inline

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

const dds::core::InstanceHandle dds::core::status::PublicationMatchedStatus::last_subscription_handle ( ) const
inline

A handle to the last dds::sub::DataReader that caused the the dds::pub::DataWriter's status to change.

int32_t current_count_peak ( ) const

<<extension>> The highest value that current_count has reached until now.


RTI Connext Modern C++ API Version 5.3.0 Copyright © Sun Jun 25 2017 Real-Time Innovations, Inc