DDS.ITopicListener Interface Reference

Since a ITopic is an Entity, it has the ability to have a IListener associated with it. In this case, the associated IListener should be of type ITopicListener. This interface must be implemented by the application. A user-defined class must be provided by the application which must extend from the ITopicListener 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 ITopicListener 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 a QosPolicy setting, etc. The ITopicListener is related to changes in communication status StatusConditions. More...

Inheritance diagram for DDS.ITopicListener:

Collaboration diagram for DDS.ITopicListener:

Public Member Functions
void	OnInconsistentTopic (ITopic entityInterface, InconsistentTopicStatus status)
	This operation is called by the Data Distribution Service when the InconsistentTopicStatus changes. More...

Detailed Description

Since a ITopic is an Entity, it has the ability to have a IListener associated with it. In this case, the associated IListener should be of type ITopicListener. This interface must be implemented by the application. A user-defined class must be provided by the application which must extend from the ITopicListener 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 ITopicListener 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 a QosPolicy setting, etc. The ITopicListener is related to changes in communication status StatusConditions.

public class MyExampleTopicListener : DDS.TopicListener
{
    public void OnInconsistentTopic(DDS.ITopic the_topic, DDS.InconsistentTopicStatus status)
    {
            Console.WriteLine("On_inconsistent_topic");
    }
}

Definition at line 5946 of file DdsDcpsInterfaces.cs.

Member Function Documentation

OnInconsistentTopic()

void DDS.ITopicListener.OnInconsistentTopic	(	ITopic	entityInterface,
		InconsistentTopicStatus	status
	)

This operation is called by the Data Distribution Service when the InconsistentTopicStatus changes.

The implementation may be left empty when this functionality is not needed. This operation will only be called when the relevant ITopicListener is installed and enabled with the DDS.StatusKind.InconsistentTopic. The InconsistentTopicStatus will change when another Topic exists with the same topic_name but different characteristics.

Parameters

entityInterface	contain a pointer to the Topic on which the conflict occurred (this is an input to the application).
status	contain the InconsistentTopicStatus object (this is an input to the application).

---

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

• src/api/dcps/sacs/code/DDS/DdsDcpsInterfaces.cs