DataWriterListener Interface Reference

<<interface>> com.rti.dds.infrastructure.Listener for writer status. More...

Inheritance diagram for DataWriterListener:

Public Member Functions
void	on_offered_deadline_missed (DataWriter writer, OfferedDeadlineMissedStatus status)
	Handles the com.rti.dds.infrastructure.StatusKind.StatusKind.OFFERED_DEADLINE_MISSED_STATUS status.
void	on_offered_incompatible_qos (DataWriter writer, OfferedIncompatibleQosStatus status)
	Handles the com.rti.dds.infrastructure.StatusKind.StatusKind.OFFERED_INCOMPATIBLE_QOS_STATUS status.
void	on_liveliness_lost (DataWriter writer, LivelinessLostStatus status)
	Handles the com.rti.dds.infrastructure.StatusKind.StatusKind.LIVELINESS_LOST_STATUS status.
void	on_publication_matched (DataWriter writer, PublicationMatchedStatus status)
	Handles the com.rti.dds.infrastructure.StatusKind.StatusKind.PUBLICATION_MATCHED_STATUS status.
void	on_reliable_writer_cache_changed (DataWriter writer, ReliableWriterCacheChangedStatus status)
	<<eXtension>> A change has occurred in the writer's cache of unacknowledged samples.
void	on_reliable_reader_activity_changed (DataWriter writer, ReliableReaderActivityChangedStatus status)
	<<eXtension>> A matched reliable reader has become active or become inactive.
void	on_instance_replaced (DataWriter writer, InstanceHandle_t handle)
	Notifies when an instance is replaced in DataWriter queue.

Detailed Description

<<interface>> com.rti.dds.infrastructure.Listener for writer status.

Entity:

com.rti.dds.publication.DataWriter

Status:

com.rti.dds.infrastructure.StatusKind.StatusKind.LIVELINESS_LOST_STATUS, com.rti.dds.publication.LivelinessLostStatus;
com.rti.dds.infrastructure.StatusKind.StatusKind.OFFERED_DEADLINE_MISSED_STATUS, com.rti.dds.publication.OfferedDeadlineMissedStatus;
com.rti.dds.infrastructure.StatusKind.StatusKind.OFFERED_INCOMPATIBLE_QOS_STATUS, com.rti.dds.publication.OfferedIncompatibleQosStatus;
com.rti.dds.infrastructure.StatusKind.StatusKind.PUBLICATION_MATCHED_STATUS, com.rti.dds.publication.PublicationMatchedStatus;
com.rti.dds.infrastructure.StatusKind.StatusKind.RELIABLE_READER_ACTIVITY_CHANGED_STATUS, com.rti.dds.publication.ReliableReaderActivityChangedStatus;
com.rti.dds.infrastructure.StatusKind.StatusKind.RELIABLE_WRITER_CACHE_CHANGED_STATUS, com.rti.dds.publication.ReliableWriterCacheChangedStatus;

See Also

Status Kinds

Operations Allowed in Listener Callbacks

Member Function Documentation

void on_offered_deadline_missed	(	DataWriter	writer,
		OfferedDeadlineMissedStatus	status
	)

Handles the com.rti.dds.infrastructure.StatusKind.StatusKind.OFFERED_DEADLINE_MISSED_STATUS status.

This callback is called when the deadline that the com.rti.dds.publication.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 com.rti.dds.publication.DataWriter failed to provide data for an instance.

Parameters

writer	<<out>> Locally created com.rti.dds.publication.DataWriter that triggers the listener callback
status	<<out>> Current deadline missed status of locally created com.rti.dds.publication.DataWriter

void on_offered_incompatible_qos	(	DataWriter	writer,
		OfferedIncompatibleQosStatus	status
	)

Handles the com.rti.dds.infrastructure.StatusKind.StatusKind.OFFERED_INCOMPATIBLE_QOS_STATUS status.

This callback is called when the com.rti.dds.publication.DataWriterQos of the com.rti.dds.publication.DataWriter was incompatible with what was requested by a com.rti.dds.subscription.DataReader. This callback is called when a com.rti.dds.publication.DataWriter has discovered a com.rti.dds.subscription.DataReader for the same com.rti.dds.topic.Topic and common partition, but with a requested QoS that is incompatible with that offered by the com.rti.dds.publication.DataWriter.

Parameters

writer	<<out>> Locally created com.rti.dds.publication.DataWriter that triggers the listener callback
status	<<out>> Current incompatible qos status of locally created com.rti.dds.publication.DataWriter

void on_liveliness_lost	(	DataWriter	writer,
		LivelinessLostStatus	status
	)

Handles the com.rti.dds.infrastructure.StatusKind.StatusKind.LIVELINESS_LOST_STATUS status.

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

Parameters

writer	<<out>> Locally created com.rti.dds.publication.DataWriter that triggers the listener callback
status	<<out>> Current liveliness lost status of locally created com.rti.dds.publication.DataWriter

void on_publication_matched	(	DataWriter	writer,
		PublicationMatchedStatus	status
	)

Handles the com.rti.dds.infrastructure.StatusKind.StatusKind.PUBLICATION_MATCHED_STATUS status.

This callback is called when the com.rti.dds.publication.DataWriter has found a com.rti.dds.subscription.DataReader that matches the com.rti.dds.topic.Topic, has a common partition and compatible QoS, or has ceased to be matched with a com.rti.dds.subscription.DataReader that was previously considered to be matched.

Parameters

writer	<<out>> Locally created com.rti.dds.publication.DataWriter that triggers the listener callback
status	<<out>> Current publication match status of locally created com.rti.dds.publication.DataWriter

void on_reliable_writer_cache_changed	(	DataWriter	writer,
		ReliableWriterCacheChangedStatus	status
	)

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

This listener callback is triggered when:

• The cache is empty (contains no unacknowledged samples).
• The cache is full (the number of unacknowledged samples has reached the value specified in com.rti.dds.infrastructure.ResourceLimitsQosPolicy.max_samples).
• The number of unacknowledged samples has reached com.rti.dds.infrastructure.RtpsReliableWriterProtocol_t.high_watermark or com.rti.dds.infrastructure.RtpsReliableWriterProtocol_t.low_watermark.

Parameters

writer	<<out>> Locally created com.rti.dds.publication.DataWriter that triggers the listener callback
status	<<out>> Current reliable writer cache changed status of locally created com.rti.dds.publication.DataWriter

void on_reliable_reader_activity_changed	(	DataWriter	writer,
		ReliableReaderActivityChangedStatus	status
	)

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

Parameters

writer	<<out>> Locally created com.rti.dds.publication.DataWriter that triggers the listener callback
status	<<out>> Current reliable reader activity changed status of locally created com.rti.dds.publication.DataWriter

void on_instance_replaced	(	DataWriter	writer,
		InstanceHandle_t	handle
	)

Notifies when an instance is replaced in DataWriter queue.

This callback is called when an instance is replaced by the com.rti.dds.publication.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 com.rti.dds.publication.DataWriter that triggers the listener callback
handle	<<out>> Handle of the replaced instance