Skip to content

iox::dds::CycloneDataWriter🔗

Implementation of the DataWriter abstraction using the cyclonedds implementation. #include <iceoryx_dds/dds/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)
Constructor to set cyclone data writer object from given IDs.
virtual ~CycloneDataWriter()
CycloneDataWriter(const CycloneDataWriter & )
CycloneDataWriter & operator=(const CycloneDataWriter & )
CycloneDataWriter(CycloneDataWriter && rhs) =default
CycloneDataWriter & operator=(CycloneDataWriter && rhs) =default
virtual void connect() override
connect cyclone data writer 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
Get ID of the service.
virtual capro::IdString_t getInstanceId() const override
Get ID of the instance.
virtual capro::IdString_t getEventId() const override
Get ID of the event.

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
)

Constructor to set cyclone data writer object from given IDs.

Parameters:

  • serviceId ID of the service
  • instanceId ID of the instance of the service
  • eventId ID of the event

function ~CycloneDataWriter🔗

virtual ~CycloneDataWriter()

function CycloneDataWriter🔗

CycloneDataWriter(
    const CycloneDataWriter & 
)

function operator=🔗

CycloneDataWriter & operator=(
    const CycloneDataWriter & 
)

function CycloneDataWriter🔗

CycloneDataWriter(
    CycloneDataWriter && rhs
) =default

function operator=🔗

CycloneDataWriter & operator=(
    CycloneDataWriter && rhs
) =default

function connect🔗

virtual void connect() override

connect cyclone data writer 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

Get ID of the service.

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

function getInstanceId🔗

virtual capro::IdString_t getInstanceId() const override

Get ID of the instance.

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

function getEventId🔗

virtual capro::IdString_t getEventId() const override

Get ID of the event.

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

Updated on 18 December 2023 at 13:11:43 CET