Class astutedds::dcps::ParticipantBuiltinReader

Class astutedds::dcps::ParticipantBuiltinReader

ClassList > astutedds > dcps > ParticipantBuiltinReader

DCPSParticipant built-in reader (§2.2.2.2.1 ParticipantBuiltinTopicData ).

  • #include <builtin_readers.hpp>

Inherits the following classes: astutedds::dcps::BuiltinReaderBase

Public Functions

Type Name
BuiltinReaderBase (DomainParticipant * participant) noexcept
ReturnCode_t read (std::vector< ParticipantBuiltinTopicData > & data, std::vector< SampleInfo > & infos) const
ReturnCode_t take (std::vector< ParticipantBuiltinTopicData > & data, std::vector< SampleInfo > & infos)

Public Functions inherited from astutedds::dcps::BuiltinReaderBase

See astutedds::dcps::BuiltinReaderBase

Type Name
BuiltinReaderBase (DomainParticipant * participant) noexcept
DomainParticipant * participant () noexcept const
void reset () noexcept

Protected Attributes inherited from astutedds::dcps::BuiltinReaderBase

See astutedds::dcps::BuiltinReaderBase

Type Name
DomainParticipant * participant_ = {nullptr}
std::set< BuiltinTopicKey_t, BuiltinTopicKeyLess > taken_

Public Functions Documentation

function BuiltinReaderBase

inline explicit astutedds::dcps::ParticipantBuiltinReader::BuiltinReaderBase (
    DomainParticipant * participant
) noexcept

function read

ReturnCode_t astutedds::dcps::ParticipantBuiltinReader::read (
    std::vector< ParticipantBuiltinTopicData > & data,
    std::vector< SampleInfo > & infos
) const

Read a snapshot of all currently discovered remote participants (never consumes). Populates one SampleInfo per record with valid_data=true, sample_state=NOT_READ_SAMPLE_STATE, view_state=NEW_VIEW_STATE, instance_state=ALIVE_INSTANCE_STATE. Returns RETCODE_OK on success (even if 0 samples), or RETCODE_NOT_ENABLED if the participant is not enable()d.

function take

ReturnCode_t astutedds::dcps::ParticipantBuiltinReader::take (
    std::vector< ParticipantBuiltinTopicData > & data,
    std::vector< SampleInfo > & infos
)

Take() variant — same as read() but marks each returned entry as consumed by BuiltinTopicKey_t so a subsequent take() call only returns newly-arrived participants.

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