Class astutedds::dcps::Topic

ClassList > astutedds > dcps > Topic

Represents a typed data stream within a domain.

• #include <dcps.hpp>

Inherits the following classes: astutedds::dcps::TopicDescription

Public Functions

Type	Name
	Topic (const std::string & name, const std::string & type_name, DomainParticipant * participant)
ReturnCode_t	enable () noexcept Enable this Topic . §2.2.2.1.1.7. Idempotent.
InstanceHandle_t	get_instance_handle () noexcept const §2.2.2.1.1.8 — unique per-process handle assigned at construction.
virtual const char *	get_name () override const Return the topic name (C-string, zero-copy)
const TopicQos &	get_qos () const
StatusMask	get_status_changes () noexcept const
EntityStatusCondition *	get_statuscondition () noexcept §2.2.2.1.1.5 — shared StatusCondition for use with a WaitSet.
virtual const char *	get_type_name () override const Return the registered type name (C-string, zero-copy)
bool	is_enabled () noexcept const
const std::string &	name () const
DomainParticipant *	participant () const
void	set_qos (const TopicQos & qos)
const std::string &	type_name () const
	~Topic () override

Public Functions inherited from astutedds::dcps::TopicDescription

See astutedds::dcps::TopicDescription

Type	Name
virtual const char *	get_name () const = 0 Return the topic name (C-string, zero-copy)
virtual const char *	get_type_name () const = 0 Return the registered type name (C-string, zero-copy)
virtual	~TopicDescription () = default

Public Functions Documentation

function Topic

astutedds::dcps::Topic::Topic (
    const std::string & name,
    const std::string & type_name,
    DomainParticipant * participant
) 

---

function enable

Enable this Topic . §2.2.2.1.1.7. Idempotent.

inline ReturnCode_t astutedds::dcps::Topic::enable () noexcept

---

function get_instance_handle

§2.2.2.1.1.8 — unique per-process handle assigned at construction.

inline InstanceHandle_t astutedds::dcps::Topic::get_instance_handle () noexcept const

---

function get_name

Return the topic name (C-string, zero-copy)

inline virtual const char * astutedds::dcps::Topic::get_name () override const

Implements astutedds::dcps::TopicDescription::get_name

---

function get_qos

inline const TopicQos & astutedds::dcps::Topic::get_qos () const

---

function get_status_changes

inline StatusMask astutedds::dcps::Topic::get_status_changes () noexcept const

§2.2.2.1.1.6 — bitmask of statuses that have changed since the last read. Topic currently exposes only INCONSISTENT_TOPIC.

---

function get_statuscondition

§2.2.2.1.1.5 — shared StatusCondition for use with a WaitSet.

inline EntityStatusCondition * astutedds::dcps::Topic::get_statuscondition () noexcept

---

function get_type_name

Return the registered type name (C-string, zero-copy)

inline virtual const char * astutedds::dcps::Topic::get_type_name () override const

Implements astutedds::dcps::TopicDescription::get_type_name

---

function is_enabled

inline bool astutedds::dcps::Topic::is_enabled () noexcept const

---

function name

inline const std::string & astutedds::dcps::Topic::name () const

---

function participant

inline DomainParticipant * astutedds::dcps::Topic::participant () const

---

function set_qos

inline void astutedds::dcps::Topic::set_qos (
    const TopicQos & qos
) 

---

function type_name

inline const std::string & astutedds::dcps::Topic::type_name () const

---

function ~Topic

astutedds::dcps::Topic::~Topic () override

---

---

The documentation for this class was generated from the following file include/astutedds/dcps/dcps.hpp