Class astutedds::dcps::Subscriber

ClassList > astutedds > dcps > Subscriber

Container for DataReaders.

• #include <dcps.hpp>

Public Functions

Type	Name
	Subscriber (DomainParticipant * participant)
ReturnCode_t	begin_access () Begin ordered/coherent access to samples When ordered_access is set, samples are presented in source-timestamp order.
DataReader *	create_datareader (Topic * topic, const DataReaderQos & qos=DataReaderQos{}) Create a DataReader for a topic.
DataReader *	create_datareader (TopicDescription * td, const DataReaderQos & qos, DataReaderListener * listener=nullptr, StatusMask mask=STATUS_MASK_ALL) Create a DataReader for aTopicDescription (Topic or CFT) with listener (PSM overload)
DataReaderQos	default_datareader_qos () const Return the default DataReader QoS (value return)
bool	delete_datareader (DataReader * reader) Delete a DataReader .
ReturnCode_t	end_access () End ordered/coherent access to samples.
std::vector< DataReader * >	get_datareaders () const Get all DataReaders as raw pointers.
ReturnCode_t	get_default_datareader_qos (DataReaderQos & qos) const Get the default DataReader QoS (out-param, PSM style)
const SubscriberQos &	get_qos () const
bool	is_access_active () const
DomainParticipant *	participant () const
const std::vector< std::unique_ptr< DataReader > > &	readers () const
void	set_qos (const SubscriberQos & qos)
	~Subscriber () = default

Public Functions Documentation

function Subscriber

astutedds::dcps::Subscriber::Subscriber (
    DomainParticipant * participant
) 

---

function begin_access

Begin ordered/coherent access to samples When ordered_access is set, samples are presented in source-timestamp order.

inline ReturnCode_t astutedds::dcps::Subscriber::begin_access () 

---

function create_datareader [1/2]

Create a DataReader for a topic.

DataReader * astutedds::dcps::Subscriber::create_datareader (
    Topic * topic,
    const DataReaderQos & qos=DataReaderQos {}
) 

---

function create_datareader [2/2]

Create a DataReader for aTopicDescription (Topic or CFT) with listener (PSM overload)

DataReader * astutedds::dcps::Subscriber::create_datareader (
    TopicDescription * td,
    const DataReaderQos & qos,
    DataReaderListener * listener=nullptr,
    StatusMask mask=STATUS_MASK_ALL
) 

---

function default_datareader_qos

Return the default DataReader QoS (value return)

inline DataReaderQos astutedds::dcps::Subscriber::default_datareader_qos () const

---

function delete_datareader

Delete a DataReader .

bool astutedds::dcps::Subscriber::delete_datareader (
    DataReader * reader
) 

---

function end_access

End ordered/coherent access to samples.

inline ReturnCode_t astutedds::dcps::Subscriber::end_access () 

---

function get_datareaders

Get all DataReaders as raw pointers.

inline std::vector< DataReader * > astutedds::dcps::Subscriber::get_datareaders () const

---

function get_default_datareader_qos

Get the default DataReader QoS (out-param, PSM style)

inline ReturnCode_t astutedds::dcps::Subscriber::get_default_datareader_qos (
    DataReaderQos & qos
) const

---

function get_qos

inline const SubscriberQos & astutedds::dcps::Subscriber::get_qos () const

---

function is_access_active

inline bool astutedds::dcps::Subscriber::is_access_active () const

---

function participant

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

---

function readers

inline const std::vector< std::unique_ptr< DataReader > > & astutedds::dcps::Subscriber::readers () const

---

function set_qos

inline void astutedds::dcps::Subscriber::set_qos (
    const SubscriberQos & qos
) 

---

function ~Subscriber

astutedds::dcps::Subscriber::~Subscriber () = default

---

---

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