DDSDataWriterListener Class Reference

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

#include <dds_cpp_publication.hxx>

Inheritance diagram for DDSDataWriterListener:

List of all members.

Public Member Functions
virtual void	on_offered_deadline_missed (DDSDataWriter *writer, const DDS_OfferedDeadlineMissedStatus &status)
	<<cert>> Handles the DDS_OFFERED_DEADLINE_MISSED_STATUS status.
virtual void	on_liveliness_lost (DDSDataWriter *writer, const DDS_LivelinessLostStatus &status)
	<<cert>> Handles the DDS_LIVELINESS_LOST_STATUS status.
virtual void	on_offered_incompatible_qos (DDSDataWriter *writer, const DDS_OfferedIncompatibleQosStatus &status)
	<<cert>> Handles the DDS_OFFERED_INCOMPATIBLE_QOS_STATUS status.
virtual void	on_publication_matched (DDSDataWriter *writer, const DDS_PublicationMatchedStatus &status)
	<<cert>> Handles the DDS_PUBLICATION_MATCHED_STATUS status.
virtual void	on_reliable_reader_activity_changed (DDSDataWriter *writer, const DDS_ReliableReaderActivityChangedStatus &status)
	<<eXtension>> <<cert>> A matched reliable reader has become active or become inactive.
virtual void	on_reliable_sample_unacknowledged (DDSDataWriter *writer, const DDS_ReliableSampleUnacknowledgedStatus &status)
	<<eXtension>> <<cert>> A matched reliable reader has become active or become inactive.
virtual void	on_sample_removed (DDSDataWriter *writer, const DDS_Cookie_t &cookie)
	<<eXtension>> Called when a sample is removed from the DataWriter queue.

---

Detailed Description

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

Entity:

DDSDataWriter

Status:

DDS_LIVELINESS_LOST_STATUS, DDS_LivelinessLostStatus;
DDS_OFFERED_INCOMPATIBLE_QOS_STATUS, DDS_OfferedIncompatibleQosStatus;
DDS_PUBLICATION_MATCHED_STATUS, DDS_PublicationMatchedStatus;

See also:

Status Kinds

---

Member Function Documentation

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

inlinevirtual

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

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

inlinevirtual

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

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

inlinevirtual

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

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

inlinevirtual

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

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

inlinevirtual

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

A reliable writer considers a matched reliable reader to be active when it receives ACKNACK messages from the reader in response to its HEARTBEAT messages. The writer considers an active reader to have become inactive when it has sent a number of consecutive periodic HEARTBEATs equal to DDS_RtpsReliableWriterProtocol_t::max_heartbeat_retries without receiving an ACKNACK from the reader. An inactive reader becomes active once the writer receives an ACKNACK from it.

This callback is called when the transition from active to inactive, and vice versa, has occurred for a matched reliable reader.

Parameters:

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

virtual void DDSDataWriterListener::on_reliable_sample_unacknowledged ( DDSDataWriter *  writer, const DDS_ReliableSampleUnacknowledgedStatus &  status  )

inlinevirtual

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

A reliable writer considers a matched reliable reader to be active when it receives ACKNACK messages from the reader in response to its HEARTBEAT messages. The writer considers an active reader to have become inactive when it has sent a number of consecutive periodic HEARTBEATs equal to DDS_RtpsReliableWriterProtocol_t::max_heartbeat_retries without receiving an ACKNACK from the reader. An inactive reader becomes active once the writer receives an ACKNACK from it.

This callback is called when the transition from active to inactive, and vice versa, has occurred for a matched reliable reader.

Parameters:

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

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

inlinevirtual

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

Supported while using Zero Copy Transfer Over Shared Memory "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>> Contains the absolute address of the sample that is removed. The address of the sample can be obtained by using \

See also:

FooDataWriter::get_loan