eprosima::safedds::dds::Topic Interface Reference

DDS Topic interface. More...

#include <Topic.hpp>

Public Member Functions
virtual ReturnCode	set_qos (const TopicQos &qos) noexcept=0
	Set Topic QoS. More...
virtual ReturnCode	get_qos (TopicQos &qos) const noexcept=0
	Get Topic QoS. More...
virtual TopicQos	get_qos () const noexcept=0
	Get Topic QoS by value. More...
virtual ReturnCode	set_listener (TopicListener *listener, const StatusMask &mask) noexcept=0
	Set Topic listener. More...
virtual TopicListener *	get_listener () const noexcept=0
	Set Topic listener. More...
virtual ReturnCode	get_inconsistent_topic_status (InconsistentTopicStatus &status) noexcept=0
	Get Inconsistent Topic Status. More...
Public Member Functions inherited from eprosima::safedds::dds::Entity
virtual ReturnCode	enable () noexcept=0
	Enables the entity. More...
virtual bool	is_enabled () const noexcept=0
	Check if the entity and its hierarchically ascending entities are enabled. More...
virtual StatusCondition *	get_statuscondition () &noexcept=0
	Retrieves entity status condition. Can only be used on lvalue objects. More...
virtual StatusMask	get_status_changes () const noexcept=0
	Retrieves the set of triggered statuses in the Entity. More...
virtual InstanceHandle	get_instance_handle () const noexcept=0
	Retrieves the instance handler that represents the Entity. More...
execution::ISpinnable *	get_spinnable () &&noexcept=delete
	Deletes get_spinnable for rvalue objects to avoid usage of a dangling pointer (Helix Rule-6.4.2) More...
virtual execution::ISpinnable *	get_spinnable () &noexcept=0
	Retrieves the spinnable interface of the entity in case it has one, otherwise returns nullptr. More...
Public Member Functions inherited from eprosima::safedds::dds::TopicDescription
virtual DomainParticipant &	get_participant () const noexcept=0
	Get the DomainParticipant to which the TopicDescription belongs. More...
virtual const memory::IStringView &	get_name () const noexcept=0
	Get the name used to create this TopicDescription. More...
virtual const memory::IStringView &	get_type_name () const noexcept=0
	Get the associated type name. More...

Protected Member Functions
	~Topic () noexcept=default
	Protected destructor ownership defined on creation. More...
	Topic () noexcept=default
	Default creation. More...
	Topic (const Topic &) noexcept=default
	Copy allowed. More...
	Topic (Topic &&) noexcept=default
	Movement allowed. More...
Topic &	operator= (const Topic &) noexcept=default
	Copy operator allowed. More...
Topic &	operator= (Topic &&) noexcept=default
	Movement operator allowed. More...
Protected Member Functions inherited from eprosima::safedds::dds::Entity
	~Entity () noexcept=default
	Protected destructor ownership defined on creation. More...
	Entity () noexcept=default
	Default creation. More...
	Entity (const Entity &) noexcept=default
	Copy allowed. More...
	Entity (Entity &&) noexcept=default
	Movement allowed. More...
Entity &	operator= (const Entity &) noexcept=default
	Copy operator allowed. More...
Entity &	operator= (Entity &&) noexcept=default
	Movement operator allowed. More...
Protected Member Functions inherited from eprosima::safedds::dds::TopicDescription
	~TopicDescription () noexcept=default
	Protected destructor ownership defined on creation. More...
	TopicDescription () noexcept=default
	Default creation. More...
	TopicDescription (const TopicDescription &) noexcept=default
	Copy allowed. More...
	TopicDescription (TopicDescription &&) noexcept=default
	Movement allowed. More...
TopicDescription &	operator= (const TopicDescription &) noexcept=default
	Copy operator allowed. More...
TopicDescription &	operator= (TopicDescription &&) noexcept=default
	Movement operator allowed. More...

Detailed Description

DDS Topic interface.

Constructor & Destructor Documentation

~Topic()

eprosima::safedds::dds::Topic::~Topic ( )

protecteddefaultnoexcept

Protected destructor ownership defined on creation.

Topic() [1/3]

eprosima::safedds::dds::Topic::Topic ( )

protecteddefaultnoexcept

Default creation.

Topic() [2/3]

eprosima::safedds::dds::Topic::Topic ( const Topic &  )

protecteddefaultnoexcept

Copy allowed.

Topic() [3/3]

eprosima::safedds::dds::Topic::Topic ( Topic &&  )

protecteddefaultnoexcept

Movement allowed.

Member Function Documentation

get_inconsistent_topic_status()

virtual ReturnCode eprosima::safedds::dds::Topic::get_inconsistent_topic_status ( InconsistentTopicStatus &  status )

pure virtualnoexcept

Get Inconsistent Topic Status.

Parameters

[out]

status

Inconsistent Topic Status.

Returns

ReturnCode.

get_listener()

virtual TopicListener* eprosima::safedds::dds::Topic::get_listener ( ) const

pure virtualnoexcept

Set Topic listener.

Returns

TopicListener*.

get_qos() [1/2]

virtual TopicQos eprosima::safedds::dds::Topic::get_qos ( ) const

pure virtualnoexcept

Get Topic QoS by value.

Returns

TopicQos.

get_qos() [2/2]

virtual ReturnCode eprosima::safedds::dds::Topic::get_qos ( TopicQos &  qos ) const

pure virtualnoexcept

Get Topic QoS.

Parameters

[out]

qos

topic QoS.

Returns

ReturnCode.

operator=() [1/2]

Topic& eprosima::safedds::dds::Topic::operator= ( const Topic &  )

protecteddefaultnoexcept

Copy operator allowed.

Returns

Topic&.

operator=() [2/2]

Topic& eprosima::safedds::dds::Topic::operator= ( Topic &&  )

protecteddefaultnoexcept

Movement operator allowed.

Returns

Topic&.

set_listener()

virtual ReturnCode eprosima::safedds::dds::Topic::set_listener ( TopicListener *  listener, const StatusMask &  mask  )

pure virtualnoexcept

Set Topic listener.

Parameters

[in,out]	listener	topic listener.
[in]	mask	listener configuration.

Returns

ReturnCode.

set_qos()

virtual ReturnCode eprosima::safedds::dds::Topic::set_qos ( const TopicQos &  qos )

pure virtualnoexcept

Set Topic QoS.

Parameters

[in]

qos

topic QoS.

Returns

ReturnCode.

---

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

• build/docs/user_manual/main/tmp/include/safedds/dds/Topic.hpp