Namespace astutedds::cdr

Namespace List > astutedds > cdr

Classes

Type	Name
class	CDRBuffer
struct	DHEADER
struct	EMHEADER
struct	EncapsulationHeader
class	XCDR1Decoder XCDR1 decoding.
class	XCDR1Encoder XCDR1 encoding (CDR encapsulation version 1)
class	XCDR2Decoder XCDR2 decoding with DHEADER support.
class	XCDR2Encoder XCDR2 encoding (CDR encapsulation version 2)

Public Types

Type	Name
enum uint16_t	EncodingKind
enum uint8_t	ExtensibilityKind

Public Functions

Type	Name
constexpr size_t	align_offset (size_t offset, size_t alignment)
constexpr size_t	alignment_of ()
EncodingKind	detect_encoding (const std::vector< uint8_t > & buf) Extract the EncodingKind from the first two bytes of a serialized payload.
constexpr bool	is_little_endian ()
bool	is_xcdr1 (EncodingKind kind) Return true when the encapsulation kind is XCDR1 (CDR_BE/LE, PL_CDR_BE/LE).
T	swap_endian (T value)

Public Types Documentation

enum EncodingKind

enum astutedds::cdr::EncodingKind {
    CDR_BE = 0x0000,
    CDR_LE = 0x0001,
    PL_CDR_BE = 0x0002,
    PL_CDR_LE = 0x0003,
    CDR2_BE = 0x0006,
    CDR2_LE = 0x0007,
    XCDR2_BE = 0x0006,
    XCDR2_LE = 0x0007,
    D_CDR2_BE = 0x0008,
    D_CDR2_LE = 0x0009,
    PL_CDR2_BE = 0x000A,
    PL_CDR2_LE = 0x000B,
    XML = 0x0016
};

---

enum ExtensibilityKind

enum astutedds::cdr::ExtensibilityKind {
    FINAL = 0,
    APPENDABLE = 1,
    MUTABLE = 2
};

---

Public Functions Documentation

function align_offset

constexpr size_t astutedds::cdr::align_offset (
    size_t offset,
    size_t alignment
) 

---

function alignment_of

template<typename T>
constexpr size_t astutedds::cdr::alignment_of () 

---

function detect_encoding

Extract the EncodingKind from the first two bytes of a serialized payload.

inline EncodingKind astutedds::cdr::detect_encoding (
    const std::vector< uint8_t > & buf
) 

---

function is_little_endian

constexpr bool astutedds::cdr::is_little_endian () 

---

function is_xcdr1

Return true when the encapsulation kind is XCDR1 (CDR_BE/LE, PL_CDR_BE/LE).

inline bool astutedds::cdr::is_xcdr1 (
    EncodingKind kind
) 

---

function swap_endian

template<typename T>
T astutedds::cdr::swap_endian (
    T value
) 

---

---

The documentation for this class was generated from the following file include/astutedds/cdr/cdr_types.hpp