iox::dds::DataWriter

Abstraction for DDS Data Writers. More...

#include <iceoryx_dds/dds/data_writer.hpp>

Inherited by iox::dds::CycloneDataWriter

Public Functions

	Name
virtual	~DataWriter() =default
virtual void	connect() =0 Connect the DataWriter to the underlying DDS network.
virtual void	write(iox::dds::IoxChunkDatagramHeader datagramHeader, const uint8_t const userHeaderBytes, const uint8_t const userPayloadBytes) =0 write Write the provided header and bytes on the DDS network on the topic: serviceId/instanceId/eventId
virtual capro::IdString_t	getServiceId() const =0 Get ID of the service.
virtual capro::IdString_t	getInstanceId() const =0 Get ID of the instance.
virtual capro::IdString_t	getEventId() const =0 Get ID of the event.

Protected Functions

	Name
	DataWriter() =default

Detailed Description

class iox::dds::DataWriter;

Abstraction for DDS Data Writers.

Note: Provides the minimum functionality required for posh-dds gateway implementations.

Public Functions Documentation

function ~DataWriter

virtual ~DataWriter() =default

function connect

virtual void connect() =0

Connect the DataWriter to the underlying DDS network.

Reimplemented by: iox::dds::CycloneDataWriter::connect

function write

virtual void write(
    iox::dds::IoxChunkDatagramHeader datagramHeader,
    const uint8_t *const userHeaderBytes,
    const uint8_t *const userPayloadBytes
) =0

write Write the provided header and bytes on the DDS network on the topic: serviceId/instanceId/eventId

Parameters:

• datagramHeader with size information
• userHeaderBytes buffer with the user-header
• userPayloadBytes buffer with the user-payload

Reimplemented by: iox::dds::CycloneDataWriter::write

function getServiceId

virtual capro::IdString_t getServiceId() const =0

Get ID of the service.

Reimplemented by: iox::dds::CycloneDataWriter::getServiceId

function getInstanceId

virtual capro::IdString_t getInstanceId() const =0

Get ID of the instance.

Reimplemented by: iox::dds::CycloneDataWriter::getInstanceId

function getEventId

virtual capro::IdString_t getEventId() const =0

Get ID of the event.

Reimplemented by: iox::dds::CycloneDataWriter::getEventId

Protected Functions Documentation

function DataWriter

DataWriter() =default

---

Updated on 18 December 2023 at 13:02:35 CET