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
class iox::dds::DataWriter
Abstraction for DDS Data Writers. Provides the minimum functionality required for posh-dds gateway implementations.
class iox::dds::DDS2IceoryxGateway
DDS Gateway implementation for the DDS to iceoryx direction.
struct iox::dds::DDSLoggingComponent
class iox::dds::Iceoryx2DDSGateway
DDS Gateway implementation for the iceoryx to DDS direction.
struct iox::dds::IoxChunkDatagramHeader
The datagram header with chunk metadata for user-header and user-payload.

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
constexpr auto LogFatal
constexpr auto LogError
constexpr auto LogWarn
constexpr auto LogInfo
constexpr auto LogDebug
constexpr auto LogVerbose

Types Documentation🔗

enum DataReaderError🔗

Enumerator Value Description
INVALID_STATE
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 = {"INVALID_STATE",
                                                 "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"};

variable LogFatal🔗

static constexpr auto LogFatal = iox::log::ffbb::LogFatal<[DDSLoggingComponent](/v1.0.1/API-reference/DDS-gateway/Classes/structiox_1_1dds_1_1DDSLoggingComponent/)>;

variable LogError🔗

static constexpr auto LogError = iox::log::ffbb::LogError<[DDSLoggingComponent](/v1.0.1/API-reference/DDS-gateway/Classes/structiox_1_1dds_1_1DDSLoggingComponent/)>;

variable LogWarn🔗

static constexpr auto LogWarn = iox::log::ffbb::LogWarn<[DDSLoggingComponent](/v1.0.1/API-reference/DDS-gateway/Classes/structiox_1_1dds_1_1DDSLoggingComponent/)>;

variable LogInfo🔗

static constexpr auto LogInfo = iox::log::ffbb::LogInfo<[DDSLoggingComponent](/v1.0.1/API-reference/DDS-gateway/Classes/structiox_1_1dds_1_1DDSLoggingComponent/)>;

variable LogDebug🔗

static constexpr auto LogDebug = iox::log::ffbb::LogDebug<[DDSLoggingComponent](/v1.0.1/API-reference/DDS-gateway/Classes/structiox_1_1dds_1_1DDSLoggingComponent/)>;

variable LogVerbose🔗

static constexpr auto LogVerbose = iox::log::ffbb::LogVerbose<[DDSLoggingComponent](/v1.0.1/API-reference/DDS-gateway/Classes/structiox_1_1dds_1_1DDSLoggingComponent/)>;

Updated on 17 June 2021 at 11:15:28 CEST