RTI Connext Micro  Version 2.4.1.0
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups
DDS_DataWriterListener Struct Reference

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

#include <dds_c_publication.h>

Data Fields

struct DDS_Listener as_listener
 <<cert>> The superclass instance of this DDS_DataWriterListener.
DDS_DataWriterListener_OfferedDeadlineMissedCallback on_offered_deadline_missed
 <<cert>> 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 on_offered_incompatible_qos
 <<cert>> 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 on_liveliness_lost
 <<cert>> 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 renames not alive for another liveliness period.
DDS_DataWriterListener_PublicationMatchedCallback on_publication_matched
 <<cert>> 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_ReliableReaderActivityChangedCallback on_reliable_reader_activity_changed
 <<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.

Detailed Description


Field Documentation

struct DDS_Listener DDS_DataWriterListener::as_listener

<<cert>> The superclass instance of this DDS_DataWriterListener.

DDS_DataWriterListener_OfferedDeadlineMissedCallback DDS_DataWriterListener::on_offered_deadline_missed

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

Parameters:
writer<<out>> Locally created DDS_DataWriter that triggers the listener callback
status<<out>> Current deadline missed status of locally created DDS_DataWriter
DDS_DataWriterListener_OfferedIncompatibleQosCallback DDS_DataWriterListener::on_offered_incompatible_qos

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

Parameters:
writer<<out>> Locally created DDS_DataWriter that triggers the listener callback
status<<out>> Current incompatible qos status of locally created DDS_DataWriter
DDS_DataWriterListener_LivelinessLostCallback DDS_DataWriterListener::on_liveliness_lost

<<cert>> 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 renames not alive for another liveliness period.

Parameters:
writer<<out>> Locally created DDS_DataWriter that triggers the listener callback
status<<out>> Current liveliness lost status of locally created DDS_DataWriter
DDS_DataWriterListener_PublicationMatchedCallback DDS_DataWriterListener::on_publication_matched

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

Parameters:
writer<<out>> Locally created DDS_DataWriter that triggers the listener callback
status<<out>> Current publication match status of locally created DDS_DataWriter
DDS_DataWriterListener_ReliableReaderActivityChangedCallback DDS_DataWriterListener::on_reliable_reader_activity_changed

<<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 DDS_DataWriter that triggers the listener callback
status<<out>> Current reliable reader activity changed status of locally created DDS_DataWriter

RTI Connext Micro Version 2.4.1.0 Copyright © Thu Nov 20 2014 Real-Time Innovations, Inc