com.toc.coredx.DDS
Interface DomainParticipantListener

public interface DomainParticipantListener

The DDS_DomainParticipantListener provides asynchronous notification of DDS_DomainParticipant events. This listener can be installed during DomainParticipant creation, DDS_DomainParticipantFactory_create_participant(), as well as by calling DDS_DomainParticipant_set_listener().

Method Summary

long	get_nil_mask() get_nil_mask() returns a bitmask indicating which listener methods (if any) should be considered NIL, and therefore, should not be invoked.
void	on_data_available(DataReader the_reader) Called when the CoreDX infrastructure detects that a DataReader, contained in any Subscriber in this DomainParticipant, has new data or data state information available.
void	on_data_on_readers(Subscriber the_subscriber) Called when the CoreDX infrastructure detects that a DataReader, contained in any Subscriber in this DomainParticipant, has new data or data state information available.
void	on_inconsistent_topic(Topic the_topic, InconsistentTopicStatus status) Called when the CoreDX infrastructure detects that a Topic contained within this DomainParticipant has characteristics taht are different (inconsistent) with another existing topic.
void	on_liveliness_changed(DataReader the_reader, LivelinessChangedStatus status) Called when the CoreDX infrastructure detects that the liveliness of a DataWriter, matched to a DataReader within any Subscriber within this DomainParticipant, has changed (either 'active' or 'inactive').
void	on_liveliness_lost(DataWriter writer, LivelinessLostStatus status) Called when the CoreDX infrastructure detects that a DataWriter contained in any Publisher within this DomainParticipant has not satisfied its LIVELINESS QoS setting.
void	on_offered_deadline_missed(DataWriter writer, OfferedDeadlineMissedStatus status) Called when the CoreDX infrastructure detects that a DataWriter contained in any Publisher within this DomainParticipant has failed to meet its DEADLINE QoS commitment.
void	on_offered_incompatible_qos(DataWriter writer, OfferedIncompatibleQosStatus status) Called when the CoreDX infrastructure detects that a DataWriter contained in any Publisher within this DomainParticipant has offered a QoS policy setting that is incompatible with that requested by a potentially matching DataReader.
void	on_publication_matched(DataWriter writer, PublicationMatchedStatus status) Called when the CoreDX infrastructure detects that a DataWriter contained in any Publisher within this DomainParticipant has matched with a DataReader or has ceased to be matched with a DataReader.
void	on_requested_deadline_missed(DataReader the_reader, RequestedDeadlineMissedStatus status) Called when the CoreDX infrastructure detects that the QoS DEADLINE policy of a DataReader, contained in any Subscriber of this DomainParticipant, was not satisfied for a data instance.
void	on_requested_incompatible_qos(DataReader the_reader, RequestedIncompatibleQosStatus status) Called when the CoreDX infrastructure detects that a DataReader contained in any Subscriber within this DomainParticipant, has requested a QoS policy that was incompatible with that offered by a DataWriter.
void	on_sample_lost(DataReader the_reader, SampleLostStatus status) Ccalled when the CoreDX infrastructure detects that a DataReader, contained in any Subscriber in this DomainParticipant, has lost a sample (never received).
void	on_sample_rejected(DataReader the_reader, SampleRejectedStatus status) Called when the CoreDX infrastructure detects that a DataReader contained in any Subscriber within the DomainParticipan has rejected a sample.
void	on_subscription_matched(DataReader the_reader, SubscriptionMatchedStatus status) Called when the CoreDX infrastructure detects that a DataReader, contained in any Subscriber in this DomainParticipant, has matched or ceased to be matched with a DataWriter.

Method Detail

on_inconsistent_topic

void on_inconsistent_topic(Topic the_topic,
                           InconsistentTopicStatus status)

Called when the CoreDX infrastructure detects that a Topic contained within this DomainParticipant has characteristics taht are different (inconsistent) with another existing topic. This listener is invoked only if the concerned DDS_Topic does not have an on_inconsistent_topic listener installed.

The status argument provides a snapshot of the status at the time the listener was invoked.

on_offered_deadline_missed

void on_offered_deadline_missed(DataWriter writer,
                                OfferedDeadlineMissedStatus status)

Called when the CoreDX infrastructure detects that a DataWriter contained in any Publisher within this DomainParticipant has failed to meet its DEADLINE QoS commitment. This listener is invoked only if the concerned DDS_DataWriter and DDS_Publisher do not have an on_offered_deadline_missed listener installed.

The status argument provides a snapshot of the status at the time the listener was invoked.

on_offered_incompatible_qos

void on_offered_incompatible_qos(DataWriter writer,
                                 OfferedIncompatibleQosStatus status)

Called when the CoreDX infrastructure detects that a DataWriter contained in any Publisher within this DomainParticipant has offered a QoS policy setting that is incompatible with that requested by a potentially matching DataReader. This listener is invoked only if the concerned DDS_DataWriter and DDS_Publisher do not have an on_offered_incompatible_qos listener installed.

The status argument provides a snapshot of the status at the time the listener was invoked.

on_liveliness_lost

void on_liveliness_lost(DataWriter writer,
                        LivelinessLostStatus status)

Called when the CoreDX infrastructure detects that a DataWriter contained in any Publisher within this DomainParticipant has not satisfied its LIVELINESS QoS setting. This listener is invoked only if the concerned DDS_DataWriter and DDS_Publisher do not have an on_liveliness_lost listener installed.

The status argument provides a snapshot of the status at the time the listener was invoked.

on_publication_matched

void on_publication_matched(DataWriter writer,
                            PublicationMatchedStatus status)

Called when the CoreDX infrastructure detects that a DataWriter contained in any Publisher within this DomainParticipant has matched with a DataReader or has ceased to be matched with a DataReader. This listener is invoked only if the concerned DDS_DataWriter and DDS_Publisher do not have an on_publication_matched listener installed.

The status argument provides a snapshot of the status at the time the listener was invoked.

on_requested_deadline_missed

void on_requested_deadline_missed(DataReader the_reader,
                                  RequestedDeadlineMissedStatus status)

Called when the CoreDX infrastructure detects that the QoS DEADLINE policy of a DataReader, contained in any Subscriber of this DomainParticipant, was not satisfied for a data instance. This listener is invoked only if the concerned DDS_DataReader and DDS_Subscriber do not have an on_requested_deadline_missed listener installed.

The status argument provides a snapshot of the status at the time the listener was invoked.

on_requested_incompatible_qos

void on_requested_incompatible_qos(DataReader the_reader,
                                   RequestedIncompatibleQosStatus status)

Called when the CoreDX infrastructure detects that a DataReader contained in any Subscriber within this DomainParticipant, has requested a QoS policy that was incompatible with that offered by a DataWriter. This listener is invoked only if the concerned DDS_DataReader and DDS_Subscriber do not have an on_requested_incompatible_qos listener installed.

The status argument provides a snapshot of the status at the time the listener was invoked.

on_sample_rejected

void on_sample_rejected(DataReader the_reader,
                        SampleRejectedStatus status)

Called when the CoreDX infrastructure detects that a DataReader contained in any Subscriber within the DomainParticipan has rejected a sample. This listener is invoked only if the concerned DDS_DataReader and DDS_Subscriber do not have an on_sample_rejected listener installed.

The status argument provides a snapshot of the status at the time the listener was invoked.

on_liveliness_changed

void on_liveliness_changed(DataReader the_reader,
                           LivelinessChangedStatus status)

Called when the CoreDX infrastructure detects that the liveliness of a DataWriter, matched to a DataReader within any Subscriber within this DomainParticipant, has changed (either 'active' or 'inactive'). This listener is invoked only if the concerned DDS_DataReader and DDS_Subscriber do not have an on_liveliness_changed listener installed.

The status argument provides a snapshot of the status at the time the listener was invoked.

on_data_available

void on_data_available(DataReader the_reader)

Called when the CoreDX infrastructure detects that a DataReader, contained in any Subscriber in this DomainParticipant, has new data or data state information available. This listener is invoked only if the concerned DDS_DataReader and DDS_Subscriber do not have an on_data_available listener installed.

The status argument provides a snapshot of the status at the time the listener was invoked.

on_subscription_matched

void on_subscription_matched(DataReader the_reader,
                             SubscriptionMatchedStatus status)

Called when the CoreDX infrastructure detects that a DataReader, contained in any Subscriber in this DomainParticipant, has matched or ceased to be matched with a DataWriter. This listener is invoked only if the concerned DDS_DataReader and DDS_Subscriber do not have an on_subscription_matched listener installed.

The status argument provides a snapshot of the status at the time the listener was invoked.

on_sample_lost

void on_sample_lost(DataReader the_reader,
                    SampleLostStatus status)

Ccalled when the CoreDX infrastructure detects that a DataReader, contained in any Subscriber in this DomainParticipant, has lost a sample (never received). This listener is invoked only if the concerned DDS_DataReader and DDS_Subscriber do not have an on_sample_lost listener installed.

The status argument provides a snapshot of the status at the time the listener was invoked.

on_data_on_readers

void on_data_on_readers(Subscriber the_subscriber)

Called when the CoreDX infrastructure detects that a DataReader, contained in any Subscriber in this DomainParticipant, has new data or data state information available. This listener is invoked only if the concerned DDS_Subscriber does not have an on_data_on_readers listener installed.

The status argument provides a snapshot of the status at the time the listener was invoked.

get_nil_mask

long get_nil_mask()

get_nil_mask() returns a bitmask indicating which listener methods (if any) should be considered NIL, and therefore, should not be invoked.