RTI Connext Modern C++ API
Version 5.2.0
|
A std::bitset (list) of statuses. More...
#include <State.hpp>
Inherits bitset< OMG_DDS_STATUS_COUNT >.
Public Types | |
typedef std::bitset < OMG_DDS_STATUS_COUNT > | MaskType |
The base class, a std::bitset. | |
Public Member Functions | |
StatusMask () | |
Creates StatusMask::none() | |
StatusMask (uint64_t mask) | |
Creates a StatusMask from the bits in a uint64_t value. | |
StatusMask (const MaskType &mask) | |
Creates a StatusMask from a bitset. | |
Static Public Member Functions | |
static const StatusMask | all () |
All the bits are set. | |
static const StatusMask | none () |
No bits are set. | |
static const StatusMask | inconsistent_topic () |
Another topic exists with the same name but different characteristics. | |
static const StatusMask | offered_deadline_missed () |
The deadline that the dds::pub::DataWriter has committed through its dds::core::policy::Deadline was not respected for a specific instance. | |
static const StatusMask | requested_deadline_missed () |
The deadline that the dds::sub::DataReader was expecting through its dds::core::policy::Deadline was not respected for a specific instance. | |
static const StatusMask | offered_incompatible_qos () |
A QosPolicy value was incompatible with what was requested. | |
static const StatusMask | requested_incompatible_qos () |
A QosPolicy value was incompatible with what is offered. | |
static const StatusMask | sample_lost () |
A sample has been lost (i.e. was never received). | |
static const StatusMask | sample_rejected () |
A (received) sample has been rejected. | |
static const StatusMask | data_on_readers () |
New data is available. | |
static const StatusMask | data_available () |
One or more new data samples have been received. | |
static const StatusMask | liveliness_lost () |
The liveliness that the dds::pub::DataWriter has committed to through its dds::core::policy::Liveliness policy was not respected, thus dds::sub::DataReader entities will consider the writer as no longer alive. | |
static const StatusMask | liveliness_changed () |
The liveliness of one or more dds::pub::DataWriter that were writing instances read through the dds::sub::DataReader has changed. Some dds::pub::DataWriter have become alive or not_alive. | |
static const StatusMask | publication_matched () |
The dds::pub::DataWriter has found dds::sub::DataReader that matches the dds::topic::Topic and has compatible QoS. | |
static const StatusMask | subscription_matched () |
The dds::sub::DataReader has found dds::pub::DataWriter that matches the dds::topic::Topic and has compatible QoS. | |
static const StatusMask | reliable_writer_cache_changed () |
<<extension>> The number of unacknowledged samples in a reliable writer's cache has changed such that it has reached a pre-defined trigger point. | |
static const StatusMask | reliable_reader_activity_changed () |
<<extension>> One or more reliable readers has become active or inactive. | |
static const StatusMask | datawriter_cache () |
<<extension>> The status of the writer's cache. | |
static const StatusMask | datawriter_protocol () |
<<extension>> The status of a writer's internal protocol related metrics | |
static const StatusMask | datareader_cache () |
<<extension>> The status of the reader's cache. | |
static const StatusMask | datareader_protocol () |
<<extension>> The status of a reader's internal protocol related metrics | |
static const StatusMask | datawriter_application_acknowledgment () |
<<extension>> A dds::pub::DataWriter has received an application-level acknowledgment for a sample | |
Related Functions | |
(Note that these are not member functions.) | |
template<typename STATUS > | |
StatusMask | get_status () |
Obtains the StatusMask mask associated to a status class. | |
A std::bitset (list) of statuses.
The bit-mask is an efficient and compact representation of a fixed-length list of dds::core::status::StatusMask values.
Bits in the mask correspond to different statuses. You can choose which changes in status will trigger a callback by setting the corresponding status bits in this bit-mask and installing callbacks for each of those statuses.
The bits that are true indicate that the listener will be called back for changes in the corresponding status.
typedef std::bitset<OMG_DDS_STATUS_COUNT > dds::core::status::StatusMask::MaskType |
The base class, a std::bitset.
|
inline |
Creates StatusMask::none()
|
inlineexplicit |
Creates a StatusMask from the bits in a uint64_t value.
|
inline |
Creates a StatusMask from a bitset.
|
inlinestatic |
All the bits are set.
|
inlinestatic |
No bits are set.
|
inlinestatic |
Another topic exists with the same name but different characteristics.
|
inlinestatic |
The deadline that the dds::pub::DataWriter has committed through its dds::core::policy::Deadline was not respected for a specific instance.
|
inlinestatic |
The deadline that the dds::sub::DataReader was expecting through its dds::core::policy::Deadline was not respected for a specific instance.
|
inlinestatic |
A QosPolicy value was incompatible with what was requested.
|
inlinestatic |
A QosPolicy value was incompatible with what is offered.
|
inlinestatic |
A sample has been lost (i.e. was never received).
|
inlinestatic |
A (received) sample has been rejected.
|
inlinestatic |
|
inlinestatic |
One or more new data samples have been received.
|
inlinestatic |
The liveliness that the dds::pub::DataWriter has committed to through its dds::core::policy::Liveliness policy was not respected, thus dds::sub::DataReader entities will consider the writer as no longer alive.
|
inlinestatic |
The liveliness of one or more dds::pub::DataWriter that were writing instances read through the dds::sub::DataReader has changed. Some dds::pub::DataWriter have become alive or not_alive.
|
inlinestatic |
The dds::pub::DataWriter has found dds::sub::DataReader that matches the dds::topic::Topic and has compatible QoS.
|
inlinestatic |
The dds::sub::DataReader has found dds::pub::DataWriter that matches the dds::topic::Topic and has compatible QoS.
|
inlinestatic |
<<extension>> The number of unacknowledged samples in a reliable writer's cache has changed such that it has reached a pre-defined trigger point.
This status is considered changed at the following times: the cache is empty (i.e. contains no unacknowledge samples), full (i.e. the sample count has reached the value specified in dds::core::policy::ResourceLimits::max_samples), or the number of samples has reached a high (see rti::core::RtpsReliableWriterProtocol::high_watermark) or low (see rti::core::RtpsReliableWriterProtocol::low_watermark) watermark.
|
inlinestatic |
<<extension>> One or more reliable readers has become active or inactive.
A reliable reader is considered active by a reliable writer with which it is matched if that reader acknowledges the samples it has been sent in a timely fashion. For the definition of "timely" in this case, see rti::core::RtpsReliableWriterProtocol and rti::core::status::ReliableReaderActivityChangedStatus.
|
inlinestatic |
<<extension>> The status of the writer's cache.
|
inlinestatic |
<<extension>> The status of a writer's internal protocol related metrics
The status of a writer's internal protocol related metrics, like the number of samples pushed, pulled, filtered; and status of wire protocol traffic.
|
inlinestatic |
<<extension>> The status of the reader's cache.
|
inlinestatic |
<<extension>> The status of a reader's internal protocol related metrics
The status of a reader's internal protocol related metrics, like the number of samples received, filtered, rejected; and status of wire protocol traffic.
|
inlinestatic |
<<extension>> A dds::pub::DataWriter has received an application-level acknowledgment for a sample
Enables a dds::pub::DataWriter callback that is called when an application-level acknowledgment from a dds::sub::DataReader is received. The callback is called for each sample that is application-level acknowledged.
|
related |
Obtains the StatusMask mask associated to a status class.
For example: