Provides datagram serialization functionality. More...

#include <ISerializer.hpp>

Public Member Functions
virtual ReturnCode	serializer_skip (uint32_t size) noexcept=0
	Skips slice in serialization process. More...

virtual ReturnCode	serializer_align_to (uint32_t type_size) noexcept=0
	Aligns serializer position. More...

virtual uint32_t	serializer_remaining_size () noexcept=0
	Returns remaining available size of serializer. More...

virtual uint32_t	serializer_used_size () noexcept=0
	Gets serializer used size. More...

virtual void	reset_alignment () noexcept=0
	Resets serializer alignment. More...

virtual ReturnCode	serialize (char value) noexcept=0
	Serialize a single variable, implementations for each supported type: char bool uint8_t uint16_t uint32_t uint64_t int8_t int16_t int32_t int64_t float double. More...

virtual ReturnCode	serialize (bool value) noexcept=0
	Serialize a single bool. More...

virtual ReturnCode	serialize (uint8_t value) noexcept=0
	Serialize a single uint8_t. More...

virtual ReturnCode	serialize (uint16_t value) noexcept=0
	Serialize a single uint16_t. More...

virtual ReturnCode	serialize (uint32_t value) noexcept=0
	Serialize a single uint32_t. More...

virtual ReturnCode	serialize (uint64_t value) noexcept=0
	Serialize a single uint64_t. More...

virtual ReturnCode	serialize (int8_t value) noexcept=0
	Serialize a single int8_t. More...

virtual ReturnCode	serialize (int16_t value) noexcept=0
	Serialize a single int16_t. More...

virtual ReturnCode	serialize (int32_t value) noexcept=0
	Serialize a single int32_t. More...

virtual ReturnCode	serialize (int64_t value) noexcept=0
	Serialize a single int64_t. More...

virtual ReturnCode	serialize (float value) noexcept=0
	Serialize a single float. More...

virtual ReturnCode	serialize (double value) noexcept=0
	Serialize a single double. More...

virtual ReturnCode	serialize_array (const char *value, uint32_t size) noexcept=0
	Serialize array, implementations for each supported type: char bool uint8_t uint16_t uint32_t uint64_t int8_t int16_t int32_t int64_t float double. More...

virtual ReturnCode	serialize_array (const bool *value, uint32_t size) noexcept=0
	Serialize bool array. More...

virtual ReturnCode	serialize_array (const uint8_t *value, uint32_t size) noexcept=0
	Serialize uint8_t array. More...

virtual ReturnCode	serialize_array (const uint16_t *value, uint32_t size) noexcept=0
	Serialize uint16_t array. More...

virtual ReturnCode	serialize_array (const uint32_t *value, uint32_t size) noexcept=0
	Serialize uint32_t array. More...

virtual ReturnCode	serialize_array (const uint64_t *value, uint32_t size) noexcept=0
	Serialize uint64_t array. More...

virtual ReturnCode	serialize_array (const int8_t *value, uint32_t size) noexcept=0
	Serialize int8_t array. More...

virtual ReturnCode	serialize_array (const int16_t *value, uint32_t size) noexcept=0
	Serialize int16_t array. More...

virtual ReturnCode	serialize_array (const int32_t *value, uint32_t size) noexcept=0
	Serialize int32_t array. More...

virtual ReturnCode	serialize_array (const int64_t *value, uint32_t size) noexcept=0
	Serialize int64_t array. More...

virtual ReturnCode	serialize_array (const float *value, uint32_t size) noexcept=0
	Serialize float array. More...

virtual ReturnCode	serialize_array (const double *value, uint32_t size) noexcept=0
	Serialize double array. More...

virtual ReturnCode	serialize_sequence (const char *value, uint32_t size) noexcept=0
	Serialize sequence, implementations for each supported type: char bool uint8_t uint16_t uint32_t uint64_t int8_t int16_t int32_t int64_t float double. More...

virtual ReturnCode	serialize_sequence (const bool *value, uint32_t size) noexcept=0
	Serialize bool sequence. More...

virtual ReturnCode	serialize_sequence (const uint8_t *value, uint32_t size) noexcept=0
	Serialize uint8_t sequence. More...

virtual ReturnCode	serialize_sequence (const uint16_t *value, uint32_t size) noexcept=0
	Serialize uint16_t sequence. More...

virtual ReturnCode	serialize_sequence (const uint32_t *value, uint32_t size) noexcept=0
	Serialize uint32_t sequence. More...

virtual ReturnCode	serialize_sequence (const uint64_t *value, uint32_t size) noexcept=0
	Serialize uint64_t sequence. More...

virtual ReturnCode	serialize_sequence (const int8_t *value, uint32_t size) noexcept=0
	Serialize int8_t sequence. More...

virtual ReturnCode	serialize_sequence (const int16_t *value, uint32_t size) noexcept=0
	Serialize int16_t sequence. More...

virtual ReturnCode	serialize_sequence (const int32_t *value, uint32_t size) noexcept=0
	Serialize int32_t sequence. More...

virtual ReturnCode	serialize_sequence (const int64_t *value, uint32_t size) noexcept=0
	Serialize int64_t sequence. More...

virtual ReturnCode	serialize_sequence (const float *value, uint32_t size) noexcept=0
	Serialize float sequence. More...

virtual ReturnCode	serialize_sequence (const double *value, uint32_t size) noexcept=0
	Serialize double sequence. More...

Protected Member Functions
	~ISerializer () noexcept=default
	Protected destructor ownership defined on creation. More...

	ISerializer () noexcept=default
	Default creation. More...

	ISerializer (const ISerializer &) noexcept=delete
	Copy deleted. More...

	ISerializer (ISerializer &&) noexcept=delete
	Movement deleted. More...

ISerializer &	operator= (const ISerializer &) noexcept=delete
	Copy operator deleted. More...

ISerializer &	operator= (ISerializer &&) noexcept=delete
	Movement operator deleted. More...

Detailed Description

Provides datagram serialization functionality.

Constructor & Destructor Documentation

◆ ~ISerializer()

eprosima::safedds::serialization::ISerializer::~ISerializer ( )

protecteddefaultnoexcept

Protected destructor ownership defined on creation.

◆ ISerializer() [1/3]

eprosima::safedds::serialization::ISerializer::ISerializer ( )

protecteddefaultnoexcept

Default creation.

◆ ISerializer() [2/3]

eprosima::safedds::serialization::ISerializer::ISerializer ( const ISerializer & )

protecteddeletenoexcept

Copy deleted.

◆ ISerializer() [3/3]

eprosima::safedds::serialization::ISerializer::ISerializer ( ISerializer && )

protecteddeletenoexcept

Movement deleted.

Member Function Documentation

◆ operator=() [1/2]

ISerializer& eprosima::safedds::serialization::ISerializer::operator= ( const ISerializer & )

protecteddeletenoexcept

Copy operator deleted.

◆ operator=() [2/2]

ISerializer& eprosima::safedds::serialization::ISerializer::operator= ( ISerializer && )

protecteddeletenoexcept

Movement operator deleted.

◆ reset_alignment()

virtual void eprosima::safedds::serialization::ISerializer::reset_alignment ( )

pure virtualnoexcept

Resets serializer alignment.

Implemented in eprosima::safedds::serialization::cdr::Serializer.

◆ serialize() [1/12]

virtual ReturnCode eprosima::safedds::serialization::ISerializer::serialize ( bool value )

pure virtualnoexcept

Serialize a single bool.

Parameters

value variable to serialize.

Returns: ReturnCode.

Implemented in eprosima::safedds::serialization::cdr::Serializer.

◆ serialize() [2/12]

virtual ReturnCode eprosima::safedds::serialization::ISerializer::serialize ( char value )

pure virtualnoexcept

Serialize a single variable, implementations for each supported type: char bool uint8_t uint16_t uint32_t uint64_t int8_t int16_t int32_t int64_t float double.

Parameters

value variable to serialize.

Returns: ReturnCode.

Implemented in eprosima::safedds::serialization::cdr::Serializer.

◆ serialize() [3/12]

virtual ReturnCode eprosima::safedds::serialization::ISerializer::serialize ( double value )

pure virtualnoexcept

Serialize a single double.

Parameters

value variable to serialize.

Returns: ReturnCode.

Implemented in eprosima::safedds::serialization::cdr::Serializer.

◆ serialize() [4/12]

virtual ReturnCode eprosima::safedds::serialization::ISerializer::serialize ( float value )

pure virtualnoexcept

Serialize a single float.

Parameters

value variable to serialize.

Returns: ReturnCode.

Implemented in eprosima::safedds::serialization::cdr::Serializer.

◆ serialize() [5/12]

virtual ReturnCode eprosima::safedds::serialization::ISerializer::serialize ( int16_t value )

pure virtualnoexcept

Serialize a single int16_t.

Parameters

value variable to serialize.

Returns: ReturnCode.

Implemented in eprosima::safedds::serialization::cdr::Serializer.

◆ serialize() [6/12]

virtual ReturnCode eprosima::safedds::serialization::ISerializer::serialize ( int32_t value )

pure virtualnoexcept

Serialize a single int32_t.

Parameters

value variable to serialize.

Returns: ReturnCode.

Implemented in eprosima::safedds::serialization::cdr::Serializer.

◆ serialize() [7/12]

virtual ReturnCode eprosima::safedds::serialization::ISerializer::serialize ( int64_t value )

pure virtualnoexcept

Serialize a single int64_t.

Parameters

value variable to serialize.

Returns: ReturnCode.

Implemented in eprosima::safedds::serialization::cdr::Serializer.

◆ serialize() [8/12]

virtual ReturnCode eprosima::safedds::serialization::ISerializer::serialize ( int8_t value )

pure virtualnoexcept

Serialize a single int8_t.

Parameters

value variable to serialize.

Returns: ReturnCode.

Implemented in eprosima::safedds::serialization::cdr::Serializer.

◆ serialize() [9/12]

virtual ReturnCode eprosima::safedds::serialization::ISerializer::serialize ( uint16_t value )

pure virtualnoexcept

Serialize a single uint16_t.

Parameters

value variable to serialize.

Returns: ReturnCode.

Implemented in eprosima::safedds::serialization::cdr::Serializer.

◆ serialize() [10/12]

virtual ReturnCode eprosima::safedds::serialization::ISerializer::serialize ( uint32_t value )

pure virtualnoexcept

Serialize a single uint32_t.

Parameters

value variable to serialize.

Returns: ReturnCode.

Implemented in eprosima::safedds::serialization::cdr::Serializer.

◆ serialize() [11/12]

virtual ReturnCode eprosima::safedds::serialization::ISerializer::serialize ( uint64_t value )

pure virtualnoexcept

Serialize a single uint64_t.

Parameters

value variable to serialize.

Returns: ReturnCode.

Implemented in eprosima::safedds::serialization::cdr::Serializer.

◆ serialize() [12/12]

virtual ReturnCode eprosima::safedds::serialization::ISerializer::serialize ( uint8_t value )

pure virtualnoexcept

Serialize a single uint8_t.

Parameters

value variable to serialize.

Returns: ReturnCode.

Implemented in eprosima::safedds::serialization::cdr::Serializer.

◆ serialize_array() [1/12]

virtual ReturnCode eprosima::safedds::serialization::ISerializer::serialize_array	(	const bool *	value,
		uint32_t	size
	)

pure virtualnoexcept

Serialize bool array.

Parameters

[in]	value	pointer to array to serialize.
	size	size of the array that is going to be serialized.

Returns: ReturnCode.

Implemented in eprosima::safedds::serialization::cdr::Serializer.

◆ serialize_array() [2/12]

virtual ReturnCode eprosima::safedds::serialization::ISerializer::serialize_array	(	const char *	value,
		uint32_t	size
	)

pure virtualnoexcept

Serialize array, implementations for each supported type: char bool uint8_t uint16_t uint32_t uint64_t int8_t int16_t int32_t int64_t float double.

Parameters

[in]	value	pointer to array to serialize.
	size	size of the array that is going to be serialized.

Returns: ReturnCode.

Implemented in eprosima::safedds::serialization::cdr::Serializer.

◆ serialize_array() [3/12]

virtual ReturnCode eprosima::safedds::serialization::ISerializer::serialize_array	(	const double *	value,
		uint32_t	size
	)

pure virtualnoexcept

Serialize double array.

Parameters

[in]	value	pointer to array to serialize.
	size	size of the array that is going to be serialized.

Returns: ReturnCode.

Implemented in eprosima::safedds::serialization::cdr::Serializer.

◆ serialize_array() [4/12]

virtual ReturnCode eprosima::safedds::serialization::ISerializer::serialize_array	(	const float *	value,
		uint32_t	size
	)

pure virtualnoexcept

Serialize float array.

Parameters

[in]	value	pointer to array to serialize.
	size	size of the array that is going to be serialized.

Returns: ReturnCode.

Implemented in eprosima::safedds::serialization::cdr::Serializer.

◆ serialize_array() [5/12]

virtual ReturnCode eprosima::safedds::serialization::ISerializer::serialize_array	(	const int16_t *	value,
		uint32_t	size
	)

pure virtualnoexcept

Serialize int16_t array.

Parameters

[in]	value	pointer to array to serialize.
	size	size of the array that is going to be serialized.

Returns: ReturnCode.

Implemented in eprosima::safedds::serialization::cdr::Serializer.

◆ serialize_array() [6/12]

virtual ReturnCode eprosima::safedds::serialization::ISerializer::serialize_array	(	const int32_t *	value,
		uint32_t	size
	)

pure virtualnoexcept

Serialize int32_t array.

Parameters

[in]	value	pointer to array to serialize.
	size	size of the array that is going to be serialized.

Returns: ReturnCode.

Implemented in eprosima::safedds::serialization::cdr::Serializer.

◆ serialize_array() [7/12]

virtual ReturnCode eprosima::safedds::serialization::ISerializer::serialize_array	(	const int64_t *	value,
		uint32_t	size
	)

pure virtualnoexcept

Serialize int64_t array.

Parameters

[in]	value	pointer to array to serialize.
	size	size of the array that is going to be serialized.

Returns: ReturnCode.

Implemented in eprosima::safedds::serialization::cdr::Serializer.

◆ serialize_array() [8/12]

virtual ReturnCode eprosima::safedds::serialization::ISerializer::serialize_array	(	const int8_t *	value,
		uint32_t	size
	)

pure virtualnoexcept

Serialize int8_t array.

Parameters

[in]	value	pointer to array to serialize.
	size	size of the array that is going to be serialized.

Returns: ReturnCode.

Implemented in eprosima::safedds::serialization::cdr::Serializer.

◆ serialize_array() [9/12]

virtual ReturnCode eprosima::safedds::serialization::ISerializer::serialize_array	(	const uint16_t *	value,
		uint32_t	size
	)

pure virtualnoexcept

Serialize uint16_t array.

Parameters

[in]	value	pointer to array to serialize.
	size	size of the array that is going to be serialized.

Returns: ReturnCode.

Implemented in eprosima::safedds::serialization::cdr::Serializer.

◆ serialize_array() [10/12]

virtual ReturnCode eprosima::safedds::serialization::ISerializer::serialize_array	(	const uint32_t *	value,
		uint32_t	size
	)

pure virtualnoexcept

Serialize uint32_t array.

Parameters

[in]	value	pointer to array to serialize.
	size	size of the array that is going to be serialized.

Returns: ReturnCode.

Implemented in eprosima::safedds::serialization::cdr::Serializer.

◆ serialize_array() [11/12]

virtual ReturnCode eprosima::safedds::serialization::ISerializer::serialize_array	(	const uint64_t *	value,
		uint32_t	size
	)

pure virtualnoexcept

Serialize uint64_t array.

Parameters

[in]	value	pointer to array to serialize.
	size	size of the array that is going to be serialized.

Returns: ReturnCode.

Implemented in eprosima::safedds::serialization::cdr::Serializer.

◆ serialize_array() [12/12]

virtual ReturnCode eprosima::safedds::serialization::ISerializer::serialize_array	(	const uint8_t *	value,
		uint32_t	size
	)

pure virtualnoexcept

Serialize uint8_t array.

Parameters

[in]	value	pointer to array to serialize.
	size	size of the array that is going to be serialized.

Returns: ReturnCode.

Implemented in eprosima::safedds::serialization::cdr::Serializer.

◆ serialize_sequence() [1/12]

virtual ReturnCode eprosima::safedds::serialization::ISerializer::serialize_sequence	(	const bool *	value,
		uint32_t	size
	)

pure virtualnoexcept

Serialize bool sequence.

Parameters

[in]	value	pointer to sequence to serialize.
	size	serialized size.

Returns: ReturnCode.

Implemented in eprosima::safedds::serialization::cdr::Serializer.

◆ serialize_sequence() [2/12]

virtual ReturnCode eprosima::safedds::serialization::ISerializer::serialize_sequence	(	const char *	value,
		uint32_t	size
	)

pure virtualnoexcept

Serialize sequence, implementations for each supported type: char bool uint8_t uint16_t uint32_t uint64_t int8_t int16_t int32_t int64_t float double.

Parameters

[in]	value	pointer to sequence to serialize.
	size	serialized size.

Returns: ReturnCode.

Implemented in eprosima::safedds::serialization::cdr::Serializer.

◆ serialize_sequence() [3/12]

virtual ReturnCode eprosima::safedds::serialization::ISerializer::serialize_sequence	(	const double *	value,
		uint32_t	size
	)

pure virtualnoexcept

Serialize double sequence.

Parameters

[in]	value	pointer to sequence to serialize.
	size	serialized size.

Returns: ReturnCode.

Implemented in eprosima::safedds::serialization::cdr::Serializer.

◆ serialize_sequence() [4/12]

virtual ReturnCode eprosima::safedds::serialization::ISerializer::serialize_sequence	(	const float *	value,
		uint32_t	size
	)

pure virtualnoexcept

Serialize float sequence.

Parameters

[in]	value	pointer to sequence to serialize.
	size	serialized size.

Returns: ReturnCode.

Implemented in eprosima::safedds::serialization::cdr::Serializer.

◆ serialize_sequence() [5/12]

virtual ReturnCode eprosima::safedds::serialization::ISerializer::serialize_sequence	(	const int16_t *	value,
		uint32_t	size
	)

pure virtualnoexcept

Serialize int16_t sequence.

Parameters

[in]	value	pointer to sequence to serialize.
	size	serialized size.

Returns: ReturnCode.

Implemented in eprosima::safedds::serialization::cdr::Serializer.

◆ serialize_sequence() [6/12]

virtual ReturnCode eprosima::safedds::serialization::ISerializer::serialize_sequence	(	const int32_t *	value,
		uint32_t	size
	)

pure virtualnoexcept

Serialize int32_t sequence.

Parameters

[in]	value	pointer to sequence to serialize.
	size	serialized size.

Returns: ReturnCode.

Implemented in eprosima::safedds::serialization::cdr::Serializer.

◆ serialize_sequence() [7/12]

virtual ReturnCode eprosima::safedds::serialization::ISerializer::serialize_sequence	(	const int64_t *	value,
		uint32_t	size
	)

pure virtualnoexcept

Serialize int64_t sequence.

Parameters

[in]	value	pointer to sequence to serialize.
	size	serialized size.

Returns: ReturnCode.

Implemented in eprosima::safedds::serialization::cdr::Serializer.

◆ serialize_sequence() [8/12]

virtual ReturnCode eprosima::safedds::serialization::ISerializer::serialize_sequence	(	const int8_t *	value,
		uint32_t	size
	)

pure virtualnoexcept

Serialize int8_t sequence.

Parameters

[in]	value	pointer to sequence to serialize.
	size	serialized size.

Returns: ReturnCode.

Implemented in eprosima::safedds::serialization::cdr::Serializer.

◆ serialize_sequence() [9/12]

virtual ReturnCode eprosima::safedds::serialization::ISerializer::serialize_sequence	(	const uint16_t *	value,
		uint32_t	size
	)

pure virtualnoexcept

Serialize uint16_t sequence.

Parameters

[in]	value	pointer to sequence to serialize.
	size	serialized size.

Returns: ReturnCode.

Implemented in eprosima::safedds::serialization::cdr::Serializer.

◆ serialize_sequence() [10/12]

virtual ReturnCode eprosima::safedds::serialization::ISerializer::serialize_sequence	(	const uint32_t *	value,
		uint32_t	size
	)

pure virtualnoexcept

Serialize uint32_t sequence.

Parameters

[in]	value	pointer to sequence to serialize.
	size	serialized size.

Returns: ReturnCode.

Implemented in eprosima::safedds::serialization::cdr::Serializer.

◆ serialize_sequence() [11/12]

virtual ReturnCode eprosima::safedds::serialization::ISerializer::serialize_sequence	(	const uint64_t *	value,
		uint32_t	size
	)

pure virtualnoexcept

Serialize uint64_t sequence.

Parameters

[in]	value	pointer to sequence to serialize.
	size	serialized size.

Returns: ReturnCode.

Implemented in eprosima::safedds::serialization::cdr::Serializer.

◆ serialize_sequence() [12/12]

virtual ReturnCode eprosima::safedds::serialization::ISerializer::serialize_sequence	(	const uint8_t *	value,
		uint32_t	size
	)

pure virtualnoexcept

Serialize uint8_t sequence.

Parameters

[in]	value	pointer to sequence to serialize.
	size	serialized size.

Returns: ReturnCode.

Implemented in eprosima::safedds::serialization::cdr::Serializer.

◆ serializer_align_to()

virtual ReturnCode eprosima::safedds::serialization::ISerializer::serializer_align_to ( uint32_t type_size )

pure virtualnoexcept

Aligns serializer position.

Parameters

type_size type size.

Returns: ReturnCode.

Implemented in eprosima::safedds::serialization::cdr::Serializer.

◆ serializer_remaining_size()

virtual uint32_t eprosima::safedds::serialization::ISerializer::serializer_remaining_size ( )

pure virtualnoexcept

Returns remaining available size of serializer.

Returns: Remaining size.

Implemented in eprosima::safedds::serialization::cdr::Serializer.

◆ serializer_skip()

virtual ReturnCode eprosima::safedds::serialization::ISerializer::serializer_skip ( uint32_t size )

pure virtualnoexcept

Skips slice in serialization process.

Parameters

size	size to skip

Returns: ReturnCode

Implemented in eprosima::safedds::serialization::cdr::Serializer.

◆ serializer_used_size()

virtual uint32_t eprosima::safedds::serialization::ISerializer::serializer_used_size ( )

pure virtualnoexcept

Gets serializer used size.

Returns: Used size.

Implemented in eprosima::safedds::serialization::cdr::Serializer.

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

build/docs/user_manual/main/tmp/include/safedds/serialization/ISerializer.hpp

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~ISerializer()

◆ ISerializer() [1/3]

◆ ISerializer() [2/3]

◆ ISerializer() [3/3]

Member Function Documentation

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ reset_alignment()

◆ serialize() [1/12]

◆ serialize() [2/12]

◆ serialize() [3/12]

◆ serialize() [4/12]

◆ serialize() [5/12]

◆ serialize() [6/12]

◆ serialize() [7/12]

◆ serialize() [8/12]

◆ serialize() [9/12]

◆ serialize() [10/12]

◆ serialize() [11/12]

◆ serialize() [12/12]

◆ serialize_array() [1/12]

◆ serialize_array() [2/12]

◆ serialize_array() [3/12]

◆ serialize_array() [4/12]

◆ serialize_array() [5/12]

◆ serialize_array() [6/12]

◆ serialize_array() [7/12]

◆ serialize_array() [8/12]

◆ serialize_array() [9/12]

◆ serialize_array() [10/12]

◆ serialize_array() [11/12]

◆ serialize_array() [12/12]

◆ serialize_sequence() [1/12]

◆ serialize_sequence() [2/12]

◆ serialize_sequence() [3/12]

◆ serialize_sequence() [4/12]

◆ serialize_sequence() [5/12]

◆ serialize_sequence() [6/12]

◆ serialize_sequence() [7/12]

◆ serialize_sequence() [8/12]

◆ serialize_sequence() [9/12]

◆ serialize_sequence() [10/12]

◆ serialize_sequence() [11/12]

◆ serialize_sequence() [12/12]

◆ serializer_align_to()

◆ serializer_remaining_size()

◆ serializer_skip()

◆ serializer_used_size()