OpenSplice C# API  v6.x
OpenSplice C# Data Distribution Service Data-Centric Publish-Subscribe API
DDS.IDomainParticipantListener Interface Reference

Since a DomainParticipant is an Entity, it has the ability to have a Listener associated with it. In this case, the associated Listener should be of type IDomainParticipantListener. This interface must be implemented by the application. A user-defined class must be provided by the application which must extend from the IDomainParticipantListener class. All operations for this interface must be implemented in the user-defined class, it is up to the application whether an operation is empty or contains some functionality. The IDomainParticipantListener provides a generic mechanism (actually a callback function) for the Data Distribution Service to notify the application of relevant asynchronous status change events, such as a missed deadline, violation of QosPolicy setting, etc. The IDomainParticipantListener is related to changes in communication status StatusConditions. More...

Inheritance diagram for DDS.IDomainParticipantListener:
Inheritance graph
Collaboration diagram for DDS.IDomainParticipantListener:
Collaboration graph

Additional Inherited Members

- Public Member Functions inherited from DDS.ITopicListener
void OnInconsistentTopic (ITopic entityInterface, InconsistentTopicStatus status)
 This operation is called by the Data Distribution Service when the InconsistentTopicStatus changes. More...
 
- Public Member Functions inherited from DDS.IDataWriterListener
void OnLivelinessLost (IDataWriter entityInterface, LivelinessLostStatus status)
 This operation is called by the Data Distribution Service when the LivelinessLostStatus changes. More...
 
void OnOfferedDeadlineMissed (IDataWriter entityInterface, OfferedDeadlineMissedStatus status)
 This operation is called by the Data Distribution Service when the OfferedDeadlineMissedStatus changes. More...
 
void OnOfferedIncompatibleQos (IDataWriter entityInterface, OfferedIncompatibleQosStatus status)
 This operation called by the Data Distribution Service when the OfferedIncompatibleQosStatus changes. More...
 
void OnPublicationMatched (IDataWriter entityInterface, PublicationMatchedStatus status)
 This operation 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...
 
- Public Member Functions inherited from DDS.ISubscriberListener
void OnDataOnReaders (ISubscriber entityInterface)
 This operation called by the Data Distribution Service when new data is available for this Subscriber. More...
 
- Public Member Functions inherited from DDS.IDataReaderListener
void OnDataAvailable (IDataReader entityInterface)
 This operation is called by the Data Distribution Service when new data is available for this IDataReader. More...
 
void OnLivelinessChanged (IDataReader entityInterface, LivelinessChangedStatus status)
 This operation is called by the Data Distribution Service when the liveliness of one or more IDataWriter objects that were writing instances read through this IDataReader has changed. More...
 
void OnRequestedDeadlineMissed (IDataReader entityInterface, RequestedDeadlineMissedStatus status)
 This operation called by the Data Distribution Service when the deadline that the IDataReader was expecting through its DeadlineQosPolicy was not respected for a specific instance. More...
 
void OnRequestedIncompatibleQos (IDataReader entityInterface, RequestedIncompatibleQosStatus status)
 This operation is called by the Data Distribution Service when the DDS.StatusKind.RequestedIncompatibleQos changes. More...
 
void OnSampleLost (IDataReader entityInterface, SampleLostStatus status)
 NOTE: This operation is not yet implemented. It is scheduled for a future release. More...
 
void OnSampleRejected (IDataReader entityInterface, SampleRejectedStatus status)
 This operation called by the Data Distribution Service when a (received) sample has been rejected. More...
 
void OnSubscriptionMatched (IDataReader entityInterface, SubscriptionMatchedStatus 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...
 

Detailed Description

Since a DomainParticipant is an Entity, it has the ability to have a Listener associated with it. In this case, the associated Listener should be of type IDomainParticipantListener. This interface must be implemented by the application. A user-defined class must be provided by the application which must extend from the IDomainParticipantListener class. All operations for this interface must be implemented in the user-defined class, it is up to the application whether an operation is empty or contains some functionality. The IDomainParticipantListener provides a generic mechanism (actually a callback function) for the Data Distribution Service to notify the application of relevant asynchronous status change events, such as a missed deadline, violation of QosPolicy setting, etc. The IDomainParticipantListener is related to changes in communication status StatusConditions.

public class MyExampleParticipantListener : DDS.IDomainParticipantListener
{
public MyExampleParticipantListener()
{
}
public void OnDataAvailable(DDS.IDataReader reader)
{
Console.WriteLine("OnDataAvailable");
}
{
Console.WriteLine("OnInconsistentTopic");
}
}

Definition at line 6361 of file DdsDcpsInterfaces.cs.


The documentation for this interface was generated from the following file: