Class astutedds::dcps::Publisher

ClassList > astutedds > dcps > Publisher

Container for DataWriters.

• #include <dcps.hpp>

Public Functions

Type	Name
	Publisher (DomainParticipant * participant)
ReturnCode_t	begin_coherent_changes () Begin a coherent set of changes Buffers subsequent writes until end_coherent_changes() flushes them.
void	buffer_coherent_write (DataWriter * writer, const std::vector< uint8_t > & data) Add data to the coherent buffer (called by DataWriter when coherent is active)
void	buffer_coherent_write_dual (DataWriter * writer, const std::vector< uint8_t > & xcdr1, const std::vector< uint8_t > & xcdr2)
DataWriter *	create_datawriter (Topic * topic, const DataWriterQos & qos=DataWriterQos{}) Create a DataWriter for a topic.
DataWriter *	create_datawriter (Topic * topic, const DataWriterQos & qos, DataWriterListener * listener, StatusMask mask=STATUS_MASK_ALL) Create a DataWriter with listener and status mask (PSM overload)
DataWriterQos	default_datawriter_qos () const Return the default DataWriter QoS (value return)
bool	delete_datawriter (DataWriter * writer) Delete a DataWriter .
ReturnCode_t	end_coherent_changes () End a coherent set of changes — flush buffered writes.
std::vector< DataWriter * >	get_datawriters () const
ReturnCode_t	get_default_datawriter_qos (DataWriterQos & qos) const Get the default DataWriter QoS (out-param, PSM style)
const PublisherQos &	get_qos () const
bool	is_coherent_active () const
DomainParticipant *	participant () const
void	set_qos (const PublisherQos & qos)
const std::vector< std::unique_ptr< DataWriter > > &	writers () const
	~Publisher () = default

Public Functions Documentation

function Publisher

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

---

function begin_coherent_changes

Begin a coherent set of changes Buffers subsequent writes until end_coherent_changes() flushes them.

inline ReturnCode_t astutedds::dcps::Publisher::begin_coherent_changes () 

---

function buffer_coherent_write

Add data to the coherent buffer (called by DataWriter when coherent is active)

void astutedds::dcps::Publisher::buffer_coherent_write (
    DataWriter * writer,
    const std::vector< uint8_t > & data
) 

---

function buffer_coherent_write_dual

void astutedds::dcps::Publisher::buffer_coherent_write_dual (
    DataWriter * writer,
    const std::vector< uint8_t > & xcdr1,
    const std::vector< uint8_t > & xcdr2
) 

---

function create_datawriter [1/2]

Create a DataWriter for a topic.

DataWriter * astutedds::dcps::Publisher::create_datawriter (
    Topic * topic,
    const DataWriterQos & qos=DataWriterQos {}
) 

---

function create_datawriter [2/2]

Create a DataWriter with listener and status mask (PSM overload)

inline DataWriter * astutedds::dcps::Publisher::create_datawriter (
    Topic * topic,
    const DataWriterQos & qos,
    DataWriterListener * listener,
    StatusMask mask=STATUS_MASK_ALL
) 

---

function default_datawriter_qos

Return the default DataWriter QoS (value return)

inline DataWriterQos astutedds::dcps::Publisher::default_datawriter_qos () const

---

function delete_datawriter

Delete a DataWriter .

bool astutedds::dcps::Publisher::delete_datawriter (
    DataWriter * writer
) 

---

function end_coherent_changes

End a coherent set of changes — flush buffered writes.

ReturnCode_t astutedds::dcps::Publisher::end_coherent_changes () 

---

function get_datawriters

inline std::vector< DataWriter * > astutedds::dcps::Publisher::get_datawriters () const

---

function get_default_datawriter_qos

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

inline ReturnCode_t astutedds::dcps::Publisher::get_default_datawriter_qos (
    DataWriterQos & qos
) const

---

function get_qos

inline const PublisherQos & astutedds::dcps::Publisher::get_qos () const

---

function is_coherent_active

inline bool astutedds::dcps::Publisher::is_coherent_active () const

---

function participant

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

---

function set_qos

inline void astutedds::dcps::Publisher::set_qos (
    const PublisherQos & qos
) 

---

function writers

inline const std::vector< std::unique_ptr< DataWriter > > & astutedds::dcps::Publisher::writers () const

---

function ~Publisher

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

---

---

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