DDS DataWriter interface. More...

#include <DataWriter.hpp>

Public Member Functions
virtual protocol::GUID	guid () const noexcept=0
	Retrieves the DataWriter GUID. More...

virtual dds::ReturnCode	set_qos (const DataWriterQos &qos) noexcept=0
	Set DataWriter QoS. More...

virtual dds::ReturnCode	get_qos (DataWriterQos &qos) const noexcept=0
	Get DataWriter QoS. More...

virtual DataWriterQos	get_qos () const noexcept=0
	Get DataWriter QoS by value. More...

virtual dds::ReturnCode	set_listener (DataWriterListener *listener, const StatusMask &mask) noexcept=0
	Set DataWriter listener. More...

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

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

virtual dds::ReturnCode	get_liveliness_lost_status (LivelinessLostStatus &status) noexcept=0
	Get Liveliness Lost Status. More...

virtual dds::ReturnCode	get_offered_deadline_missed_status (OfferedDeadlineMissedStatus &status) noexcept=0
	Get Offered Deadline Missed Status. More...

virtual dds::ReturnCode	get_offered_incompatible_qos_status (OfferedIncompatibleQosStatus &status) noexcept=0
	Get offered incompatibility status. More...

virtual dds::ReturnCode	get_publication_matched_status (PublicationMatchedStatus &status) noexcept=0
	Get Publication Matched Status. More...

virtual Topic &	get_topic () const noexcept=0
	Get topic. More...

virtual Publisher &	get_publisher () const noexcept=0
	Get publisher. More...

virtual dds::ReturnCode	assert_liveliness () noexcept=0
	Assert liveliness. More...

virtual dds::ReturnCode	get_matched_subscription_data (SubscriptionBuiltinTopicData &subscription_data, const InstanceHandle &subscription_handle) const noexcept=0
	Retrieves in a subscription associated with the DataWriter. More...

virtual dds::ReturnCode	get_matched_subscriptions (memory::IList< InstanceHandle > &subscription_handles) const noexcept=0
	Fills a vector with the InstanceHandles of the matched subscriptions. 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...

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

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

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

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

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

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

Note: typed methods are implemented on TypedDataWriter.

Constructor & Destructor Documentation

◆ ~DataWriter()

eprosima::safedds::dds::DataWriter::~DataWriter ( )

protecteddefaultnoexcept

Protected destructor ownership defined on creation.

◆ DataWriter() [1/3]

eprosima::safedds::dds::DataWriter::DataWriter ( )

protecteddefaultnoexcept

Default creation.

◆ DataWriter() [2/3]

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

protecteddefaultnoexcept

Copy allowed.

◆ DataWriter() [3/3]

eprosima::safedds::dds::DataWriter::DataWriter ( DataWriter && )

protecteddefaultnoexcept

Movement allowed.

Member Function Documentation

◆ assert_liveliness()

virtual dds::ReturnCode eprosima::safedds::dds::DataWriter::assert_liveliness ( )

pure virtualnoexcept

Assert liveliness.

Returns: ReturnCode.

◆ get_listener()

virtual DataWriterListener* eprosima::safedds::dds::DataWriter::get_listener ( ) const

pure virtualnoexcept

Get DataWriterListener listener.

Returns: DataWriterListener *.

◆ get_liveliness_lost_status()

virtual dds::ReturnCode eprosima::safedds::dds::DataWriter::get_liveliness_lost_status ( LivelinessLostStatus & status )

pure virtualnoexcept

Get Liveliness Lost Status.

Parameters

[out] status Liveliness Lost Status.

Returns: ReturnCode.

◆ get_matched_subscription_data()

virtual dds::ReturnCode eprosima::safedds::dds::DataWriter::get_matched_subscription_data	(	SubscriptionBuiltinTopicData &	subscription_data,
		const InstanceHandle &	subscription_handle
	)		const

pure virtualnoexcept

Retrieves in a subscription associated with the DataWriter.

Parameters

[out]	subscription_data	subscription data struct
	subscription_handle	InstanceHandle_t of the subscription

Returns: dds::ReturnCode

◆ get_matched_subscriptions()

virtual dds::ReturnCode eprosima::safedds::dds::DataWriter::get_matched_subscriptions ( memory::IList< InstanceHandle > & subscription_handles ) const

pure virtualnoexcept

Fills a vector with the InstanceHandles of the matched subscriptions.

Parameters

[out] subscription_handles Vector to be filled with the InstanceHandles of the matched subscriptions.

Returns: ReturnCode.

◆ get_offered_deadline_missed_status()

virtual dds::ReturnCode eprosima::safedds::dds::DataWriter::get_offered_deadline_missed_status ( OfferedDeadlineMissedStatus & status )

pure virtualnoexcept

Get Offered Deadline Missed Status.

Parameters

[out] status Offered Deadline Missed Status.

Returns: ReturnCode.

◆ get_offered_incompatible_qos_status()

virtual dds::ReturnCode eprosima::safedds::dds::DataWriter::get_offered_incompatible_qos_status ( OfferedIncompatibleQosStatus & status )

pure virtualnoexcept

Get offered incompatibility status.

Parameters

[out] status offered incompatibility status.

Returns: ReturnCode.

◆ get_publication_matched_status()

virtual dds::ReturnCode eprosima::safedds::dds::DataWriter::get_publication_matched_status ( PublicationMatchedStatus & status )

pure virtualnoexcept

Get Publication Matched Status.

Parameters

[out] status Publication Matched Status.

Returns: ReturnCode.

◆ get_publisher()

virtual Publisher& eprosima::safedds::dds::DataWriter::get_publisher ( ) const

pure virtualnoexcept

Get publisher.

Returns: Publisher.

◆ get_qos() [1/2]

virtual DataWriterQos eprosima::safedds::dds::DataWriter::get_qos ( ) const

pure virtualnoexcept

Get DataWriter QoS by value.

Returns: DataWriterQos

◆ get_qos() [2/2]

virtual dds::ReturnCode eprosima::safedds::dds::DataWriter::get_qos ( DataWriterQos & qos ) const

pure virtualnoexcept

Get DataWriter QoS.

Parameters

[out] qos DataWriter QoS.

Returns: ReturnCode.

◆ get_topic()

virtual Topic& eprosima::safedds::dds::DataWriter::get_topic ( ) const

pure virtualnoexcept

Get topic.

Returns: Topic.

◆ guid()

virtual protocol::GUID eprosima::safedds::dds::DataWriter::guid ( ) const

pure virtualnoexcept

Retrieves the DataWriter GUID.

Returns: GUID.

◆ operator=() [1/2]

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

protecteddefaultnoexcept

Copy operator allowed.

Returns: DataWriter&.

◆ operator=() [2/2]

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

protecteddefaultnoexcept

Movement operator allowed.

Returns: DataWriter&.

◆ set_listener()

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

pure virtualnoexcept

Set DataWriter listener.

Parameters

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

Returns: ReturnCode.

◆ set_qos()

virtual dds::ReturnCode eprosima::safedds::dds::DataWriter::set_qos ( const DataWriterQos & qos )

pure virtualnoexcept

Set DataWriter QoS.

Parameters

[in] qos DataWriter QoS.

Returns: ReturnCode.

◆ wait_for_acknowledgments()

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

pure virtualnoexcept

Wait for acknowledgement.

Parameters

[in] max_wait maximum wait time.

Note: This method will return always OK when Writer is Best Effort.; When used on a Reliable Writer, max_wait shall be zero.

Returns: ReturnCode.

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

build/docs/user_manual/v3.0.0/tmp/include/safedds/dds/DataWriter.hpp

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~DataWriter()

◆ DataWriter() [1/3]

◆ DataWriter() [2/3]

◆ DataWriter() [3/3]

Member Function Documentation

◆ assert_liveliness()

◆ get_listener()

◆ get_liveliness_lost_status()

◆ get_matched_subscription_data()

◆ get_matched_subscriptions()

◆ get_offered_deadline_missed_status()

◆ get_offered_incompatible_qos_status()

◆ get_publication_matched_status()

◆ get_publisher()

◆ get_qos() [1/2]

◆ get_qos() [2/2]

◆ get_topic()

◆ guid()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ set_listener()

◆ set_qos()

◆ wait_for_acknowledgments()