CoreDX DDS
Java Reference Manual

SubscriberListener Interface Reference
[DDS Listeners]

The SubscriberListener provides asynchronous notification of Subscriber events. This listener can be installed during Subscriber creation, DomainParticipant_create_subscriber() as well as by calling Subscriber_set_listener(). More...

List of all members.

Public Member Functions

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 ()

Package Functions

void on_requested_deadline_missed (DataReader the_reader, RequestedDeadlineMissedStatus status)

Detailed Description

The SubscriberListener provides asynchronous notification of Subscriber events. This listener can be installed during Subscriber creation, DomainParticipant_create_subscriber() as well as by calling Subscriber_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 the Subscriber has new data or data state information available. This listener is invoked only if the concerned DataReader does 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 data or data state information arrives at any DataReader contained within the Subscriber.

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 this Subscriber, has changed (either 'active' or 'inactive'). This listener is invoked only if the concerned DataReader does 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_requested_deadline_missed ( DataReader  the_reader,
RequestedDeadlineMissedStatus  status 
) [package]

Called when the CoreDX DDS middleware detects that the QoS DEADLINE policy of a DataReader, contained in this Subscriber, was not satisfied for a data instance. This listener is invoked only if the concerned DataReader does 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 
)

on_requested_incompatible_qos() is called when the CoreDX DDS middleware detects that a DataReader contained in the Subscriber has requested a QoS policy that was incompatible with that offered by a DataWriter. This listener is invoked only if the concerned DataReader does 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 
)

Called when the CoreDX DDS middleware detects that a DataReader contained in the Subscriber has lost a sample (never received). This listener is invoked only if the concerned DataReader does 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 the Subscriber has rejected a sample. This listener is invoked only if the concerned DataReader does 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 the Subscriber has matched or ceased to be matched with a DataWriter. This listener is invoked only if the concerned DataReader does not have an on_subscription_matched listener installed.

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

 All Classes Functions Variables

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