Index

Package: DDS.DataWriterListener

Description

package DDS.DataWriterListener is

Summary: <<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
See also: DDSStatusTypesModule
See also: SharedEACallbackRules

Types

Ref (abstract) 

type Ref is limited interface and DDS.Listener.Ref;

Ref_Access 

type Ref_Access is access all Ref'Class;

Subprograms & Entries

On_Offered_Deadline_Missed 

procedure On_Offered_Deadline_Missed 
(Self: not null access Ref;
Writer: access DDS.DataWriter.Ref'Class;
Status: in DDS.OfferedDeadlineMissedStatus) is null;

Summary: Handles the DDS.OFFERED_DEADLINE_MISSED_STATUS status.

This callback is called when the deadline that the DDS.DataWriter has committed through its DDSDeadlineQosModule 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.

writer: <<out>> Locally created DDS.DataWriter that triggers the listener callback

status: <<out>> Current deadline missed status of locally created DDS.DataWriter

On_Offered_Incompatible_Qos 

procedure On_Offered_Incompatible_Qos 
(Self: not null access Ref;
Writer: access DDS.DataWriter.Ref'Class;
Status: in DDS.OfferedIncompatibleQosStatus) is null;

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

writer: <<out>> Locally created DDS.DataWriter that triggers the listener callback

status: <<out>> Current incompatible qos status of locally created DDS.DataWriter

On_Liveliness_Lost 

procedure On_Liveliness_Lost 
(Self: not null access Ref;
Writer: access DDS.DataWriter.Ref'Class;
Status: in DDS.LivelinessLostStatus) is null;

Summary: Handles the DDS.LIVELINESS_LOST_STATUS status.

This callback is called when the liveliness that the DDS.DataWriter has committed through its DDSLivelinessQosModule 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.

writer: <<out>> Locally created DDS.DataWriter that triggers the listener callback

status: <<out>> Current liveliness lost status of locally created DDS.DataWriter

On_Publication_Matched 

procedure On_Publication_Matched 
(Self: not null access Ref;
Writer: access DDS.DataWriter.Ref'Class;
Status: in DDS.PublicationMatchedStatus) is null;

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

writer: <<out>> Locally created DDS.DataWriter that triggers the listener callback

status: <<out>> Current publication match status of locally created DDS.DataWriter

On_Reliable_Writer_Cache_Changed 

procedure On_Reliable_Writer_Cache_Changed 
(Self: not null access Ref;
Writer: access DDS.DataWriter.Ref'Class;
Status: in DDS.ReliableWriterCacheChangedStatus) is null;

Summary: <<ext>> 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.

    writer: <<out>> Locally created DDS.DataWriter that triggers the listener callback

    status: <<out>> Current reliable writer cache changed status of locally created DDS.DataWriter

    • On_Reliable_Reader_Activity_Changed 

    procedure On_Reliable_Reader_Activity_Changed 
    (Self: not null access Ref;
    Writer: access DDS.DataWriter.Ref'Class;
    Status: in DDS.ReliableReaderActivityChangedStatus) is null;

    Summary: <<ext>> A matched reliable reader has become active or become inactive.

    writer: <<out>> Locally created DDS.DataWriter that triggers the listener callback

    status: <<out>> Current reliable reader activity changed status of locally created DDS.DataWriter

    On_Destination_Unreachable 

    procedure On_Destination_Unreachable 
    (Self: not null access Ref;
    Writer: access DDS.DataWriter.Ref'Class;
    Instance: in DDS.InstanceHandle_T;
    Locator: in DDS.Locator_T) is null;

    On_Data_Request 

    procedure On_Data_Request 
    (Self: not null access Ref;
    Writer: access DDS.DataWriter.Ref'Class;
    Cookie: in DDS.Cookie_T;
    Request: in out System.Address) is null;

    On_Data_Return 

    procedure On_Data_Return 
    (Self: not null access Ref;
    Writer: access DDS.DataWriter.Ref'Class;
    arg: System.Address;
    Cookie: in DDS.Cookie_T) is null;

    On_Sample_Removed 

    procedure On_Sample_Removed 
    (Self: not null access Ref;
    Writer: access DDS.DataWriter.Ref'Class;
    Cookie: in DDS.Cookie_T) is null;

    On_Instance_Replaced 

    procedure On_Instance_Replaced 
    (Self: not null access Ref;
    Writer: access DDS.DataWriter.Ref'Class;
    Instance: in DDS.InstanceHandle_T) is null;

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

    writer: <<out>> Locally created DDS.DataWriter that triggers the listener callback

    handle: <<out>> Handle of the replaced instance

    On_Application_Acknowledgment 

    procedure On_Application_Acknowledgment 
    (Self: not null access Ref;
    Writer: access DDS.DataWriter.Ref'Class;
    Info: in RTIDDS.Low_Level.dds_c.publication_h.DDS_AcknowledgmentInfo) is null;

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

    writer: <<out>> Locally created DDS.DataWriter that triggers the listener callback

    info: <<out>> DDS.AcknowledgmentInfo of the acknowledged sample