DDS DataReader interface. More...

#include <DataReader.hpp>

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

virtual ReturnCode	set_qos (const DataReaderQos &qos) noexcept=0
	Set DataReader QoS. More...

virtual ReturnCode	get_qos (DataReaderQos &qos) const noexcept=0
	Get DataReader QoS. More...

virtual DataReaderQos	get_qos () const noexcept=0
	Get DataReader QoS by value. More...

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

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

virtual ReturnCode	get_liveliness_changed_status (LivelinessChangedStatus &status) noexcept=0
	Get the Liveliness Changed Status. More...

virtual ReturnCode	get_requested_deadline_missed_status (RequestedDeadlineMissedStatus &status) noexcept=0
	Get the Requested Deadline Missed Status. More...

virtual ReturnCode	get_requested_incompatible_qos_status (RequestedIncompatibleQosStatus &status) noexcept=0
	Get the Requested Incompatible QoS Status. More...

virtual ReturnCode	get_sample_lost_status (SampleLostStatus &status) noexcept=0
	Get the SAMPLE_LOST communication status. More...

virtual ReturnCode	get_sample_rejected_status (SampleRejectedStatus &status) noexcept=0
	Get the SAMPLE_REJECTED communication status. More...

virtual ReturnCode	get_subscription_matched_status (SubscriptionMatchedStatus &status) noexcept=0
	Get the Subscription Matched Status. More...

virtual const TopicDescription &	get_topicdescription () const noexcept=0
	Get the topic description. More...

virtual const Subscriber &	get_subscriber () const noexcept=0
	Get the subscriber. More...

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

virtual ReturnCode	wait_for_historical_data (const execution::TimePeriod &timeout) noexcept=0
	Method to block the current thread until an unread message is available. More...

virtual ReturnCode	get_matched_publication_data (PublicationBuiltinTopicData &publication_data, InstanceHandle publication_handle) const noexcept=0
	Retrieves in a publication associated with the DataWriter. More...

virtual ReturnCode	get_matched_publications (memory::IList< InstanceHandle > &publication_handles) const noexcept=0
	Fills a vector with the InstanceHandles of the matched publications. More...

virtual ReadCondition *	create_readcondition (const SampleStateMask &sample_states, const ViewStateMask &view_states, const InstanceStateMask &instance_states) noexcept=0
	This operation creates a ReadCondition. More...

virtual QueryCondition *	create_querycondition (const SampleStateMask &sample_states, const ViewStateMask &view_states, const InstanceStateMask &instance_states, const memory::IStringView &query_expression, const memory::IStringViewSequence &query_parameters) noexcept=0
	This operation creates a QueryCondition. More...

virtual ReturnCode	delete_readcondition (ReadCondition &condition) noexcept=0
	This operation deletes a ReadCondition attached to the DataReader. More...

virtual ReturnCode	take_next_sample_buffer (memory::IConstMutableByteArrayView &data_view, protocol::PayloadKind &payload_kind, dds::InlineQoS &inline_qos, dds::SampleInfo &info) noexcept=0
	This operation returns a memory view of the next, non-previously accessed Data value from the DataReader and removes it from the DataReader instance handler so it is no longer accessible. The operation also copies the corresponding SampleInfo and InlineQoS. More...

virtual ReturnCode	release_sample_buffer (const memory::IConstMutableByteArrayView &data_view, const dds::SampleInfo &info) noexcept=0
	This operation releases a memory view of a Data sample previously returned by take_next_sample_buffer. 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
	~DataReader () noexcept=default
	Protected destructor ownership defined on creation. More...

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

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

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

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

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

Note: typed methods are implemented on TypedDataReader.

Constructor & Destructor Documentation

◆ ~DataReader()

eprosima::safedds::dds::DataReader::~DataReader ( )

protecteddefaultnoexcept

Protected destructor ownership defined on creation.

◆ DataReader() [1/3]

eprosima::safedds::dds::DataReader::DataReader ( )

protecteddefaultnoexcept

Default creation.

◆ DataReader() [2/3]

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

protecteddefaultnoexcept

Copy allowed.

◆ DataReader() [3/3]

eprosima::safedds::dds::DataReader::DataReader ( DataReader && )

protecteddefaultnoexcept

Movement allowed.

Member Function Documentation

◆ create_querycondition()

virtual QueryCondition* eprosima::safedds::dds::DataReader::create_querycondition	(	const SampleStateMask &	sample_states,
		const ViewStateMask &	view_states,
		const InstanceStateMask &	instance_states,
		const memory::IStringView &	query_expression,
		const memory::IStringViewSequence &	query_parameters
	)

pure virtualnoexcept

This operation creates a QueryCondition.

Parameters

[in]	sample_states	List of SampleStateKind values to be taken into account.
[in]	view_states	List of ViewStateKind values to be taken into account.
[in]	instance_states	List of InstanceStateKind values to be taken into account.
[in]	query_expression	Query parameters.
[in]	query_parameters	Query parameters.

Returns: ReturnCode.

◆ create_readcondition()

virtual ReadCondition* eprosima::safedds::dds::DataReader::create_readcondition	(	const SampleStateMask &	sample_states,
		const ViewStateMask &	view_states,
		const InstanceStateMask &	instance_states
	)

pure virtualnoexcept

This operation creates a ReadCondition.

Parameters

[in]	sample_states	List of SampleStateKind values to be taken into account.
[in]	view_states	List of ViewStateKind values to be taken into account.
[in]	instance_states	List of InstanceStateKind values to be taken into account.

Returns: ReturnCode.

◆ delete_contained_entities()

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

pure virtualnoexcept

Delete contained entities.

Returns: ReturnCode.

◆ delete_readcondition()

virtual ReturnCode eprosima::safedds::dds::DataReader::delete_readcondition ( ReadCondition & condition )

pure virtualnoexcept

This operation deletes a ReadCondition attached to the DataReader.

Parameters

[in] condition ReadCondition to be deleted.

Returns: ReturnCode.

◆ get_listener()

virtual DataReaderListener* eprosima::safedds::dds::DataReader::get_listener ( ) const

pure virtualnoexcept

Get DataWriterListener listener.

Returns: DataWriterListener *.

◆ get_liveliness_changed_status()

virtual ReturnCode eprosima::safedds::dds::DataReader::get_liveliness_changed_status ( LivelinessChangedStatus & status )

pure virtualnoexcept

Get the Liveliness Changed Status.

Parameters

[out] status LivelinessChangedStatus object where the status is returned.

Returns: ReturnCode

◆ get_matched_publication_data()

virtual ReturnCode eprosima::safedds::dds::DataReader::get_matched_publication_data	(	PublicationBuiltinTopicData &	publication_data,
		InstanceHandle	publication_handle
	)		const

pure virtualnoexcept

Retrieves in a publication associated with the DataWriter.

Parameters

[out]	publication_data	publication data struct
	publication_handle	InstanceHandle_t of the publication

Returns: ReturnCode.

◆ get_matched_publications()

virtual ReturnCode eprosima::safedds::dds::DataReader::get_matched_publications ( memory::IList< InstanceHandle > & publication_handles ) const

pure virtualnoexcept

Fills a vector with the InstanceHandles of the matched publications.

Parameters

[out] publication_handles Vector to be filled with the InstanceHandles of the matched publications.

Returns: ReturnCode.

◆ get_qos() [1/2]

virtual DataReaderQos eprosima::safedds::dds::DataReader::get_qos ( ) const

pure virtualnoexcept

Get DataReader QoS by value.

Returns: DataReaderQos

◆ get_qos() [2/2]

virtual ReturnCode eprosima::safedds::dds::DataReader::get_qos ( DataReaderQos & qos ) const

pure virtualnoexcept

Get DataReader QoS.

Parameters

[out] qos DataReader QoS.

Returns: ReturnCode.

◆ get_requested_deadline_missed_status()

virtual ReturnCode eprosima::safedds::dds::DataReader::get_requested_deadline_missed_status ( RequestedDeadlineMissedStatus & status )

pure virtualnoexcept

Get the Requested Deadline Missed Status.

Parameters

[out] status RequestedDeadlineMissedStatus object where the status is returned.

Returns: ReturnCode

◆ get_requested_incompatible_qos_status()

virtual ReturnCode eprosima::safedds::dds::DataReader::get_requested_incompatible_qos_status ( RequestedIncompatibleQosStatus & status )

pure virtualnoexcept

Get the Requested Incompatible QoS Status.

Parameters

[out] status RequestedIncompatibleQosStatus object where the status is returned.

Returns: ReturnCode

◆ get_sample_lost_status()

virtual ReturnCode eprosima::safedds::dds::DataReader::get_sample_lost_status ( SampleLostStatus & status )

pure virtualnoexcept

Get the SAMPLE_LOST communication status.

Parameters

[out] status SampleLostStatus object where the status is returned.

Returns: ReturnCode

◆ get_sample_rejected_status()

virtual ReturnCode eprosima::safedds::dds::DataReader::get_sample_rejected_status ( SampleRejectedStatus & status )

pure virtualnoexcept

Get the SAMPLE_REJECTED communication status.

Parameters

[out] status SampleRejectedStatus object where the status is returned.

Returns: ReturnCode

◆ get_subscriber()

virtual const Subscriber& eprosima::safedds::dds::DataReader::get_subscriber ( ) const

pure virtualnoexcept

Get the subscriber.

Returns: Subscriber.

◆ get_subscription_matched_status()

virtual ReturnCode eprosima::safedds::dds::DataReader::get_subscription_matched_status ( SubscriptionMatchedStatus & status )

pure virtualnoexcept

Get the Subscription Matched Status.

Parameters

[out] status SubscriptionMatchedStatus object where the status is returned.

Returns: ReturnCode.

◆ get_topicdescription()

virtual const TopicDescription& eprosima::safedds::dds::DataReader::get_topicdescription ( ) const

pure virtualnoexcept

Get the topic description.

Returns: TopicDescription pointer.

◆ guid()

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

pure virtualnoexcept

Retrieves the DataWriter GUID.

Returns: GUID.

◆ operator=() [1/2]

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

protecteddefaultnoexcept

Copy operator allowed.

Returns: DataReader&.

◆ operator=() [2/2]

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

protecteddefaultnoexcept

Movement operator allowed.

Returns: DataReader&.

◆ release_sample_buffer()

virtual ReturnCode eprosima::safedds::dds::DataReader::release_sample_buffer	(	const memory::IConstMutableByteArrayView &	data_view,
		const dds::SampleInfo &	info
	)

pure virtualnoexcept

This operation releases a memory view of a Data sample previously returned by take_next_sample_buffer.

Parameters

[in]	data_view	Memory view to the sample data to release.
[in]	info	SampleInfo corresponding to the sample data.

Returns: ReturnCode.

◆ set_listener()

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

pure virtualnoexcept

Set DataReader listener.

Parameters

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

Returns: ReturnCode.

◆ set_qos()

virtual ReturnCode eprosima::safedds::dds::DataReader::set_qos ( const DataReaderQos & qos )

pure virtualnoexcept

Set DataReader QoS.

Parameters

[in] qos DataReader QoS.

Returns: ReturnCode.

◆ take_next_sample_buffer()

virtual ReturnCode eprosima::safedds::dds::DataReader::take_next_sample_buffer	(	memory::IConstMutableByteArrayView &	data_view,
		protocol::PayloadKind &	payload_kind,
		dds::InlineQoS &	inline_qos,
		dds::SampleInfo &	info
	)

pure virtualnoexcept

This operation returns a memory view of the next, non-previously accessed Data value from the DataReader and removes it from the DataReader instance handler so it is no longer accessible. The operation also copies the corresponding SampleInfo and InlineQoS.

Parameters

[out]	data_view	Memory view to the sample data.
[out]	payload_kind	Payload kind of the sample.
[out]	inline_qos	Inline QoS of the sample.
[out]	info	SampleInfo to store the sample information.

Returns: ReturnCode.

Note: This method is intended for zero-copy access to the sample data. The returned memory view points to an internal buffer that will not be released until release_sample_buffer is called with the same view and sample info returned by this method, or until the DataReader is destroyed. Therefore, the caller must call release_sample_buffer as soon as it is done with the sample data to avoid resource depletion.

◆ wait_for_historical_data()

virtual ReturnCode eprosima::safedds::dds::DataReader::wait_for_historical_data ( const execution::TimePeriod & timeout )

pure virtualnoexcept

Method to block the current thread until an unread message is available.

Parameters

timeout Maximum time to block the thread.

Returns: ReturnCode.

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

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

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~DataReader()

◆ DataReader() [1/3]

◆ DataReader() [2/3]

◆ DataReader() [3/3]

Member Function Documentation

◆ create_querycondition()

◆ create_readcondition()

◆ delete_contained_entities()

◆ delete_readcondition()

◆ get_listener()

◆ get_liveliness_changed_status()

◆ get_matched_publication_data()

◆ get_matched_publications()

◆ get_qos() [1/2]

◆ get_qos() [2/2]

◆ get_requested_deadline_missed_status()

◆ get_requested_incompatible_qos_status()

◆ get_sample_lost_status()

◆ get_sample_rejected_status()

◆ get_subscriber()

◆ get_subscription_matched_status()

◆ get_topicdescription()

◆ guid()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ release_sample_buffer()

◆ set_listener()

◆ set_qos()

◆ take_next_sample_buffer()

◆ wait_for_historical_data()