eprosima::safedds::serialization::RepresentationHeader Struct Reference

RTPS SerializedPayloadHeader equivalent. More...

#include <RepresentationHeader.hpp>

Public Member Functions
void	init_as_parameter_list () noexcept
	Initialize RepresentationHeader as a parameter list with machine endianness. More...
void	init_as_cdr () noexcept
	Initialize RepresentationHeader as a cdr payload list with machine endianness. More...
platform::Endianness	get_endianness () const noexcept
	Get a validated encapsulation_kind endianness. More...
bool	payload_is_parameter_list () const noexcept
	Check if RepresentationHeader indicates a parameter list payload. More...
bool	payload_is_cdr () const noexcept
	Check if RepresentationHeader indicates a plain CDR payload. More...
bool	is_valid () const noexcept
	Check if given RepresentationHeader is valid. More...

Public Attributes
memory::container::Array< uint8_t, ENCAPSULATION_KIND_SIZE >	encapsulation_kind
	Kind of next message to be deserialized. More...
memory::container::Array< uint8_t, ENCAPSULATION_OPTIONS_SIZE >	encapsulation_options
	Encapsulation options. More...

Static Public Attributes
static constexpr uint32_t	ENCAPSULATION_KIND_SIZE = 2
	Encapsulation kind size. More...
static constexpr uint32_t	ENCAPSULATION_OPTIONS_SIZE = 2
	Encapsulation options size. More...
static constexpr uint32_t	CDR_SERIALIZED_SIZE
	CDR serialized size. More...

Detailed Description

RTPS SerializedPayloadHeader equivalent.

Member Function Documentation

get_endianness()

platform::Endianness eprosima::safedds::serialization::RepresentationHeader::get_endianness ( ) const

noexcept

Get a validated encapsulation_kind endianness.

Returns

Endianness of encapsulation_kind.

init_as_cdr()

void eprosima::safedds::serialization::RepresentationHeader::init_as_cdr ( )

noexcept

Initialize RepresentationHeader as a cdr payload list with machine endianness.

init_as_parameter_list()

void eprosima::safedds::serialization::RepresentationHeader::init_as_parameter_list ( )

noexcept

Initialize RepresentationHeader as a parameter list with machine endianness.

is_valid()

bool eprosima::safedds::serialization::RepresentationHeader::is_valid ( ) const

noexcept

Check if given RepresentationHeader is valid.

Returns

true if valid, false otherwise.

payload_is_cdr()

bool eprosima::safedds::serialization::RepresentationHeader::payload_is_cdr ( ) const

noexcept

Check if RepresentationHeader indicates a plain CDR payload.

Returns

true if payload is encoded using CDR, false otherwise.

payload_is_parameter_list()

bool eprosima::safedds::serialization::RepresentationHeader::payload_is_parameter_list ( ) const

noexcept

Check if RepresentationHeader indicates a parameter list payload.

Returns

true if payload is a parameter list, false otherwise.

Member Data Documentation

CDR_SERIALIZED_SIZE

constexpr uint32_t eprosima::safedds::serialization::RepresentationHeader::CDR_SERIALIZED_SIZE

staticconstexpr

Initial value:

=
            ENCAPSULATION_KIND_SIZE +       
            ENCAPSULATION_OPTIONS_SIZE

CDR serialized size.

encapsulation_kind

memory::container::Array<uint8_t, ENCAPSULATION_KIND_SIZE> eprosima::safedds::serialization::RepresentationHeader::encapsulation_kind

Kind of next message to be deserialized.

ENCAPSULATION_KIND_SIZE

constexpr uint32_t eprosima::safedds::serialization::RepresentationHeader::ENCAPSULATION_KIND_SIZE = 2

staticconstexpr

Encapsulation kind size.

encapsulation_options

memory::container::Array<uint8_t, ENCAPSULATION_OPTIONS_SIZE> eprosima::safedds::serialization::RepresentationHeader::encapsulation_options

Encapsulation options.

ENCAPSULATION_OPTIONS_SIZE

constexpr uint32_t eprosima::safedds::serialization::RepresentationHeader::ENCAPSULATION_OPTIONS_SIZE = 2

staticconstexpr

Encapsulation options size.

---

The documentation for this struct was generated from the following file:

• build/docs/user_manual/v3.0.0/tmp/include/safedds/serialization/RepresentationHeader.hpp