AnyTopic proprietary events Listener. More...

#include "ProprietaryApi.hpp"

Inheritance diagram for org::opensplice::topic::AnyTopicListener:

Public Member Functions
virtual void	on_all_data_disposed (dds::topic::AnyTopic &topic, const org::opensplice::core::status::AllDataDisposedTopicStatus &status)=0

virtual void	on_inconsistent_topic (AnyTopic &topic, const dds::core::status::InconsistentTopicStatus &status)=0

Detailed Description

AnyTopic proprietary events Listener.

Because the DomainParticipant does not have knowledge of data types, it has to use non-data-type-listeners. In other words Any* listeners.

This proprietary listener is a child of the specification listener and is made available to be able to trigger the on_all_data_disposed() proprietary event.

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.

This class is used as a base for other listeners and is not used on its own.

See also: org::opensplice::domain::DomainParticipantListener

Definition at line 193 of file ProprietaryApi.hpp.

Member Function Documentation

◆ on_all_data_disposed()

virtual void org::opensplice::topic::AnyTopicListener::on_all_data_disposed	(	dds::topic::AnyTopic &	topic,
		const org::opensplice::core::status::AllDataDisposedTopicStatus &	status
	)

pure virtual

This operation is called by the Data Distribution Service when the AllDataDisposedTopicStatus 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 with the dds::core::status::StatusMask::all_data_disposed_topic(). The AllDataDisposedTopicStatus will change when the node has completed disposal of data as a result of a call to dds::topic::AnyTopic::dispose_all_data().

Parameters

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

◆ on_inconsistent_topic()

virtual void dds::topic::AnyTopicListener::on_inconsistent_topic	(	AnyTopic &	topic,
		const dds::core::status::InconsistentTopicStatus &	status
	)

pure virtualinherited

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 TopicListener is installed and enabled with the StatusMask::inconsistent_topic(). The InconsistentTopicStatus will change when another Topic exists with the same topic_name but different characteristics.

Parameters

topic	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 class was generated from the following file:

include/dcps/C++/isocpp2/dds/core/detail/ProprietaryApi.hpp

Public Member Functions

Detailed Description

Member Function Documentation

◆ on_all_data_disposed()

◆ on_inconsistent_topic()