Class astutedds::dcps::ReadCondition

Class astutedds::dcps::ReadCondition

ClassList > astutedds > dcps > ReadCondition

DDS 1.4 §2.2.2.5.8 — a Condition attached to a DataReader that triggers whenever a sample matching the (sample_state, view_state, instance_state) mask triplet is available.More...

  • #include <dcps.hpp>

Public Functions

Type Name
ReadCondition (DataReader * reader, SampleStateMask sample_states, ViewStateMask view_states, InstanceStateMask instance_states)
ReadCondition (const ReadCondition &) = delete
DataReader * get_datareader () noexcept const
InstanceStateMask get_instance_state_mask () noexcept const
SampleStateMask get_sample_state_mask () noexcept const
§2.2.2.5.8.1 — accessor for the state masks and parent reader.
ViewStateMask get_view_state_mask () noexcept const
ReadCondition & operator= (const ReadCondition &) = delete
bool trigger_value () const
virtual ~ReadCondition () = default

Detailed Description

Created by DataReader::create_readcondition() and owned by the reader (destroyed either explicitly via delete_readcondition() or automatically when the reader is destroyed / delete_contained_entities is called). Applications hold the raw pointer only for the lifetime of the parent reader.

Public Functions Documentation

function ReadCondition [1/2]

inline astutedds::dcps::ReadCondition::ReadCondition (
    DataReader * reader,
    SampleStateMask sample_states,
    ViewStateMask view_states,
    InstanceStateMask instance_states
)

function ReadCondition [2/2]

astutedds::dcps::ReadCondition::ReadCondition (
    const ReadCondition &
) = delete

function get_datareader

inline DataReader * astutedds::dcps::ReadCondition::get_datareader () noexcept const

function get_instance_state_mask

inline InstanceStateMask astutedds::dcps::ReadCondition::get_instance_state_mask () noexcept const

function get_sample_state_mask

§2.2.2.5.8.1 — accessor for the state masks and parent reader. 

inline SampleStateMask astutedds::dcps::ReadCondition::get_sample_state_mask () noexcept const

function get_view_state_mask

inline ViewStateMask astutedds::dcps::ReadCondition::get_view_state_mask () noexcept const

function operator=

ReadCondition & astutedds::dcps::ReadCondition::operator= (
    const ReadCondition &
) = delete

function trigger_value

bool astutedds::dcps::ReadCondition::trigger_value () const

§2.2.2.5.8 — trigger_value. True iff the parent reader currently holds at least one sample matching the mask triplet. Evaluated by walking the reader's cache under the reader's mutex (see impl).

function ~ReadCondition

virtual astutedds::dcps::ReadCondition::~ReadCondition () = default

The documentation for this class was generated from the following file include/astutedds/dcps/dcps.hpp