 |
OpenSplice Java 5 DCPS
v6.x
OpenSplice Java 5 OpenSplice Data Distribution Service Data-Centric Publish-Subscribe API
|
|
OpenSplice Java 5 DCPS
v6.x
OpenSplice Java 5 OpenSplice Data Distribution Service Data-Centric Publish-Subscribe API
|
A convenience class DomainParticipantAdapter is offered which has an empty implementation of all org.omg.dds.domain.DomainParticipantListener callback functions when the application extends from this class only the used callback functions that the user wants to use need to be implemented. More...
Public Member Functions | |
| void | onDataAvailable (DataAvailableEvent<?> status) |
| This operation is the external operation (interface, which must be implemented by the application) that is called by the Data Distribution Service when new data is available for this DataReader. More... | |
| void | onDataOnReaders (DataOnReadersEvent status) |
| This operation is the external operation (interface, which must be implemented by the application) that is called by the Data Distribution Service when new data is available for this Subscriber. More... | |
| void | onInconsistentTopic (InconsistentTopicEvent<?> status) |
| This operation is the external operation (interface, which must be implemented by the application) that is called by the Data Distribution Service when the org.omg.dds.core.status.InconsistentTopicStatus changes. More... | |
| void | onLivelinessChanged (LivelinessChangedEvent<?> status) |
| This operation is the external operation (interface, which must be implemented by the application) that is called by the Data Distribution Service when the liveliness of one or more DataWriter objects that were writing instances read through this DataReader has changed. More... | |
| void | onLivelinessLost (LivelinessLostEvent<?> status) |
| This operation is the external operation (interface, which must be implemented by the application) that is called by the Data Distribution Service when the org.omg.dds.core.status.LivelinessLostStatus changes. More... | |
| void | onOfferedDeadlineMissed (OfferedDeadlineMissedEvent<?> status) |
| This operation is the external operation (interface, which must be implemented by the application) that is called by the Data Distribution Service when the org.omg.dds.core.status.OfferedDeadlineMissedStatus changes. More... | |
| void | onOfferedIncompatibleQos (OfferedIncompatibleQosEvent<?> status) |
| This operation is the external operation (interface, which must be implemented by the application) that is called by the Data Distribution Service when the org.omg.dds.core.status.OfferedIncompatibleQosStatus changes. More... | |
| void | onPublicationMatched (PublicationMatchedEvent<?> status) |
| This operation must be implemented by the application and is called by the Data Distribution Service when a new match has been discovered for the current publication, or when an existing match has ceased to exist. More... | |
| void | onRequestedDeadlineMissed (RequestedDeadlineMissedEvent<?> status) |
| This operation is the external operation (interface, which must be implemented by the application) that is called by the Data Distribution Service when the deadline that the DataReader was expecting through its DeadlineQosPolicy was not respected for a specific instance. More... | |
| void | onRequestedIncompatibleQos (RequestedIncompatibleQosEvent<?> status) |
| This operation is the external operation (interface, which must be implemented by the application) that is called by the Data Distribution Service when the RequestedIncompatibleQosStatus changes. More... | |
| void | onSampleLost (SampleLostEvent<?> status) |
| This operation is the external operation (interface, which must be implemented by the application) that is called by the Data Distribution Service when a sample is lost and this is detected. More... | |
| void | onSampleRejected (SampleRejectedEvent<?> status) |
| This operation is the external operation (interface, which must be implemented by the application) that is called by the Data Distribution Service when a (received) sample has been rejected. More... | |
| void | onSubscriptionMatched (SubscriptionMatchedEvent<?> status) |
| This operation is called by the Data Distribution Service when a new match has been discovered for the current subscription, or when an existing match has ceased to exist. More... | |
A convenience class DomainParticipantAdapter is offered which has an empty implementation of all org.omg.dds.domain.DomainParticipantListener callback functions when the application extends from this class only the used callback functions that the user wants to use need to be implemented.
Definition at line 40 of file DomainParticipantAdapter.java.
| void org.omg.dds.domain.DomainParticipantAdapter.onDataAvailable | ( | DataAvailableEvent<?> | status | ) |
This operation is the external operation (interface, which must be implemented by the application) that is called by the Data Distribution Service when new data is available for this DataReader.
The implementation may be left empty when this functionality is not needed. This operation will only be called when the relevant SubscriberListener is installed and enabled for the DataAvailableStatus.
The statuses DataOnReadersStatus and DataAvailableStatus will occur together. In case these status changes occur, the Data Distribution Service will look for an attached and activated SubscriberListener or DomainParticipantListener (in that order) for the DataOnReadersStatus. In case the DataOnReadersStatus can not be handled, the Data Distribution Service will look for an attached and activated DataReaderListener, SubscriberListener or DomainParticipantListener for the DataAvailableStatus (in that order).
Note that if onDataOnReaders is called, then the Data Distribution Service will not try to call onDataAvailable, however, the application can force a call to the DataReader objects that have data by means of the notifyDatareaders operation.
| status | Contains the DataAvailableStatus object (this is an input to the application). |
Implements org.omg.dds.sub.SubscriberListener.
Definition at line 80 of file DomainParticipantAdapter.java.
| void org.omg.dds.domain.DomainParticipantAdapter.onDataOnReaders | ( | DataOnReadersEvent | status | ) |
This operation is the external operation (interface, which must be implemented by the application) that is called by the Data Distribution Service when new data is available for this Subscriber.
The implementation may be left empty when this functionality is not needed. This operation will only be called when the relevant SubscriberListener is installed and enabled for the DataOnReadersStatus.
The statuses DataOnReadersStatus and DataAvailableStatus will occur together. In case these status changes occur, the Data Distribution Service will look for an attached and activated SubscriberListener or DomainParticipantListener (in that order) for the DataOnReadersStatus. In case the DataOnReadersStatus can not be handled, the Data Distribution Service will look for an attached and activated DataReaderListener, SubscriberListener or DomainParticipantListener for the DataAvailableStatus (in that order).
Note that if onDataOnReaders is called, then the Data Distribution Service will not try to call onDataAvailable, however, the application can force a call to the DataReader objects that have data by means of the notifyDatareaders operation.
| status | Contains the DataOnReadersStatus object (this is an input to the application). |
Implements org.omg.dds.sub.SubscriberListener.
Definition at line 74 of file DomainParticipantAdapter.java.
| void org.omg.dds.domain.DomainParticipantAdapter.onInconsistentTopic | ( | InconsistentTopicEvent<?> | status | ) |
This operation is the external operation (interface, which must be implemented by the application) that is called by the Data Distribution Service when the org.omg.dds.core.status.InconsistentTopicStatus changes.
The implementation may be left empty when this functionality is not needed. This operation will only be called when the relevant TopicListener is installed and enabled for the InconsistentTopicStatus. The InconsistentTopicStatus will change when another Topic exists with the same topic_name but different characteristics. The Data Distribution Service will call the DomainParticipantListener operation with a parameter status, which will contain the object of the class InconsistentTopicStatus.
| status | Contains the InconsistentTopicStatus object (this is an input to the application). |
Implements org.omg.dds.domain.DomainParticipantListener.
Definition at line 43 of file DomainParticipantAdapter.java.
| void org.omg.dds.domain.DomainParticipantAdapter.onLivelinessChanged | ( | LivelinessChangedEvent<?> | status | ) |
This operation is the external operation (interface, which must be implemented by the application) that is called by the Data Distribution Service when the liveliness of one or more DataWriter objects that were writing instances read through this DataReader has changed.
In other words, some DataWriter have become "alive" or "not alive". The implementation may be left empty when this functionality is not needed. This operation will only be called when the relevant SubscriberListener is installed and enabled for the LivelinessChangedStatus.
The Data Distribution Service will provide a reference to the LivelinessChangedStatus object for use by the application.
| status | Contains the LivelinessChangedStatus object (this is an input to the application). |
Implements org.omg.dds.sub.SubscriberListener.
Definition at line 86 of file DomainParticipantAdapter.java.
| void org.omg.dds.domain.DomainParticipantAdapter.onLivelinessLost | ( | LivelinessLostEvent<?> | status | ) |
This operation is the external operation (interface, which must be implemented by the application) that is called by the Data Distribution Service when the org.omg.dds.core.status.LivelinessLostStatus changes.
The implementation may be left empty when this functionality is not needed. This operation will only be called when the relevant PublisherListener is installed and enabled for the liveliness lost status. The liveliness lost status will change when the liveliness that the DataWriter has committed through its LivelinessQosPolicy was not respected. In other words, the DataWriter failed to actively signal its liveliness within the offered liveliness period. As a result, the DataReader objects will consider the DataWriter as no longer "alive". The Data Distribution Service will call the PublisherListener operation with a parameter status, which will contain the LivelinessLostStatus object.
| status | Contains the LivelinessLostStatus object (this is an input to the application) |
Implements org.omg.dds.pub.PublisherListener.
Definition at line 49 of file DomainParticipantAdapter.java.
| void org.omg.dds.domain.DomainParticipantAdapter.onOfferedDeadlineMissed | ( | OfferedDeadlineMissedEvent<?> | status | ) |
This operation is the external operation (interface, which must be implemented by the application) that is called by the Data Distribution Service when the org.omg.dds.core.status.OfferedDeadlineMissedStatus changes.
The implementation may be left empty when this functionality is not needed. This operation will only be called when the relevant PublisherListener is installed and enabled for the offered deadline missed status. The offered deadline missed status will change when the deadline that the DataWriter has committed through its DeadlineQosPolicy was not respected for a specific instance. The Data Distribution Service will call the PublisherListener operation with a parameter status, which will contain the OfferedDeadlineMissedStatus object.
| status | Contains the OfferedDeadlineMissedStatus object (this is an input to the application). |
Implements org.omg.dds.pub.PublisherListener.
Definition at line 55 of file DomainParticipantAdapter.java.
| void org.omg.dds.domain.DomainParticipantAdapter.onOfferedIncompatibleQos | ( | OfferedIncompatibleQosEvent<?> | status | ) |
This operation is the external operation (interface, which must be implemented by the application) that is called by the Data Distribution Service when the org.omg.dds.core.status.OfferedIncompatibleQosStatus changes.
The implementation may be left empty when this functionality is not needed. This operation will only be called when the relevant PublisherListener is installed and enabled for the OfferedIncompatibleQosStatus. The incompatible Qos status will change when a DataReader object has been discovered by the DataWriter with the same Topic and a requested DataReaderQos that was incompatible with the one offered by the DataWriter. The Data Distribution Service will call the PublisherListener operation with a parameter status, which will contain the OfferedIncompatibleQosStatus object.
| status | Contain the OfferedIncompatibleQosStatus object (this is an input to the application). |
Implements org.omg.dds.pub.PublisherListener.
Definition at line 61 of file DomainParticipantAdapter.java.
| void org.omg.dds.domain.DomainParticipantAdapter.onPublicationMatched | ( | PublicationMatchedEvent<?> | status | ) |
This operation must be implemented by the application and is called by the Data Distribution Service when a new match has been discovered for the current publication, or when an existing match has ceased to exist.
Usually this means that a new DataReader that matches the Topic and that has compatible Qos as the current DataWriter has either been discovered, or that a previously discovered DataReader has ceased to be matched to the current DataWriter. A DataReader may cease to match when it gets deleted, when it changes its Qos to a value that is incompatible with the current DataWriter or when either the DataWriter or the DataReader has chosen to put its matching counterpart on its ignore-list using the ignoreSubcription or ignorePublication operations on the DomainParticipant. The implementation of this Listener operation may be left empty when this functionality is not needed: it will only be called when the relevant PublisherListener is installed and enabled for the org.omg.dds.core.status.PublicationMatchedStatus. The Data Distribution Service will provide a reference to the PublicationMatchedStatus object in the parameter status for use by the application.
| status | Contains the PublicationMatchedStatus object (this is an input to the application provided by the Data Distribution Service). |
Implements org.omg.dds.pub.PublisherListener.
Definition at line 68 of file DomainParticipantAdapter.java.
| void org.omg.dds.domain.DomainParticipantAdapter.onRequestedDeadlineMissed | ( | RequestedDeadlineMissedEvent<?> | status | ) |
This operation is the external operation (interface, which must be implemented by the application) that is called by the Data Distribution Service when the deadline that the DataReader was expecting through its DeadlineQosPolicy was not respected for a specific instance.
The implementation may be left empty when this functionality is not needed. This operation will only be called when the relevant SubscriberListener is installed and enabled for the RequestedDeadlineMissedStatus.
The Data Distribution Service will provide a reference to the RequestedDeadlineMissedStatus object in the parameter status for use by the application.
| status | Contains the RequestedDeadlineMissedStatus object (this is an input to the application). |
Implements org.omg.dds.sub.SubscriberListener.
Definition at line 92 of file DomainParticipantAdapter.java.
| void org.omg.dds.domain.DomainParticipantAdapter.onRequestedIncompatibleQos | ( | RequestedIncompatibleQosEvent<?> | status | ) |
This operation is the external operation (interface, which must be implemented by the application) that is called by the Data Distribution Service when the RequestedIncompatibleQosStatus changes.
The implementation may be left empty when this functionality is not needed. This operation will only be called when the relevant SubscriberListener is installed and enabled for the RequestedIncompatibleQosStatus.
The Data Distribution Service will provide a reference to the RequestedIncompatibleQosStatus object in the parameter status, for use by the application.
The application can use this operation as a callback function implementing a proper response to the status change. This operation is enabled by setting the RequestedIncompatibleQosStatus in the listener status mask
| status | Contains the RequestedIncompatibleQosStatus object (this is an input to the application). |
Implements org.omg.dds.sub.SubscriberListener.
Definition at line 99 of file DomainParticipantAdapter.java.
| void org.omg.dds.domain.DomainParticipantAdapter.onSampleLost | ( | SampleLostEvent<?> | status | ) |
This operation is the external operation (interface, which must be implemented by the application) that is called by the Data Distribution Service when a sample is lost and this is detected.
The implementation may be left empty when this functionality is not needed. This operation will only be called when the relevant SubscriberListener is installed and enabled for the SampleLostStatus.
The Data Distribution Service will provide a reference to the SampleLostStatus object for use by the application.
| status | Contains the SampleLostStatus object (this is an input to the application). |
Implements org.omg.dds.sub.SubscriberListener.
Definition at line 106 of file DomainParticipantAdapter.java.
| void org.omg.dds.domain.DomainParticipantAdapter.onSampleRejected | ( | SampleRejectedEvent<?> | status | ) |
This operation is the external operation (interface, which must be implemented by the application) that is called by the Data Distribution Service when a (received) sample has been rejected.
Samples may be rejected by the DataReader when it runs out of resource_limits to store incoming samples. Usually this means that old samples need to be 'consumed' (for example by 'taking' them instead of 'reading' them) to make room for newly incoming samples.
The implementation may be left empty when this functionality is not needed. This operation will only be called when the relevant SubscriberListener is installed and enabled for the SampleRejectedStatus.
The Data Distribution Service will provide a reference to the SampleRejectedStatus object in the parameter status for use by the application.
| status | Contains the SampleRejectedStatus object (this is an input to the application). |
Implements org.omg.dds.sub.SubscriberListener.
Definition at line 112 of file DomainParticipantAdapter.java.
| void org.omg.dds.domain.DomainParticipantAdapter.onSubscriptionMatched | ( | SubscriptionMatchedEvent<?> | status | ) |
This operation is called by the Data Distribution Service when a new match has been discovered for the current subscription, or when an existing match has ceased to exist.
Usually this means that a new DataWriter that matches the Topic and that has compatible Qos as the current DataReader has either been discovered, or that a previously discovered DataWriter has ceased to be matched to the current DataReader. A DataWriter may cease to match when it gets deleted, when it changes its Qos to a value that is incompatible with the current DataReader or when either the DataReader or the DataWriter has chosen to put its matching counterpart on its ignore-list using the ignoreSubscription or ignorePublication operations.
The implementation of this Listener operation may be left empty when this functionality is not needed: it will only be called when the relevant SubscriberListener is installed and enabled for the SubscriptionMatchedStatus
| status | Contains the SubscriptionMatchedStatus object (this is an input to the application). |
Implements org.omg.dds.sub.SubscriberListener.
Definition at line 118 of file DomainParticipantAdapter.java.
1.8.13