DDSDataWriterListener Class Reference

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

Inheritance diagram for DDSDataWriterListener:

Public Member Functions
virtual void	on_offered_deadline_missed (DDSDataWriter *writer, const DDS_OfferedDeadlineMissedStatus &status)
	Handles the DDS_OFFERED_DEADLINE_MISSED_STATUS status. More...
virtual void	on_liveliness_lost (DDSDataWriter *writer, const DDS_LivelinessLostStatus &status)
	Handles the DDS_LIVELINESS_LOST_STATUS status. More...
virtual void	on_offered_incompatible_qos (DDSDataWriter *writer, const DDS_OfferedIncompatibleQosStatus &status)
	Handles the DDS_OFFERED_INCOMPATIBLE_QOS_STATUS status. More...
virtual void	on_publication_matched (DDSDataWriter *writer, const DDS_PublicationMatchedStatus &status)
	Handles the DDS_PUBLICATION_MATCHED_STATUS status. More...
virtual void	on_reliable_writer_cache_changed (DDSDataWriter *writer, const DDS_ReliableWriterCacheChangedStatus &status)
	<<extension>> A change has occurred in the writer's cache of unacknowledged samples. More...
virtual void	on_reliable_reader_activity_changed (DDSDataWriter *writer, const DDS_ReliableReaderActivityChangedStatus &status)
	<<extension>> A matched reliable reader has become active or become inactive. More...
virtual void	on_sample_removed (DDSDataWriter *writer, const DDS_Cookie_t &cookie)
	<<extension>> Called when a sample is removed from the DataWriter queue. More...
virtual void	on_instance_replaced (DDSDataWriter *writer, const DDS_InstanceHandle_t &handle)
	<<extension>> Notifies when an instance is replaced in DataWriter queue. More...
virtual void	on_application_acknowledgment (DDSDataWriter *writer, const DDS_AcknowledgmentInfo &info)
	<<extension>> Called when a sample is application-acknowledged More...
virtual void	on_service_request_accepted (DDSDataWriter *writer, const DDS_ServiceRequestAcceptedStatus &status)
	<<extension>> Called when a DDS_ServiceRequest for the DDSTopicQuery service is dispatched to this DDSDataWriter for processing. More...

Detailed Description

<<interface>> DDSListener for writer status.

Entity:

DDSDataWriter

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

DDSListener

Status Kinds

Operations Allowed in Listener Callbacks

Member Function Documentation

on_offered_deadline_missed()

virtual void DDSDataWriterListener::on_offered_deadline_missed ( DDSDataWriter *  writer, const DDS_OfferedDeadlineMissedStatus &  status  )

virtual

Handles the DDS_OFFERED_DEADLINE_MISSED_STATUS status.

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

Parameters

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

on_liveliness_lost()

virtual void DDSDataWriterListener::on_liveliness_lost ( DDSDataWriter *  writer, const DDS_LivelinessLostStatus &  status  )

virtual

Handles the DDS_LIVELINESS_LOST_STATUS status.

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

Parameters

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

on_offered_incompatible_qos()

virtual void DDSDataWriterListener::on_offered_incompatible_qos ( DDSDataWriter *  writer, const DDS_OfferedIncompatibleQosStatus &  status  )

virtual

Handles the DDS_OFFERED_INCOMPATIBLE_QOS_STATUS status.

This callback is called when the DDS_DataWriterQos of the DDSDataWriter was incompatible with what was requested by a DDSDataReader. This callback is called when a DDSDataWriter has discovered a DDSDataReader for the same DDSTopic and common partition, but with a requested QoS that is incompatible with that offered by the DDSDataWriter.

Parameters

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

on_publication_matched()

virtual void DDSDataWriterListener::on_publication_matched ( DDSDataWriter *  writer, const DDS_PublicationMatchedStatus &  status  )

virtual

Handles the DDS_PUBLICATION_MATCHED_STATUS status.

This callback is called when the DDSDataWriter has found a DDSDataReader that matches the DDSTopic, has a common partition and compatible QoS, or has ceased to be matched with a DDSDataReader that was previously considered to be matched.

Parameters

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

on_reliable_writer_cache_changed()

virtual void DDSDataWriterListener::on_reliable_writer_cache_changed ( DDSDataWriter *  writer, const DDS_ReliableWriterCacheChangedStatus &  status  )

virtual

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

Parameters

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

on_reliable_reader_activity_changed()

virtual void DDSDataWriterListener::on_reliable_reader_activity_changed ( DDSDataWriter *  writer, const DDS_ReliableReaderActivityChangedStatus &  status  )

virtual

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

Parameters

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

on_sample_removed()

virtual void DDSDataWriterListener::on_sample_removed ( DDSDataWriter *  writer, const DDS_Cookie_t &  cookie  )

virtual

<<extension>> Called when a sample is removed from the DataWriter queue.

This callback is called only if the sample was written with a DDS_Cookie_t with FooDataWriter::write_w_params, or if this writer uses Zero Copy transfer over shared memory" or FlatData Topic-Types "FlatData language binding".

Parameters

writer	<<out>> Locally created DDSDataWriter that triggers the listener callback
cookie	<<out>> If this sample was written with FooDataWriter::write_w_params, this field contains a copy of the cookie set in DDS_WriteParams_t. If this writer uses Zero Copy transfer over shared memory or FlatData language binding, this field contains the absolute address of the sample that is removed. The address of the sample can be obtained by using DDS_Cookie_t::to_pointer

See also

FooDataWriter::get_loan

on_instance_replaced()

virtual void DDSDataWriterListener::on_instance_replaced ( DDSDataWriter *  writer, const DDS_InstanceHandle_t &  handle  )

virtual

<<extension>> Notifies when an instance is replaced in DataWriter queue.

This callback is called when an instance is replaced by the DDSDataWriter 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 using the FooDataWriter::get_key_value API.

Because this callback can be called within the context of an in-progress write, dispose, or unregister call, most APIs on the DataWriter must not be used. The only DataWriter APIs that are safe to call within this callback are:

• FooDataWriter::get_key_value
• FooDataWriter::narrow
• FooDataWriter::create_data
• FooDataWriter::delete_data
• DDSDataWriter::get_matched_subscriptions
• DDSDataWriter::is_matched_subscription_active
• DDSDataWriter::get_matched_subscription_participant_data
• DDSDataWriter::get_topic
• DDSDataWriter::get_publisher
• DDSDataWriter::is_sample_app_acknowledged

Parameters

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

on_application_acknowledgment()

virtual void DDSDataWriterListener::on_application_acknowledgment ( DDSDataWriter *  writer, const DDS_AcknowledgmentInfo &  info  )

virtual

<<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 DDSDataReader. Also provides user-specified response data sent from the DDSDataReader by the acknowledgment message.

Parameters

writer	<<out>> Locally created DDSDataWriter that triggers the listener callback
info	<<out>> DDS_AcknowledgmentInfo of the acknowledged sample

on_service_request_accepted()

virtual void DDSDataWriterListener::on_service_request_accepted ( DDSDataWriter *  writer, const DDS_ServiceRequestAcceptedStatus &  status  )

virtual

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

Parameters

writer	<<out>> Locally created DDSDataWriter that triggers the listener callback
status	<<out>> Current service request accepted status of locally created DDSDataWriter

See also

Topic Queries