Click or drag to resize

DomainParticipantListener Class

Abstract class that can be implemented by an application-provided class and then registered with the DomainParticipant such that the application can be notified of relevant status changes.
Inheritance Hierarchy
SystemObject
  OpenDDSharp.OpenDDS.DCPSDomainParticipantListener

Namespace:  OpenDDSharp.OpenDDS.DCPS
Assembly:  OpenDDSharp (in OpenDDSharp.dll) Version: 0.4.1.0
Syntax
public abstract class DomainParticipantListener

The DomainParticipantListener type exposes the following members.

Constructors
  NameDescription
Public methodDomainParticipantListener
Creates a new instance of DomainParticipantListener
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodOnConnectionDeleted(DataReader)
Called when the connection object is cleaned up and the reconnect thread exits.
Public methodOnConnectionDeleted(DataWriter)
Called when the publication connection object is cleaned up and the reconnect thread exits.
Public methodOnDataAvailable

Handles the DataAvailableStatus communication status.

The DataAvailableStatus indicates that samples are available on the DataReader. Applications receiving this status can use the various take and read operations on the DataReader to retrieve the data.

Public methodOnDataOnReaders

Handles the DataOnReadersStatus communication status.

The DataOnReadersStatus indicates that new data is available on some of the data readers associated with the subscriber. Applications receiving this status can call GetDataReaders on the subscriber to get the set of data readers with data available.

Public methodOnInconsistentTopic

Handles the InconsistentTopicStatus communication status.

The InconsistentTopicStatus indicates that a Topic was attempted to be registered that already exists with different characteristics. Typically, the existing Topic may have a different type associated with it.

Public methodOnLivelinessChanged

Handles the LivelinessChangedStatus communication status.

The LivelinessChangedStatus indicates that there have been liveliness changes for one or more DataWriters that are publishing instances for this DataReader.

Public methodOnLivelinessLost

Handles the LivelinessLostStatus communication status.

The LivelinessLostStatus indicates that the liveliness that the DataWriter committed through its Liveliness QoS has not been respected. This means that any connected DataReaders will consider this DataWriter no longer active

Public methodOnOfferedDeadlineMissed

Handles the OfferedDeadlineMissedStatus communication status.

The OfferedDeadlineMissedStatus indicates that the deadline offered by the DataWriter has been missed for one or more instances.

Public methodOnOfferedIncompatibleQos

Handles the OfferedIncompatibleQosStatus communication status.

The OfferedIncompatibleQosStatus indicates that an offered QoS was incompatible with the requested QoS of a DataReader.

Public methodOnPublicationMatched

Handles the PublicationMatchedStatus communication status.

The PublicationMatchedStatus indicates that the liveliness that the DataWriter committed through its Liveliness QoS has not been respected. This means that any connected DataReaders will consider this DataWriter no longer active.

Public methodOnRequestedDeadlineMissed

Handles the RequestedDeadlineMissedStatus communication status.

The RequestedDeadlineMissedStatus indicates that the deadline requested via the DeadlineQosPolicy was not respected for a specific instance.

Public methodOnRequestedIncompatibleQos

Handles the RequestedIncompatibleQosStatus communication status.

The RequestedIncompatibleQosStatus indicates that one or more QoS policy values that were requested were incompatible with what was offered.

Public methodOnSampleLost

Handles the SampleLostStatus communication status.

The SampleLostStatus indicates that a sample has been lost and never received by the DataReader.

Public methodOnSampleRejected

Handles the SampleRejectedStatus communication status.

The SampleRejectedStatus indicates that a sample received by the DataReader has been rejected.

Public methodOnSubscriptionMatched

Handles the SubscriptionMatchedStatus communication status.

The SubscriptionMatchedStatus indicates that either a compatible DataWriter has been matched or a previously matched DataWriter has ceased to be matched.

Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Remarks
The purpose of the DomainParticipantListener is to be the listener of last resort that is notified of all status changes not captured by more specific listeners attached to the Entity objects.When a relevant status change occurs, DDS will first attempt to notify the listener attached to the concerned Entity if one is installed. Otherwise, DDS will notify the Listener attached to the DomainParticipant.
See Also