CoreDX DDS Java Reference Manual
Public Member Functions | List of all members
DomainParticipantListener Interface Reference

Public Member Functions

void on_inconsistent_topic (Topic the_topic, InconsistentTopicStatus status)
 
void on_offered_deadline_missed (DataWriter writer, OfferedDeadlineMissedStatus status)
 
void on_offered_incompatible_qos (DataWriter writer, OfferedIncompatibleQosStatus status)
 
void on_liveliness_lost (DataWriter writer, LivelinessLostStatus status)
 
void on_publication_matched (DataWriter writer, PublicationMatchedStatus status)
 
void on_requested_deadline_missed (DataReader the_reader, RequestedDeadlineMissedStatus status)
 
void on_requested_incompatible_qos (DataReader the_reader, RequestedIncompatibleQosStatus status)
 
void on_sample_rejected (DataReader the_reader, SampleRejectedStatus status)
 
void on_liveliness_changed (DataReader the_reader, LivelinessChangedStatus status)
 
void on_data_available (DataReader the_reader)
 
void on_subscription_matched (DataReader the_reader, SubscriptionMatchedStatus status)
 
void on_sample_lost (DataReader the_reader, SampleLostStatus status)
 
void on_data_on_readers (Subscriber the_subscriber)
 
long get_nil_mask ()
 

Detailed Description

The DomainParticipantListener provides asynchronous notification of DDS_DomainParticipant events. This listener can be installed during DomainParticipant creation, DomainParticipantFactory_create_participant(), as well as by calling DomainParticipant_set_listener().

Member Function Documentation

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 DDS middleware 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 DataReader and 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.

void on_data_on_readers ( Subscriber  the_subscriber)

Called when the CoreDX DDS middleware 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 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.

void on_inconsistent_topic ( Topic  the_topic,
InconsistentTopicStatus  status 
)

Called when the CoreDX DDS middleware 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 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.

void on_liveliness_changed ( DataReader  the_reader,
LivelinessChangedStatus  status 
)

Called when the CoreDX DDS middleware 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 DataReader and 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.

void on_liveliness_lost ( DataWriter  writer,
LivelinessLostStatus  status 
)

Called when the CoreDX DDS middleware 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 DataWriter and 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.

void on_offered_deadline_missed ( DataWriter  writer,
OfferedDeadlineMissedStatus  status 
)

Called when the CoreDX DDS middleware 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 DataWriter and 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.

void on_offered_incompatible_qos ( DataWriter  writer,
OfferedIncompatibleQosStatus  status 
)

Called when the CoreDX DDS middleware 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 DataWriter and 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.

void on_publication_matched ( DataWriter  writer,
PublicationMatchedStatus  status 
)

Called when the CoreDX DDS middleware 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 DataWriter and 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.

void on_requested_deadline_missed ( DataReader  the_reader,
RequestedDeadlineMissedStatus  status 
)

Called when the CoreDX DDS middleware 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 DataReader and 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.

void on_requested_incompatible_qos ( DataReader  the_reader,
RequestedIncompatibleQosStatus  status 
)

Called when the CoreDX DDS middleware 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 DataReader and 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.

void on_sample_lost ( DataReader  the_reader,
SampleLostStatus  status 
)

Ccalled when the CoreDX DDS middleware 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 DataReader and 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.

void on_sample_rejected ( DataReader  the_reader,
SampleRejectedStatus  status 
)

Called when the CoreDX DDS middleware detects that a DataReader contained in any Subscriber within the DomainParticipan has rejected a sample. This listener is invoked only if the concerned DataReader and 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.

void on_subscription_matched ( DataReader  the_reader,
SubscriptionMatchedStatus  status 
)

Called when the CoreDX DDS middleware 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 DataReader and 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.


© 2009-2017 Twin Oaks Computing, Inc
Castle Rock, CO 80108
All rights reserved.