Fast DDS  Version 3.6.1.0
Fast DDS
Loading...
Searching...
No Matches
RTPSParticipantListener Class Reference

Class RTPSParticipantListener with virtual method that the user can overload to respond to certain events. More...

#include <RTPSParticipantListener.hpp>

Public Member Functions

 RTPSParticipantListener ()
virtual ~RTPSParticipantListener ()
virtual void on_participant_discovery (RTPSParticipant *participant, ParticipantDiscoveryStatus reason, const ParticipantBuiltinTopicData &info, bool &should_be_ignored)
 This method is called when a new Participant is discovered, or a previously discovered participant changes its QOS or is removed.
virtual void on_reader_discovery (RTPSParticipant *participant, ReaderDiscoveryStatus reason, const SubscriptionBuiltinTopicData &info, bool &should_be_ignored)
 This method is called when a new Reader is discovered, or a previously discovered reader changes its QOS or is removed.
virtual void on_writer_discovery (RTPSParticipant *participant, WriterDiscoveryStatus reason, const PublicationBuiltinTopicData &info, bool &should_be_ignored)
 This method is called when a new Writer is discovered, or a previously discovered writer changes its QOS or is removed.
virtual bool should_endpoints_match (const RTPSParticipant *participant, const SubscriptionBuiltinTopicData &reader_info, const PublicationBuiltinTopicData &writer_info)
 This method is called to check whether a discovered DataReader and DataWriter should be matched or not.

Detailed Description

Class RTPSParticipantListener with virtual method that the user can overload to respond to certain events.

Constructor & Destructor Documentation

◆ RTPSParticipantListener()

RTPSParticipantListener ( )
inline

◆ ~RTPSParticipantListener()

virtual ~RTPSParticipantListener ( )
inlinevirtual

Member Function Documentation

◆ on_participant_discovery()

virtual void on_participant_discovery ( RTPSParticipant * participant,
ParticipantDiscoveryStatus reason,
const ParticipantBuiltinTopicData & info,
bool & should_be_ignored )
inlinevirtual

This method is called when a new Participant is discovered, or a previously discovered participant changes its QOS or is removed.

Parameters
[out]participantPointer to the Participant which discovered the remote participant.
[out]reasonReason of the change in the status of the discovered participant.
[out]infoRemote participant information. User can take ownership of the object.
[out]should_be_ignoredFlag to indicate the library to automatically ignore the discovered Participant.

◆ on_reader_discovery()

virtual void on_reader_discovery ( RTPSParticipant * participant,
ReaderDiscoveryStatus reason,
const SubscriptionBuiltinTopicData & info,
bool & should_be_ignored )
inlinevirtual

This method is called when a new Reader is discovered, or a previously discovered reader changes its QOS or is removed.

Parameters
[in]participantPointer to the Participant which discovered the remote reader.
[in]reasonThe reason motivating this method to be called.
[in]infoRemote reader information.
[out]should_be_ignoredFlag to indicate the library to automatically ignore the discovered reader.

◆ on_writer_discovery()

virtual void on_writer_discovery ( RTPSParticipant * participant,
WriterDiscoveryStatus reason,
const PublicationBuiltinTopicData & info,
bool & should_be_ignored )
inlinevirtual

This method is called when a new Writer is discovered, or a previously discovered writer changes its QOS or is removed.

Parameters
[in]participantPointer to the Participant which discovered the remote writer.
[in]reasonThe reason motivating this method to be called.
[in]infoRemote writer information.
[out]should_be_ignoredFlag to indicate the library to automatically ignore the discovered writer.

◆ should_endpoints_match()

virtual bool should_endpoints_match ( const RTPSParticipant * participant,
const SubscriptionBuiltinTopicData & reader_info,
const PublicationBuiltinTopicData & writer_info )
inlinevirtual

This method is called to check whether a discovered DataReader and DataWriter should be matched or not.

It is called after successful validation of the standard DDS matching rules. By default, they will match, but the user can override this method to implement custom matching logic.

Parameters
[in]participantPointer to the Participant which discovered the remote endpoints.
[in]reader_infoRemote reader information.
[in]writer_infoRemote writer information.
Returns
true if the endpoints should be matched, false otherwise.

The documentation for this class was generated from the following file: