Network stream message container. (TCP). More...

#include <stream-message.hpp>

Public Member Functions
	StreamMessage () noexcept
	Creates a new empty stream message.
	StreamMessage (::StreamMessage streamMessage) noexcept
	Creates a new stream message. (TCP).
const uint8_t *	getEnd () const noexcept
	Returns stream message end pointer.
bool	isComplete () const noexcept
	Returns true if stream message is not empty and complete, otherwise false.
size_t	getLeft () const noexcept
	Returns stream message byte count left to read or write.
bool	read (const void *&data, size_t count) noexcept
	Reads data from the stream message and advances offset.
bool	read (uint8_t &value) noexcept
	Reads 8-bit unsigned integer value from the stream message and advances offset.
bool	read (uint16_t &value) noexcept
	Reads 16-bit unsigned integer value from the stream message and advances offset.
bool	read (uint32_t &value) noexcept
	Reads 32-bit unsigned integer value from the stream message and advances offset.
bool	read (uint64_t &value) noexcept
	Reads 64-bit unsigned integer value from the stream message and advances offset.
bool	read (int8_t &value) noexcept
	Reads 8-bit signed integer value from the stream message and advances offset.
bool	read (int16_t &value) noexcept
	Reads 16-bit signed integer value from the stream message and advances offset.
bool	read (int32_t &value) noexcept
	Reads 32-bit signed integer value from the stream message and advances offset.
bool	read (int64_t &value) noexcept
	Reads 64-bit signed integer value from the stream message and advances offset.
bool	read (float &value) noexcept
	Reads 32-bit floating point value from the stream message and advances offset.
bool	read (double &value) noexcept
	Reads 64-bit floating point value from the stream message and advances offset.
bool	read (std::string_view &value, uint8_t lengthSize) noexcept
	Reads string from the stream message and advances offset.
bool	read (std::string &value, uint8_t lengthSize) noexcept
	Reads string from the stream message and advances offset.
bool	read (bool &value) noexcept
	Reads boolean value from the stream message and advances offset.
bool	read (const void *&data, size_t &dataSize, uint8_t lengthSize) noexcept
	Reads data from the stream message and advances offset.
template<class T>
bool	read (std::vector< T > &data, uint8_t lengthSize) noexcept
	Reads vector data from the stream message and advances offset.

Data Fields
uint8_t *	iter

Static Public Attributes
static constexpr uint8_t	maxLengthSize = STREAM_MESSAGE_MAX_LENGTH_SIZE
	Maximum size of the stream message length in bytes.
static constexpr uint16_t	maxDatagramSize = MAX_DATAGRAM_MESSAGE_SIZE
	Safe maximum UDP datagram size in bytes. (Includes IP and VPN overhead).

Protected Attributes
uint8_t *	end

Detailed Description

Network stream message container. (TCP).

See the stream-message.h

Constructor & Destructor Documentation

◆ StreamMessage()

StreamMessage ( ::StreamMessage streamMessage )

inlinenoexcept

Creates a new stream message. (TCP).

Parameters

streamMessage target stream message data

Member Function Documentation

◆ isComplete()

bool isComplete ( ) const

inlinenoexcept

Returns true if stream message is not empty and complete, otherwise false.

See the isStreamMessageComplete().

◆ getLeft()

size_t getLeft ( ) const

inlinenoexcept

Returns stream message byte count left to read or write.

See the getStreamMessageLeft().

◆ read() [1/16]

bool read	(	const void *&	data,
		size_t	count )

inlinenoexcept

Reads data from the stream message and advances offset.

See the readStreamMessage().

Returns: True if no more data to read, otherwise false.

Parameters

[out]	data	reference to the message data
	count	message byte count to read

◆ read() [2/16]

bool read ( uint8_t & value )

inlinenoexcept

Reads 8-bit unsigned integer value from the stream message and advances offset.

See the readStreamMessageUint8().

Returns: True if no more data to read, otherwise false.

Parameters

[out] value reference to the unsigned integer value

◆ read() [3/16]

bool read ( uint16_t & value )

inlinenoexcept

Reads 16-bit unsigned integer value from the stream message and advances offset.

See the readStreamMessageUint16().

Returns: True if no more data to read, otherwise false.

Parameters

[out] value reference to the unsigned integer value

◆ read() [4/16]

bool read ( uint32_t & value )

inlinenoexcept

Reads 32-bit unsigned integer value from the stream message and advances offset.

See the readStreamMessageUint32().

Returns: True if no more data to read, otherwise false.

Parameters

[out] value reference to the unsigned integer value

◆ read() [5/16]

bool read ( uint64_t & value )

inlinenoexcept

Reads 64-bit unsigned integer value from the stream message and advances offset.

See the readStreamMessageUint64().

Returns: True if no more data to read, otherwise false.

Parameters

[out] value reference to the unsigned integer value

◆ read() [6/16]

bool read ( int8_t & value )

inlinenoexcept

Reads 8-bit signed integer value from the stream message and advances offset.

See the readStreamMessageInt8().

Returns: True if no more data to read, otherwise false.

Parameters

[out] value reference to the signed integer value

◆ read() [7/16]

bool read ( int16_t & value )

inlinenoexcept

Reads 16-bit signed integer value from the stream message and advances offset.

See the readStreamMessageInt16().

Returns: True if no more data to read, otherwise false.

Parameters

[out] value reference to the signed integer value

◆ read() [8/16]

bool read ( int32_t & value )

inlinenoexcept

Reads 32-bit signed integer value from the stream message and advances offset.

See the readStreamMessageInt32().

Returns: True if no more data to read, otherwise false.

Parameters

[out] value reference to the signed integer value

◆ read() [9/16]

bool read ( int64_t & value )

inlinenoexcept

Reads 64-bit signed integer value from the stream message and advances offset.

See the readStreamMessageInt64().

Returns: True if no more data to read, otherwise false.

Parameters

[out] value reference to the signed integer value

◆ read() [10/16]

bool read ( float & value )

inlinenoexcept

Reads 32-bit floating point value from the stream message and advances offset.

See the readStreamMessageFloat32().

Returns: True if no more data to read, otherwise false.

Parameters

[out] value reference to the floating point value

◆ read() [11/16]

bool read ( double & value )

inlinenoexcept

Reads 64-bit floating point value from the stream message and advances offset.

See the readStreamMessageFloat64().

Returns: True if no more data to read, otherwise false.

Parameters

[out] value reference to the floating point value

◆ read() [12/16]

bool read	(	std::string_view &	value,
		uint8_t	lengthSize )

inlinenoexcept

Reads string from the stream message and advances offset.

See the readStreamMessageData().

Returns: True if no more data to read, otherwise false.

Parameters

[out]	value	reference to the message string
	lengthSize	length of the string size in bytes

◆ read() [13/16]

bool read	(	std::string &	value,
		uint8_t	lengthSize )

inlinenoexcept

Reads string from the stream message and advances offset.

See the readStreamMessageData().

Returns: True if no more data to read, otherwise false.

Parameters

[out]	value	reference to the message string
	lengthSize	length of the string size in bytes

◆ read() [14/16]

bool read ( bool & value )

inlinenoexcept

Reads boolean value from the stream message and advances offset.

See the readStreamMessageBool().

Returns: True if no more data to read, otherwise false.

Parameters

[out] value reference to the boolean value

◆ read() [15/16]

bool read	(	const void *&	data,
		size_t &	dataSize,
		uint8_t	lengthSize )

inlinenoexcept

Reads data from the stream message and advances offset.

See the readStreamMessageData().

Returns: True if no more data to read, otherwise false.

Parameters

[out]	data	reference to the message data
[out]	dataSize	reference to the data size in bytes
	lengthSize	length of the data size in bytes

◆ read() [16/16]

template<class T>

bool read	(	std::vector< T > &	data,
		uint8_t	lengthSize )

inlinenoexcept

Reads vector data from the stream message and advances offset.

See the readStreamMessageData().

Returns: True if no more data to read, otherwise false.

Template Parameters

T	type of the vector data

Parameters

[out]	data	reference to the message data vector
	lengthSize	length of the data size in bytes

Public Member Functions

Data Fields

Static Public Attributes

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ StreamMessage()

Member Function Documentation

◆ isComplete()

◆ getLeft()

◆ read() [1/16]

◆ read() [2/16]

◆ read() [3/16]

◆ read() [4/16]

◆ read() [5/16]

◆ read() [6/16]

◆ read() [7/16]

◆ read() [8/16]

◆ read() [9/16]

◆ read() [10/16]

◆ read() [11/16]

◆ read() [12/16]

◆ read() [13/16]

◆ read() [14/16]

◆ read() [15/16]

◆ read() [16/16]