DDS::DataWriterListener Class Reference
[Data Writers]

<<interface>> DDS::Listener for writer status. More...

#include <managed_publication.h>

Inheritance diagram for DDS::DataWriterListener:

List of all members.

Public Member Functions
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_instance_replaced (DataWriter^ writer, InstanceHandle_t% handle)
	Notifies when an instance is replaced in DataWriter queue.

---

Detailed Description

<<interface>> DDS::Listener for writer status.

Entity:

DDS::DataWriter

Status:

DDS::StatusKind::LIVELINESS_LOST_STATUS, DDS::LivelinessLostStatus;
DDS::StatusKind::OFFERED_DEADLINE_MISSED_STATUS, DDS::OfferedDeadlineMissedStatus;
DDS::StatusKind::OFFERED_INCOMPATIBLE_QOS_STATUS, DDS::OfferedIncompatibleQosStatus;
DDS::StatusKind::PUBLICATION_MATCHED_STATUS, DDS::PublicationMatchedStatus;
DDS::StatusKind::RELIABLE_READER_ACTIVITY_CHANGED_STATUS, DDS::ReliableReaderActivityChangedStatus;
DDS::StatusKind::RELIABLE_WRITER_CACHE_CHANGED_STATUS, DDS::ReliableWriterCacheChangedStatus;

See also:

Status Kinds

Operations Allowed in Listener Callbacks

---

Member Function Documentation

virtual void DDS::DataWriterListener::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 in DDS::DomainParticipantListener, and DDS::PublisherListener.

virtual void DDS::DataWriterListener::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 in DDS::DomainParticipantListener, and DDS::PublisherListener.

virtual void DDS::DataWriterListener::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 in DDS::DomainParticipantListener, and DDS::PublisherListener.

virtual void DDS::DataWriterListener::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 in DDS::DomainParticipantListener, and DDS::PublisherListener.

virtual void DDS::DataWriterListener::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 in DDS::DomainParticipantListener, and DDS::PublisherListener.

virtual void DDS::DataWriterListener::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 in DDS::DomainParticipantListener, and DDS::PublisherListener.

virtual void DDS::DataWriterListener::on_instance_replaced	(	DataWriter^	writer,
		InstanceHandle_t%	handle
	)			[inline, virtual]

Notifies when an instance is replaced in DataWriter queue.

This callback is called when an instance is replaced by the DDS::DataWriter due to instance resource limits being reached. This callback returns to the user the handle of the replaced instance, which can be used to get the key of the replaced instance.

Parameters:

	writer	<<out>> Locally created DDS::DataWriter that triggers the listener callback
	handle	<<out>> Handle of the replaced instance

Reimplemented in DDS::PublisherListener.