iox::dds::CycloneDataWriter

Implementation of the DataWriter abstraction using the cyclonedds implementation.

#include <cyclone_data_writer.hpp>

Inherits from iox::dds::DataWriter

Public Functions

	Name
	CycloneDataWriter()
	CycloneDataWriter(const capro::IdString_t serviceId, const capro::IdString_t instanceId, const capro::IdString_t eventId)
virtual	~CycloneDataWriter()
	CycloneDataWriter(const CycloneDataWriter & )
CycloneDataWriter &	operator=(const CycloneDataWriter & )
	CycloneDataWriter(CycloneDataWriter && ) =default
CycloneDataWriter &	operator=(CycloneDataWriter && ) =default
virtual void	connect() override connect 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) override write Write the provided header and bytes on the DDS network on the topic: serviceId/instanceId/eventId
virtual capro::IdString_t	getServiceId() const override getServiceId
virtual capro::IdString_t	getInstanceId() const override getInstanceId
virtual capro::IdString_t	getEventId() const override getEventId

Additional inherited members

Public Functions inherited from iox::dds::DataWriter

	Name
virtual	~DataWriter() =default

Protected Functions inherited from iox::dds::DataWriter

	Name
	DataWriter() =default

Public Functions Documentation

function CycloneDataWriter

CycloneDataWriter()

function CycloneDataWriter

CycloneDataWriter(
    const capro::IdString_t serviceId,
    const capro::IdString_t instanceId,
    const capro::IdString_t eventId
)

function ~CycloneDataWriter

virtual ~CycloneDataWriter()

function CycloneDataWriter

CycloneDataWriter(
    const CycloneDataWriter & 
)

function operator=

CycloneDataWriter & operator=(
    const CycloneDataWriter & 
)

function CycloneDataWriter

CycloneDataWriter(
    CycloneDataWriter && 
) =default

function operator=

CycloneDataWriter & operator=(
    CycloneDataWriter && 
) =default

function connect

virtual void connect() override

connect Connect the DataWriter to the underlying DDS network.

Reimplements: iox::dds::DataWriter::connect

function write

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

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

Reimplements: iox::dds::DataWriter::write

function getServiceId

virtual capro::IdString_t getServiceId() const override

getServiceId

Return: The ID of the service producing the bytes

Reimplements: iox::dds::DataWriter::getServiceId

function getInstanceId

virtual capro::IdString_t getInstanceId() const override

getInstanceId

Return: The ID of the instance of the service producing the bytes

Reimplements: iox::dds::DataWriter::getInstanceId

function getEventId

virtual capro::IdString_t getEventId() const override

getEventId

Return: The ID of the event producing the data

Reimplements: iox::dds::DataWriter::getEventId

---

Updated on 31 May 2022 at 15:29:16 CEST