Class DomainParticipantListener, overrides behaviour towards certain events. More...

#include <DomainParticipantListener.hpp>

Inheritance diagram for DomainParticipantListener:

Public Member Functions
	DomainParticipantListener ()
	Constructor. More...

virtual	~DomainParticipantListener ()
	Destructor. More...

virtual void	on_participant_discovery (DomainParticipant *participant, fastdds::rtps::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. More...

virtual void	on_data_reader_discovery (DomainParticipant *participant, rtps::ReaderDiscoveryStatus reason, const SubscriptionBuiltinTopicData &info, bool &should_be_ignored)
	This method is called when a new DataReader is discovered, or a previously discovered DataReader changes its QOS or is removed. More...

virtual void	on_data_writer_discovery (DomainParticipant *participant, rtps::WriterDiscoveryStatus reason, const PublicationBuiltinTopicData &info, bool &should_be_ignored)
	This method is called when a new DataWriter is discovered, or a previously discovered DataWriter changes its QOS or is removed. More...

virtual bool	should_endpoints_match (const DomainParticipant *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. More...

Public Member Functions inherited from PublisherListener
FASTDDS_EXPORTED_API	PublisherListener ()
	Constructor. More...

virtual FASTDDS_EXPORTED_API	~PublisherListener ()
	Destructor. More...

Public Member Functions inherited from DataWriterListener
	DataWriterListener ()
	Constructor. More...

virtual	~DataWriterListener ()
	Destructor. More...

virtual void	on_publication_matched (DataWriter *writer, const PublicationMatchedStatus &info)
	This method is called when the DataWriter is matched (or unmatched) against an endpoint. More...

virtual void	on_offered_deadline_missed (DataWriter *writer, const OfferedDeadlineMissedStatus &status)
	A method called when a deadline is missed. More...

virtual void	on_offered_incompatible_qos (DataWriter *writer, const OfferedIncompatibleQosStatus &status)
	A method called when an incompatible QoS is offered. More...

virtual void	on_liveliness_lost (DataWriter *writer, const LivelinessLostStatus &status)
	Method called when the liveliness of a DataWriter is lost. More...

virtual void	on_unacknowledged_sample_removed (DataWriter *writer, const InstanceHandle_t &instance)
	Method called when a sample has been removed unacknowledged. More...

Public Member Functions inherited from SubscriberListener
FASTDDS_EXPORTED_API	SubscriberListener ()
	Constructor. More...

virtual FASTDDS_EXPORTED_API	~SubscriberListener ()
	Destructor. More...

virtual FASTDDS_EXPORTED_API void	on_data_on_readers (Subscriber *sub)
	Virtual function to be implemented by the user containing the actions to be performed when a new Data Message is available on any reader. More...

Public Member Functions inherited from DataReaderListener
FASTDDS_EXPORTED_API	DataReaderListener ()
	Constructor. More...

virtual FASTDDS_EXPORTED_API	~DataReaderListener ()
	Destructor. More...

virtual FASTDDS_EXPORTED_API void	on_data_available (DataReader *reader)
	Virtual function to be implemented by the user containing the actions to be performed when new Data Messages are received. More...

virtual FASTDDS_EXPORTED_API void	on_subscription_matched (DataReader *reader, const fastdds::dds::SubscriptionMatchedStatus &info)
	Virtual method to be called when the subscriber is matched with a new Writer (or unmatched); i.e., when a writer publishing in the same topic is discovered. More...

virtual FASTDDS_EXPORTED_API void	on_requested_deadline_missed (DataReader *reader, const RequestedDeadlineMissedStatus &status)
	Virtual method to be called when a topic misses the deadline period. More...

virtual FASTDDS_EXPORTED_API void	on_liveliness_changed (DataReader *reader, const LivelinessChangedStatus &status)
	Method called when the liveliness status associated to a subscriber changes. More...

virtual FASTDDS_EXPORTED_API void	on_sample_rejected (DataReader *reader, const SampleRejectedStatus &status)
	Method called when a sample was rejected. More...

virtual FASTDDS_EXPORTED_API void	on_requested_incompatible_qos (DataReader *reader, const RequestedIncompatibleQosStatus &status)
	Method called an incompatible QoS was requested. More...

virtual FASTDDS_EXPORTED_API void	on_sample_lost (DataReader *reader, const SampleLostStatus &status)
	Method called when a sample was lost. More...

Public Member Functions inherited from TopicListener
	TopicListener ()
	Constructor. More...

virtual	~TopicListener ()
	Destructor. More...

virtual void	on_inconsistent_topic (Topic *topic, InconsistentTopicStatus status)
	Virtual function to be implemented by the user containing the actions to be performed when another topic exists with the same name but different characteristics. More...

Detailed Description

Class DomainParticipantListener, overrides behaviour towards certain events.

Constructor & Destructor Documentation

◆ DomainParticipantListener()

DomainParticipantListener ( )

inline

Constructor.

◆ ~DomainParticipantListener()

virtual ~DomainParticipantListener ( )

inlinevirtual

Destructor.

Member Function Documentation

◆ on_data_reader_discovery()

virtual void on_data_reader_discovery	(	DomainParticipant *	participant,
		rtps::ReaderDiscoveryStatus	reason,
		const SubscriptionBuiltinTopicData &	info,
		bool &	should_be_ignored
	)

inlinevirtual

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

Parameters

[in]	participant	Pointer to the Participant which discovered the remote reader.
[in]	reason	The reason motivating this method to be called.
[in]	info	Remote reader information.
[out]	should_be_ignored	Flag to indicate the library to automatically ignore the discovered reader.

◆ on_data_writer_discovery()

virtual void on_data_writer_discovery	(	DomainParticipant *	participant,
		rtps::WriterDiscoveryStatus	reason,
		const PublicationBuiltinTopicData &	info,
		bool &	should_be_ignored
	)

inlinevirtual

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

Parameters

[in]	participant	Pointer to the Participant which discovered the remote writer.
[in]	reason	The reason motivating this method to be called.
[in]	info	Remote writer information.
[out]	should_be_ignored	Flag to indicate the library to automatically ignore the discovered writer.

◆ on_participant_discovery()

virtual void on_participant_discovery	(	DomainParticipant *	participant,
		fastdds::rtps::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]	participant	Pointer to the Participant which discovered the remote participant.
[out]	reason	Reason of the change in the status of the discovered participant.
[out]	info	Remote participant information. User can take ownership of the object.
[out]	should_be_ignored	Flag to indicate the library to automatically ignore the discovered Participant.

◆ should_endpoints_match()

virtual bool should_endpoints_match	(	const DomainParticipant *	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]	participant	Pointer to the Participant which discovered the remote endpoints.
[in]	reader_info	Remote reader information.
[in]	writer_info	Remote writer information.

Returns: true if the endpoints should be matched, false otherwise.

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

include/fastdds/dds/domain/DomainParticipantListener.hpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ DomainParticipantListener()

◆ ~DomainParticipantListener()

Member Function Documentation

◆ on_data_reader_discovery()

◆ on_data_writer_discovery()

◆ on_participant_discovery()

◆ should_endpoints_match()