DDS Subscriber interface. More...

#include <Subscriber.hpp>

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

virtual ReturnCode	get_qos (SubscriberQos &qos) const noexcept=0
	Get Subscriber QoS. More...

virtual SubscriberQos	get_qos () const noexcept=0
	Get Subscriber QoS by value. More...

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

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

virtual DataReader *	create_datareader (Topic &topic, const DataReaderQos &qos, DataReaderListener *listener, const StatusMask &mask) noexcept=0
	Create a DataReader. More...

virtual ReturnCode	delete_datareader (DataReader *datareader) noexcept=0
	Delete a DataReader. More...

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

virtual ReturnCode	notify_datareaders () noexcept=0
	Notify DataReaders. More...

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

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

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

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

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

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

virtual ReturnCode	end_access () noexcept=0
	End coherent changes. More...

virtual ReturnCode	get_datareaders (memory::IReferenceList< DataReader > &readers, const SampleStateMask &sample_states, const ViewStateMask &view_states, const InstanceStateMask &instance_states) noexcept=0
	Get DataReaders for which certain criteria apply. 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
	~Subscriber () noexcept=default
	Protected destructor ownership defined on creation. More...

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

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

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

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

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

Constructor & Destructor Documentation

◆ ~Subscriber()

eprosima::safedds::dds::Subscriber::~Subscriber ( )

protecteddefaultnoexcept

Protected destructor ownership defined on creation.

◆ Subscriber() [1/3]

eprosima::safedds::dds::Subscriber::Subscriber ( )

protecteddefaultnoexcept

Default creation.

◆ Subscriber() [2/3]

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

protecteddefaultnoexcept

Copy allowed.

◆ Subscriber() [3/3]

eprosima::safedds::dds::Subscriber::Subscriber ( Subscriber && )

protecteddefaultnoexcept

Movement allowed.

Member Function Documentation

◆ begin_access()

virtual ReturnCode eprosima::safedds::dds::Subscriber::begin_access ( )

pure virtualnoexcept

Begin coherent changes.

Returns: ReturnCode.

◆ copy_from_topic_qos()

virtual ReturnCode eprosima::safedds::dds::Subscriber::copy_from_topic_qos	(	DataReaderQos &	qos,
		const TopicQos &	topic_qos
	)		const

pure virtualnoexcept

Copy DataReader QoS from Topic QoS.

Parameters

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

Returns: ReturnCode.

◆ create_datareader()

virtual DataReader* eprosima::safedds::dds::Subscriber::create_datareader	(	Topic &	topic,
		const DataReaderQos &	qos,
		DataReaderListener *	listener,
		const StatusMask &	mask
	)

pure virtualnoexcept

Create a DataReader.

Parameters

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

Returns: DataReader *.

◆ delete_contained_entities()

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

pure virtualnoexcept

Delete contained entities.

Returns: ReturnCode.

◆ delete_datareader()

virtual ReturnCode eprosima::safedds::dds::Subscriber::delete_datareader ( DataReader * datareader )

pure virtualnoexcept

Delete a DataReader.

Parameters

[in] datareader DataReader to be deleted.

Returns: ReturnCode.

◆ end_access()

virtual ReturnCode eprosima::safedds::dds::Subscriber::end_access ( )

pure virtualnoexcept

End coherent changes.

Returns: ReturnCode.

◆ get_datareaders()

virtual ReturnCode eprosima::safedds::dds::Subscriber::get_datareaders	(	memory::IReferenceList< DataReader > &	readers,
		const SampleStateMask &	sample_states,
		const ViewStateMask &	view_states,
		const InstanceStateMask &	instance_states
	)

pure virtualnoexcept

Get DataReaders for which certain criteria apply.

Parameters

[out]	readers	Vector to be filled with the references of DataReaders for which the criteria apply.
[in]	sample_states	Filter to apply on the sample state of the available samples on each DataReader.
[in]	view_states	Filter to apply on the view state of the available instances on each DataReader.
[in]	instance_states	Filter to apply on the instance state of the available instances on each DataReader.

Returns: ReturnCode.

◆ get_default_datareader_qos()

virtual ReturnCode eprosima::safedds::dds::Subscriber::get_default_datareader_qos ( DataReaderQos & qos ) const

pure virtualnoexcept

Get default DataReader QoS.

Parameters

[out] qos DataReader QoS.

Returns: ReturnCode.

◆ get_listener()

virtual SubscriberListener* eprosima::safedds::dds::Subscriber::get_listener ( ) const

pure virtualnoexcept

Get SubscriberListener listener.

Returns: SubscriberListener *.

◆ get_participant()

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

pure virtualnoexcept

Get participant.

Returns: DomainParticipant&

◆ get_qos() [1/2]

virtual SubscriberQos eprosima::safedds::dds::Subscriber::get_qos ( ) const

pure virtualnoexcept

Get Subscriber QoS by value.

Returns: SubscriberQos

◆ get_qos() [2/2]

virtual ReturnCode eprosima::safedds::dds::Subscriber::get_qos ( SubscriberQos & qos ) const

pure virtualnoexcept

Get Subscriber QoS.

Parameters

[out] qos Subscriber QoS.

Returns: ReturnCode.

◆ lookup_datareader()

virtual DataReader* eprosima::safedds::dds::Subscriber::lookup_datareader ( const memory::IStringView & topic_name ) const

pure virtualnoexcept

Get DataReader.

Parameters

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

Returns: DataReader *.

◆ notify_datareaders()

virtual ReturnCode eprosima::safedds::dds::Subscriber::notify_datareaders ( )

pure virtualnoexcept

Notify DataReaders.

Returns: ReturnCode.

◆ operator=() [1/2]

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

protecteddefaultnoexcept

Copy operator allowed.

Returns: Subscriber&.

◆ operator=() [2/2]

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

protecteddefaultnoexcept

Movement operator allowed.

Returns: Subscriber&.

◆ set_default_datareader_qos()

virtual ReturnCode eprosima::safedds::dds::Subscriber::set_default_datareader_qos ( const DataReaderQos & qos )

pure virtualnoexcept

Set default DataReader QoS.

Parameters

[in] qos DataReader QoS.

Returns: ReturnCode.

◆ set_listener()

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

pure virtualnoexcept

Set Subscriber listener.

Parameters

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

Returns: ReturnCode.

◆ set_qos()

virtual ReturnCode eprosima::safedds::dds::Subscriber::set_qos ( const SubscriberQos & qos )

pure virtualnoexcept

Set Subscriber QoS.

Parameters

[in] qos Subscriber QoS.

Returns: ReturnCode.

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

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

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~Subscriber()

◆ Subscriber() [1/3]

◆ Subscriber() [2/3]

◆ Subscriber() [3/3]

Member Function Documentation

◆ begin_access()

◆ copy_from_topic_qos()

◆ create_datareader()

◆ delete_contained_entities()

◆ delete_datareader()

◆ end_access()

◆ get_datareaders()

◆ get_default_datareader_qos()

◆ get_listener()

◆ get_participant()

◆ get_qos() [1/2]

◆ get_qos() [2/2]

◆ lookup_datareader()

◆ notify_datareaders()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ set_default_datareader_qos()

◆ set_listener()

◆ set_qos()