dds::pub::DataWriterListener< T > Class Template Reference

The Listener to notify status changes for a dds::pub::DataWriter. More...

#include <dds/pub/DataWriterListener.hpp>

Inheritance diagram for dds::pub::DataWriterListener< T >:

Public Member Functions
virtual void	on_offered_deadline_missed (dds::pub::DataWriter< T > &writer, const dds::core::status::OfferedDeadlineMissedStatus &status)=0
	Handles the dds::core::status::OfferedDeadlineMissedStatus status.
virtual void	on_offered_incompatible_qos (dds::pub::DataWriter< T > &writer, const dds::core::status::OfferedIncompatibleQosStatus &status)=0
	Handles the dds::core::status::OfferedIncompatibleQosStatus status.
virtual void	on_liveliness_lost (dds::pub::DataWriter< T > &writer, const dds::core::status::LivelinessLostStatus &status)=0
	Handles the dds::core::status::LivelinessLostStatus status.
virtual void	on_publication_matched (dds::pub::DataWriter< T > &writer, const dds::core::status::PublicationMatchedStatus &status)=0
	Handles the dds::core::status::PublicationMatchedStatus status.
virtual void	on_reliable_writer_cache_changed (dds::pub::DataWriter< T > &writer, const rti::core::status::ReliableWriterCacheChangedStatus &status)=0
	<<extension>> Handles the dds::core::status::ReliableWriterCacheChangedStatus status
virtual void	on_reliable_reader_activity_changed (dds::pub::DataWriter< T > &writer, const rti::core::status::ReliableReaderActivityChangedStatus &status)=0
	<<extension>> Handles the dds::core::status::ReliableReaderActivityChangedStatus status
virtual void	on_instance_replaced (dds::pub::DataWriter< T > &writer, const dds::core::InstanceHandle &handle)=0
	<<extension>> Notifies when an instance is replaced in DataWriter queue.
virtual void	on_application_acknowledgment (dds::pub::DataWriter< T > &writer, const rti::pub::AcknowledgmentInfo &acknowledgment_info)=0
	<<extension>> Called when a sample is application-acknowledged.
virtual void	on_service_request_accepted (dds::pub::DataWriter< T > &writer, const rti::core::status::ServiceRequestAcceptedStatus &status)=0
	<<extension>> Called when a sample that has been received on a the built-in service channel is intended for the DataWriter that has installed this listener

Detailed Description

template<typename T>
class dds::pub::DataWriterListener< T >

The Listener to notify status changes for a dds::pub::DataWriter.

Entity:

dds::pub::DataWriter

Status:

dds::core::status::StatusMask::liveliness_lost(), dds::core::status::LivelinessLostStatus;
dds::core::status::StatusMask::offered_deadline_missed(), dds::core::status::OfferedDeadlineMissedStatus;
dds::core::status::StatusMask::offered_incompatible_qos(), dds::core::status::OfferedIncompatibleQosStatus;
dds::core::status::StatusMask::publication_matched(), dds::core::status::PublicationMatchedStatus;
dds::core::status::StatusMask::reliable_reader_activity_changed(), rti::core::status::ReliableReaderActivityChangedStatus;
dds::core::status::StatusMask::reliable_writer_cache_changed(), rti::core::status::ReliableWriterCacheChangedStatus;

See Also

Listener

Status Kinds

Operations Allowed in Listener Callbacks

NoOpDataWriterListener

Member Function Documentation

template<typename T >

virtual void dds::pub::DataWriterListener< T >::on_offered_deadline_missed ( dds::pub::DataWriter< T > &  writer, const dds::core::status::OfferedDeadlineMissedStatus &  status  )

pure virtual

Handles the dds::core::status::OfferedDeadlineMissedStatus status.

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

Parameters

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

Implemented in dds::pub::NoOpDataWriterListener< T >.

template<typename T >

virtual void dds::pub::DataWriterListener< T >::on_offered_incompatible_qos ( dds::pub::DataWriter< T > &  writer, const dds::core::status::OfferedIncompatibleQosStatus &  status  )

pure virtual

Handles the dds::core::status::OfferedIncompatibleQosStatus status.

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

Parameters

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

Implemented in dds::pub::NoOpDataWriterListener< T >.

template<typename T >

virtual void dds::pub::DataWriterListener< T >::on_liveliness_lost ( dds::pub::DataWriter< T > &  writer, const dds::core::status::LivelinessLostStatus &  status  )

pure virtual

Handles the dds::core::status::LivelinessLostStatus status.

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

Parameters

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

Implemented in dds::pub::NoOpDataWriterListener< T >.

template<typename T >

virtual void dds::pub::DataWriterListener< T >::on_publication_matched ( dds::pub::DataWriter< T > &  writer, const dds::core::status::PublicationMatchedStatus &  status  )

pure virtual

Handles the dds::core::status::PublicationMatchedStatus status.

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

Parameters

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

Implemented in dds::pub::NoOpDataWriterListener< T >.

template<typename T >

virtual void dds::pub::DataWriterListener< T >::on_reliable_writer_cache_changed ( dds::pub::DataWriter< T > &  writer, const rti::core::status::ReliableWriterCacheChangedStatus &  status  )

pure virtual

<<extension>> Handles the dds::core::status::ReliableWriterCacheChangedStatus status

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::core::policy::ResourceLimits::max_samples).
• The number of unacknowledged samples has reached rti::core::RtpsReliableWriterProtocol::high_watermark or rti::core::RtpsReliableWriterProtocol::low_watermark.

Parameters

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

Implemented in dds::pub::NoOpDataWriterListener< T >.

template<typename T >

virtual void dds::pub::DataWriterListener< T >::on_reliable_reader_activity_changed ( dds::pub::DataWriter< T > &  writer, const rti::core::status::ReliableReaderActivityChangedStatus &  status  )

pure virtual

<<extension>> Handles the dds::core::status::ReliableReaderActivityChangedStatus status

Parameters

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

Implemented in dds::pub::NoOpDataWriterListener< T >.

template<typename T >

virtual void dds::pub::DataWriterListener< T >::on_instance_replaced ( dds::pub::DataWriter< T > &  writer, const dds::core::InstanceHandle &  handle  )

pure virtual

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

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

Implemented in dds::pub::NoOpDataWriterListener< T >.

template<typename T >

virtual void dds::pub::DataWriterListener< T >::on_application_acknowledgment ( dds::pub::DataWriter< T > &  writer, const rti::pub::AcknowledgmentInfo &  acknowledgment_info  )

pure virtual

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

Applicable only when dds::core::policy::Reliability::acknowledgment_kind = rti::core::policy::AcknowledgmentKind_def::APPLICATION_AUTO or rti::core::policy::AcknowledgmentKind_def::APPLICATION_EXPLICIT

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

Parameters

writer	<<out>> Locally created DataWriter that triggers the listener callback
acknowledgment_info	<<out>> rti::pub::AcknowledgmentInfo of the acknowledged sample

Implemented in dds::pub::NoOpDataWriterListener< T >.

template<typename T >

virtual void dds::pub::DataWriterListener< T >::on_service_request_accepted ( dds::pub::DataWriter< T > &  writer, const rti::core::status::ServiceRequestAcceptedStatus &  status  )

pure virtual

<<extension>> Called when a sample that has been received on a the built-in service channel is intended for the DataWriter that has installed this listener

See Also

Topic Queries

Implemented in dds::pub::NoOpDataWriterListener< T >.