DDS Publisher interface. More...

#include <Publisher.hpp>

Public Member Functions
virtual ReturnCode	set_qos (const PublisherQos &qos) noexcept=0
	Set Publisher QoS. More...

virtual ReturnCode	get_qos (PublisherQos &qos) const noexcept=0
	Get Publisher QoS. More...

virtual PublisherQos	get_qos () const noexcept=0
	Get Publisher QoS by value. More...

virtual ReturnCode	set_listener (PublisherListener *listener, const StatusMask &mask) noexcept=0
	Set Publisher listener. More...

virtual PublisherListener *	get_listener () const noexcept=0
	Get PublisherListener listener. More...

virtual DataWriter *	create_datawriter (Topic &topic, const DataWriterQos &qos, DataWriterListener *listener, const StatusMask &mask) noexcept=0
	Create a DataWriter. More...

virtual ReturnCode	delete_datawriter (DataWriter *datawriter) noexcept=0
	Delete a DataWriter. More...

virtual DataWriter *	lookup_datawriter (const memory::IStringView &topic_name) const noexcept=0
	Get DataWriter. More...

virtual ReturnCode	wait_for_acknowledgments (const execution::TimePeriod &max_wait) const noexcept=0
	Wait for acknowledgements. More...

virtual DomainParticipant &	get_participant () const noexcept=0
	Get Domain Participant. More...

virtual ReturnCode	delete_contained_entities () noexcept=0
	Delete all contained entities. More...

virtual ReturnCode	set_default_datawriter_qos (const DataWriterQos &qos) noexcept=0
	Set default DataWriter QoS. More...

virtual ReturnCode	get_default_datawriter_qos (DataWriterQos &qos) const noexcept=0
	Get default DataWriter QoS. More...

virtual ReturnCode	copy_from_topic_qos (DataWriterQos &qos, const TopicQos &topic_qos) const noexcept=0
	Copy DataWriter QoS from Topic QoS. More...

virtual ReturnCode	suspend_publications () noexcept=0
	Suspend publications. More...

virtual ReturnCode	resume_publications () noexcept=0
	Resume publications. More...

virtual ReturnCode	begin_coherent_changes () noexcept=0
	Begin coherent changes. More...

virtual ReturnCode	end_coherent_changes () noexcept=0
	End coherent changes. 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...

Protected Member Functions
	~Publisher () noexcept=default
	Protected destructor ownership defined on creation. More...

	Publisher () noexcept=default
	Default creation. More...

	Publisher (const Publisher &) noexcept=default
	Copy allowed. More...

	Publisher (Publisher &&) noexcept=default
	Movement allowed. More...

Publisher &	operator= (const Publisher &) noexcept=default
	Copy operator allowed. More...

Publisher &	operator= (Publisher &&) 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...

Detailed Description

DDS Publisher interface.

Constructor & Destructor Documentation

◆ ~Publisher()

eprosima::safedds::dds::Publisher::~Publisher ( )

protecteddefaultnoexcept

Protected destructor ownership defined on creation.

◆ Publisher() [1/3]

eprosima::safedds::dds::Publisher::Publisher ( )

protecteddefaultnoexcept

Default creation.

◆ Publisher() [2/3]

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

protecteddefaultnoexcept

Copy allowed.

◆ Publisher() [3/3]

eprosima::safedds::dds::Publisher::Publisher ( Publisher && )

protecteddefaultnoexcept

Movement allowed.

Member Function Documentation

◆ begin_coherent_changes()

virtual ReturnCode eprosima::safedds::dds::Publisher::begin_coherent_changes ( )

pure virtualnoexcept

Begin coherent changes.

Returns: ReturnCode.

◆ copy_from_topic_qos()

virtual ReturnCode eprosima::safedds::dds::Publisher::copy_from_topic_qos	(	DataWriterQos &	qos,
		const TopicQos &	topic_qos
	)		const

pure virtualnoexcept

Copy DataWriter QoS from Topic QoS.

Parameters

[in,out]	qos	DataWriter QoS.
[in]	topic_qos	Topic QoS.

Returns: ReturnCode.

◆ create_datawriter()

virtual DataWriter* eprosima::safedds::dds::Publisher::create_datawriter	(	Topic &	topic,
		const DataWriterQos &	qos,
		DataWriterListener *	listener,
		const StatusMask &	mask
	)

pure virtualnoexcept

Create a DataWriter.

Parameters

[in]	topic	Topic to be associated with the DataWriter.
[in]	qos	DataWriter QoS.
[in]	listener	DataWriter listener.
[in]	mask	listener configuration.

Returns: DataWriter *.

◆ delete_contained_entities()

virtual ReturnCode eprosima::safedds::dds::Publisher::delete_contained_entities ( )

pure virtualnoexcept

Delete all contained entities.

Returns: ReturnCode.

◆ delete_datawriter()

virtual ReturnCode eprosima::safedds::dds::Publisher::delete_datawriter ( DataWriter * datawriter )

pure virtualnoexcept

Delete a DataWriter.

Parameters

[in] datawriter DataWriter to be deleted.

Returns: ReturnCode.

◆ end_coherent_changes()

virtual ReturnCode eprosima::safedds::dds::Publisher::end_coherent_changes ( )

pure virtualnoexcept

End coherent changes.

Returns: ReturnCode.

◆ get_default_datawriter_qos()

virtual ReturnCode eprosima::safedds::dds::Publisher::get_default_datawriter_qos ( DataWriterQos & qos ) const

pure virtualnoexcept

Get default DataWriter QoS.

Parameters

[out] qos DataWriter QoS.

Returns: ReturnCode.

◆ get_listener()

virtual PublisherListener* eprosima::safedds::dds::Publisher::get_listener ( ) const

pure virtualnoexcept

Get PublisherListener listener.

Returns: PublisherListener *.

◆ get_participant()

virtual DomainParticipant& eprosima::safedds::dds::Publisher::get_participant ( ) const

pure virtualnoexcept

Get Domain Participant.

Returns: DomainParticipant &.

◆ get_qos() [1/2]

virtual PublisherQos eprosima::safedds::dds::Publisher::get_qos ( ) const

pure virtualnoexcept

Get Publisher QoS by value.

Returns: PublisherQos

◆ get_qos() [2/2]

virtual ReturnCode eprosima::safedds::dds::Publisher::get_qos ( PublisherQos & qos ) const

pure virtualnoexcept

Get Publisher QoS.

Parameters

[out] qos Publisher QoS.

Returns: ReturnCode.

◆ lookup_datawriter()

virtual DataWriter* eprosima::safedds::dds::Publisher::lookup_datawriter ( const memory::IStringView & topic_name ) const

pure virtualnoexcept

Get DataWriter.

Parameters

[in] topic_name Topic name to be associated with the DataWriter.

Returns: DataWriter *.

◆ operator=() [1/2]

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

protecteddefaultnoexcept

Copy operator allowed.

Returns: Publisher&.

◆ operator=() [2/2]

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

protecteddefaultnoexcept

Movement operator allowed.

Returns: Publisher&.

◆ resume_publications()

virtual ReturnCode eprosima::safedds::dds::Publisher::resume_publications ( )

pure virtualnoexcept

Resume publications.

Returns: ReturnCode.

◆ set_default_datawriter_qos()

virtual ReturnCode eprosima::safedds::dds::Publisher::set_default_datawriter_qos ( const DataWriterQos & qos )

pure virtualnoexcept

Set default DataWriter QoS.

Parameters

[in] qos DataWriter QoS.

Returns: ReturnCode.

◆ set_listener()

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

pure virtualnoexcept

Set Publisher listener.

Parameters

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

Returns: ReturnCode.

◆ set_qos()

virtual ReturnCode eprosima::safedds::dds::Publisher::set_qos ( const PublisherQos & qos )

pure virtualnoexcept

Set Publisher QoS.

Parameters

[in] qos Publisher QoS.

Returns: ReturnCode.

◆ suspend_publications()

virtual ReturnCode eprosima::safedds::dds::Publisher::suspend_publications ( )

pure virtualnoexcept

Suspend publications.

Returns: ReturnCode.

◆ wait_for_acknowledgments()

virtual ReturnCode eprosima::safedds::dds::Publisher::wait_for_acknowledgments ( const execution::TimePeriod & max_wait ) const

pure virtualnoexcept

Wait for acknowledgements.

Parameters

[in] max_wait Maximum time to wait.

Returns: ReturnCode.

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

build/docs/user_manual/main/tmp/include/safedds/dds/Publisher.hpp

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~Publisher()

◆ Publisher() [1/3]

◆ Publisher() [2/3]

◆ Publisher() [3/3]

Member Function Documentation

◆ begin_coherent_changes()

◆ copy_from_topic_qos()

◆ create_datawriter()

◆ delete_contained_entities()

◆ delete_datawriter()

◆ end_coherent_changes()

◆ get_default_datawriter_qos()

◆ get_listener()

◆ get_participant()

◆ get_qos() [1/2]

◆ get_qos() [2/2]

◆ lookup_datawriter()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ resume_publications()

◆ set_default_datawriter_qos()

◆ set_listener()

◆ set_qos()

◆ suspend_publications()

◆ wait_for_acknowledgments()