Skip to content

iox::dds🔗

Classes🔗

Name
class iox::dds::CycloneContext
The CycloneContext manages cyclone configurations and singleton artifacts shared throughout an application.
class iox::dds::CycloneDataReader
Implementation of the DataReader abstraction using the cyclonedds implementation.
class iox::dds::CycloneDataWriter
Implementation of the DataWriter abstraction using the cyclonedds implementation.
class iox::dds::DataReader
Abstraction for DDS Data Readers.
class iox::dds::DataWriter
Abstraction for DDS Data Writers.
struct iox::dds::IoxChunkDatagramHeader
The datagram header with chunk metadata for user-header and user-payload.
class iox::dds::DDS2IceoryxGateway
DDS Gateway implementation for the DDS to iceoryx direction.
class iox::dds::Iceoryx2DDSGateway
DDS Gateway implementation for the iceoryx to DDS direction.

Types🔗

Name
enum uint8_t DataReaderError
enum uint8_t Endianess { UNDEFINED, LITTLE, BIG, MIXED}
the endianess of the serialized data

Functions🔗

Name
Endianess getEndianess()
Detects the endianness of the system.

Attributes🔗

Name
constexpr const char * DataReaderErrorString
constexpr units::Duration DISCOVERY_PERIOD
constexpr units::Duration FORWARDING_PERIOD
constexpr uint32_t SUBSCRIBER_CACHE_SIZE
constexpr const char * EndianessString

Types Documentation🔗

enum DataReaderError🔗

Enumerator Value Description
NOT_CONNECTED
INVALID_DATAGRAM_HEADER_SIZE
INVALID_BUFFER_PARAMETER_FOR_USER_HEADER
INVALID_BUFFER_PARAMETER_FOR_USER_PAYLOAD
INVALID_DATA
BUFFER_SIZE_MISMATCH

enum Endianess🔗

Enumerator Value Description
UNDEFINED
LITTLE
BIG
MIXED

the endianess of the serialized data

Functions Documentation🔗

function getEndianess🔗

Endianess getEndianess()

Detects the endianness of the system.

Attributes Documentation🔗

variable DataReaderErrorString🔗

constexpr const char * DataReaderErrorString = {"NOT_CONNECTED",
                                                 "INVALID_DATAGRAM_HEADER_SIZE",
                                                 "INVALID_BUFFER_PARAMETER_FOR_USER_HEADER",
                                                 "INVALID_BUFFER_PARAMETER_FOR_USER_PAYLOAD",
                                                 "INVALID_DATA",
                                                 "BUFFER_SIZE_MISMATCH"};

variable DISCOVERY_PERIOD🔗

static constexpr units::Duration DISCOVERY_PERIOD = 1000_ms;

variable FORWARDING_PERIOD🔗

static constexpr units::Duration FORWARDING_PERIOD = 50_ms;

variable SUBSCRIBER_CACHE_SIZE🔗

static constexpr uint32_t SUBSCRIBER_CACHE_SIZE = 128u;

variable EndianessString🔗

constexpr const char * EndianessString = {"UNDEFINED", "LITTLE", "BIG", "MIXED"};

Updated on 17 March 2022 at 12:15:57 CET