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

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

#include <TStatus.hpp>

Public Member Functions

int32_t total_count () const
 The total cumulative number of times the concerned dds::sub::DataReader discovered a "match" with a dds::pub::DataWriter.
 
int32_t total_count_change () const
 The change 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 writers with which the dds::sub::DataReader 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_publication_handle () const
 A handle to the last dds::pub::DataWriter that caused the 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::subscription_matched()

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

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

Member Function Documentation

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

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

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

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

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

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

The current number of writers with which the dds::sub::DataReader is matched.

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

int32_t dds::core::status::SubscriptionMatchedStatus::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::SubscriptionMatchedStatus::last_publication_handle ( ) const
inline

A handle to the last dds::pub::DataWriter that caused the 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.2.0 Copyright © Sun Jun 21 2015 Real-Time Innovations, Inc