DDS::DomainParticipantListener Class Reference
[DomainParticipants]

<<interface>> Listener for participant status. More...

#include <managed_domain.h>

Inheritance diagram for DDS::DomainParticipantListener:

List of all members.

Public Member Functions
virtual void	on_inconsistent_topic (Topic^ topic, InconsistentTopicStatus% status)
	Handle the DDS::StatusKind::INCONSISTENT_TOPIC_STATUS status.
virtual void	on_offered_deadline_missed (DataWriter^ writer, OfferedDeadlineMissedStatus% status)
	Handles the DDS::StatusKind::OFFERED_DEADLINE_MISSED_STATUS status.
virtual void	on_liveliness_lost (DataWriter^ writer, LivelinessLostStatus% status)
	Handles the DDS::StatusKind::LIVELINESS_LOST_STATUS status.
virtual void	on_offered_incompatible_qos (DataWriter^ writer, OfferedIncompatibleQosStatus^ status)
	Handles the DDS::StatusKind::OFFERED_INCOMPATIBLE_QOS_STATUS status.
virtual void	on_publication_matched (DataWriter^ writer, PublicationMatchedStatus% status)
	Handles the DDS::StatusKind::PUBLICATION_MATCHED_STATUS status.
virtual void	on_reliable_writer_cache_changed (DataWriter^ writer, ReliableWriterCacheChangedStatus% status)
	<<eXtension>> A change has occurred in the writer's cache of unacknowledged samples.
virtual void	on_reliable_reader_activity_changed (DataWriter^ writer, ReliableReaderActivityChangedStatus% status)
	<<eXtension>> A matched reliable reader has become active or become inactive.
virtual void	on_requested_deadline_missed (DataReader^ reader, RequestedDeadlineMissedStatus% status)
	Handles the DDS::StatusKind::REQUESTED_DEADLINE_MISSED_STATUS communication status.
virtual void	on_liveliness_changed (DataReader^ reader, LivelinessChangedStatus% status)
	Handles the DDS::StatusKind::LIVELINESS_CHANGED_STATUS communication status.
virtual void	on_requested_incompatible_qos (DataReader^ reader, RequestedIncompatibleQosStatus^ status)
	Handles the DDS::StatusKind::REQUESTED_INCOMPATIBLE_QOS_STATUS communication status.
virtual void	on_sample_rejected (DataReader^ reader, SampleRejectedStatus% status)
	Handles the DDS::StatusKind::SAMPLE_REJECTED_STATUS communication status.
virtual void	on_data_available (DataReader^ reader)
	Handle the DDS::StatusKind::DATA_AVAILABLE_STATUS communication status.
virtual void	on_sample_lost (DataReader^ reader, SampleLostStatus% status)
	Handles the DDS::StatusKind::SAMPLE_LOST_STATUS communication status.
virtual void	on_subscription_matched (DataReader^ reader, SubscriptionMatchedStatus% status)
	Handles the DDS::StatusKind::SUBSCRIPTION_MATCHED_STATUS communication status.
virtual void	on_data_on_readers (Subscriber^ sub)
	Handles the DDS::StatusKind::DATA_ON_READERS_STATUS communication status.

---

Detailed Description

<<interface>> Listener for participant status.

Entity:

DDS::DomainParticipant

Status:

Status Kinds

This is the interface that can be implemented by an application-provided class and then registered with the DDS::DomainParticipant such that the application can be notified by RTI Data Distribution Service of relevant status changes.

The DDS::DomainParticipantListener interface extends all other Listener interfaces and has no additional operation beyond the ones defined by the more general listeners.

The purpose of the DDS::DomainParticipantListener is to be the listener of last resort that is notified of all status changes not captured by more specific listeners attached to the DDS::DomainEntity objects. When a relevant status change occurs, RTI Data Distribution Service will first attempt to notify the listener attached to the concerned DDS::DomainEntity if one is installed. Otherwise, RTI Data Distribution Service will notify the Listener attached to the DDS::DomainParticipant.

Important: Because a DDS::DomainParticipantListener may receive callbacks pertaining to many different entities, it is possible for the same listener to receive multiple callbacks simultaneously in different threads. (Such is not the case for listeners of other types.) It is therefore critical that users of this listener provide their own protection for any thread-unsafe activities undertaken in a DDS::DomainParticipantListener callback.

Note: Due to a thread-safety issue, the destruction of a DomainParticipantListener from an enabled DomainParticipant should be avoided -- even if the DomainParticipantListener has been removed from the DomainParticipant. (This limitation does not affect the Java API.)

See also:

DDS::Listener

DDS::DomainParticipant::set_listener

---

Member Function Documentation

virtual void DDS::DomainParticipantListener::on_inconsistent_topic	(	Topic^	topic,
		InconsistentTopicStatus%	status
	)			[inline, virtual]

Handle the DDS::StatusKind::INCONSISTENT_TOPIC_STATUS status.

This callback is called when a remote DDS::Topic is discovered but is inconsistent with the locally created DDS::Topic of the same topic name.

Parameters:

	topic	<<out>> Locally created DDS::Topic that triggers the listener callback
	status	<<out>> Current inconsistent status of locally created DDS::Topic

Implements DDS::TopicListener.

virtual void DDS::DomainParticipantListener::on_offered_deadline_missed	(	DataWriter^	writer,
		OfferedDeadlineMissedStatus%	status
	)			[inline, virtual]

Handles the DDS::StatusKind::OFFERED_DEADLINE_MISSED_STATUS status.

This callback is called when the deadline that the DDS::DataWriter has committed through its DEADLINE qos policy was not respected for a specific instance. This callback is called for each deadline period elapsed during which the DDS::DataWriter failed to provide data for an instance.

Parameters:

	writer	<<out>> Locally created DDS::DataWriter that triggers the listener callback
	status	<<out>> Current deadline missed status of locally created DDS::DataWriter

Reimplemented from DDS::PublisherListener.

virtual void DDS::DomainParticipantListener::on_liveliness_lost	(	DataWriter^	writer,
		LivelinessLostStatus%	status
	)			[inline, virtual]

Handles the DDS::StatusKind::LIVELINESS_LOST_STATUS status.

This callback is called when the liveliness that the DDS::DataWriter has committed through its LIVELINESS qos policy was not respected; this DDS::DataReader entities will consider the DDS::DataWriter as no longer "alive/active". This callback will not be called when an already not alive DDS::DataWriter simply renames not alive for another liveliness period.

Parameters:

	writer	<<out>> Locally created DDS::DataWriter that triggers the listener callback
	status	<<out>> Current liveliness lost status of locally created DDS::DataWriter

Reimplemented from DDS::PublisherListener.

virtual void DDS::DomainParticipantListener::on_offered_incompatible_qos	(	DataWriter^	writer,
		OfferedIncompatibleQosStatus^	status
	)			[inline, virtual]

Handles the DDS::StatusKind::OFFERED_INCOMPATIBLE_QOS_STATUS status.

This callback is called when the DDS::DataWriterQos of the DDS::DataWriter was incompatible with what was requested by a DDS::DataReader. This callback is called when a DDS::DataWriter has discovered a DDS::DataReader for the same DDS::Topic and common partition, but with a requested QoS that is incompatible with that offered by the DDS::DataWriter.

Parameters:

	writer	<<out>> Locally created DDS::DataWriter that triggers the listener callback
	status	<<out>> Current incompatible qos status of locally created DDS::DataWriter

Reimplemented from DDS::PublisherListener.

virtual void DDS::DomainParticipantListener::on_publication_matched	(	DataWriter^	writer,
		PublicationMatchedStatus%	status
	)			[inline, virtual]

Handles the DDS::StatusKind::PUBLICATION_MATCHED_STATUS status.

This callback is called when the DDS::DataWriter has found a DDS::DataReader that matches the DDS::Topic, has a common partition and compatible QoS, or has ceased to be matched with a DDS::DataReader that was previously considered to be matched.

Parameters:

	writer	<<out>> Locally created DDS::DataWriter that triggers the listener callback
	status	<<out>> Current publication match status of locally created DDS::DataWriter

Reimplemented from DDS::PublisherListener.

virtual void DDS::DomainParticipantListener::on_reliable_writer_cache_changed	(	DataWriter^	writer,
		ReliableWriterCacheChangedStatus%	status
	)			[inline, virtual]

<<eXtension>> A change has occurred in the writer's cache of unacknowledged samples.

Parameters:

	writer	<<out>> Locally created DDS::DataWriter that triggers the listener callback
	status	<<out>> Current reliable writer cache changed status of locally created DDS::DataWriter

Reimplemented from DDS::PublisherListener.

virtual void DDS::DomainParticipantListener::on_reliable_reader_activity_changed	(	DataWriter^	writer,
		ReliableReaderActivityChangedStatus%	status
	)			[inline, virtual]

<<eXtension>> A matched reliable reader has become active or become inactive.

Parameters:

	writer	<<out>> Locally created DDS::DataWriter that triggers the listener callback
	status	<<out>> Current reliable reader activity changed status of locally created DDS::DataWriter

Reimplemented from DDS::PublisherListener.

virtual void DDS::DomainParticipantListener::on_requested_deadline_missed	(	DataReader^	reader,
		RequestedDeadlineMissedStatus%	status
	)			[inline, virtual]

Handles the DDS::StatusKind::REQUESTED_DEADLINE_MISSED_STATUS communication status.

Reimplemented from DDS::SubscriberListener.

virtual void DDS::DomainParticipantListener::on_liveliness_changed	(	DataReader^	reader,
		LivelinessChangedStatus%	status
	)			[inline, virtual]

Handles the DDS::StatusKind::LIVELINESS_CHANGED_STATUS communication status.

Reimplemented from DDS::SubscriberListener.

virtual void DDS::DomainParticipantListener::on_requested_incompatible_qos	(	DataReader^	reader,
		RequestedIncompatibleQosStatus^	status
	)			[inline, virtual]

Handles the DDS::StatusKind::REQUESTED_INCOMPATIBLE_QOS_STATUS communication status.

Reimplemented from DDS::SubscriberListener.

virtual void DDS::DomainParticipantListener::on_sample_rejected	(	DataReader^	reader,
		SampleRejectedStatus%	status
	)			[inline, virtual]

Handles the DDS::StatusKind::SAMPLE_REJECTED_STATUS communication status.

Reimplemented from DDS::SubscriberListener.

virtual void DDS::DomainParticipantListener::on_data_available

(

DataReader^

reader

)

[inline, virtual]

Handle the DDS::StatusKind::DATA_AVAILABLE_STATUS communication status.

Reimplemented from DDS::SubscriberListener.

virtual void DDS::DomainParticipantListener::on_sample_lost	(	DataReader^	reader,
		SampleLostStatus%	status
	)			[inline, virtual]

Handles the DDS::StatusKind::SAMPLE_LOST_STATUS communication status.

Reimplemented from DDS::SubscriberListener.

virtual void DDS::DomainParticipantListener::on_subscription_matched	(	DataReader^	reader,
		SubscriptionMatchedStatus%	status
	)			[inline, virtual]

Handles the DDS::StatusKind::SUBSCRIPTION_MATCHED_STATUS communication status.

Reimplemented from DDS::SubscriberListener.

virtual void DDS::DomainParticipantListener::on_data_on_readers

(

Subscriber^

sub

)

[inline, virtual]

Handles the DDS::StatusKind::DATA_ON_READERS_STATUS communication status.

Reimplemented from DDS::SubscriberListener.