DDS_DataWriterListener Struct Reference

<<interface>> DDS_Listener for writer status. More...

Data Fields
struct DDS_Listener	as_listener
	The superclass instance of this DDS_DataWriterListener.
DDS_DataWriterListener_OfferedDeadlineMissedCallback	on_offered_deadline_missed
	Handles the DDS_OFFERED_DEADLINE_MISSED_STATUS status.
DDS_DataWriterListener_OfferedIncompatibleQosCallback	on_offered_incompatible_qos
	Handles the DDS_OFFERED_INCOMPATIBLE_QOS_STATUS status.
DDS_DataWriterListener_LivelinessLostCallback	on_liveliness_lost
	Handles the DDS_LIVELINESS_LOST_STATUS status.
DDS_DataWriterListener_PublicationMatchedCallback	on_publication_matched
	Handles the DDS_PUBLICATION_MATCHED_STATUS status.
DDS_DataWriterListener_ReliableWriterCacheChangedCallback	on_reliable_writer_cache_changed
	<<extension>> A change has occurred in the writer's cache of unacknowledged samples.
DDS_DataWriterListener_ReliableReaderActivityChangedCallback	on_reliable_reader_activity_changed
	<<extension>> A matched reliable reader has become active or become inactive.
DDS_DataWriterListener_InstanceReplacedCallback	on_instance_replaced
	<<extension>> Notifies when an instance is replaced in DataWriter queue.
DDS_DataWriterListener_OnApplicationAcknowledgmentCallback	on_application_acknowledgment
	<<extension>> Called when a sample is application-acknowledged
DDS_DataWriterListener_ServiceRequestAcceptedCallback	on_service_request_accepted
	<<extension>> Called when a DDS_ServiceRequest for the DDS_TopicQuery service is dispatched to this DDS_DataWriter for processing.

Detailed Description

<<interface>> DDS_Listener for writer status.

Entity:

DDS_DataWriter

Status:

DDS_LIVELINESS_LOST_STATUS, DDS_LivelinessLostStatus;
DDS_OFFERED_DEADLINE_MISSED_STATUS, DDS_OfferedDeadlineMissedStatus;
DDS_OFFERED_INCOMPATIBLE_QOS_STATUS, DDS_OfferedIncompatibleQosStatus;
DDS_PUBLICATION_MATCHED_STATUS, DDS_PublicationMatchedStatus;
DDS_RELIABLE_READER_ACTIVITY_CHANGED_STATUS, DDS_ReliableReaderActivityChangedStatus;
DDS_RELIABLE_WRITER_CACHE_CHANGED_STATUS, DDS_ReliableWriterCacheChangedStatus;

See Also

DDS_Listener

Status Kinds

Operations Allowed in Listener Callbacks

Field Documentation

struct DDS_Listener DDS_DataWriterListener::as_listener

The superclass instance of this DDS_DataWriterListener.

DDS_DataWriterListener_OfferedDeadlineMissedCallback DDS_DataWriterListener::on_offered_deadline_missed

Handles the DDS_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.

DDS_DataWriterListener_OfferedIncompatibleQosCallback DDS_DataWriterListener::on_offered_incompatible_qos

Handles the DDS_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.

DDS_DataWriterListener_LivelinessLostCallback DDS_DataWriterListener::on_liveliness_lost

Handles the DDS_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 remains not alive for another liveliness period.

DDS_DataWriterListener_PublicationMatchedCallback DDS_DataWriterListener::on_publication_matched

Handles the DDS_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.

DDS_DataWriterListener_ReliableWriterCacheChangedCallback DDS_DataWriterListener::on_reliable_writer_cache_changed

<<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 DDS_ResourceLimitsQosPolicy::max_samples).
• The number of unacknowledged samples has reached DDS_RtpsReliableWriterProtocol_t::high_watermark or DDS_RtpsReliableWriterProtocol_t::low_watermark.

DDS_DataWriterListener_ReliableReaderActivityChangedCallback DDS_DataWriterListener::on_reliable_reader_activity_changed

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

DDS_DataWriterListener_InstanceReplacedCallback DDS_DataWriterListener::on_instance_replaced

<<extension>> 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.

DDS_DataWriterListener_OnApplicationAcknowledgmentCallback DDS_DataWriterListener::on_application_acknowledgment

<<extension>> Called when a sample is application-acknowledged

Applicable only when DDS_ReliabilityQosPolicy::acknowledgment_kind = DDS_APPLICATION_AUTO_ACKNOWLEDGMENT_MODE or DDS_APPLICATION_EXPLICIT_ACKNOWLEDGMENT_MODE

Called when a sample is application-level acknowledged. Provides identities of the sample and the acknowledging DDS_DataReader. Also provides user-specified response data sent from the DDS_DataReader by the acknowledgment message.

DDS_DataWriterListener_ServiceRequestAcceptedCallback DDS_DataWriterListener::on_service_request_accepted

<<extension>> Called when a DDS_ServiceRequest for the DDS_TopicQuery service is dispatched to this DDS_DataWriter for processing.

See Also

Topic Queries