Immutable class to store received tcp message. More...

#include <tcp_message.h>

Public Types
enum class	SocketState : std::uint8_t { kIdle = 0x00 , kSocketOnline , kSocketOffline , kSocketRxMessageReceived , kSocketTxMessageSend , kSocketTxMessageConf , kSocketError }
	Definition of different socket state. More...

enum class	SocketError : std::uint8_t { kNone = 0x00 }
	Definition of different socket error that could occur. More...

using	BufferType = std::vector< std::uint8_t >
	Type alias for underlying buffer. More...

using	IpAddressType = std::string_view
	Type alias of IP address type. More...

Public Member Functions
	TcpMessage (IpAddressType host_ip_address, std::uint16_t host_port_number, BufferType payload)
	Constructs an instance of TcpMessage. More...

	TcpMessage (TcpMessage &&other) noexcept=default

TcpMessage &	operator= (TcpMessage &&other) noexcept=default

	TcpMessage (const TcpMessage &other)=default

TcpMessage &	operator= (const TcpMessage &other)=default

	~TcpMessage ()=default
	Destructs an instance of TcpMessage. More...

IpAddressType	GetHostIpAddress () const
	Get the host ip address. More...

std::uint16_t	GetHostPortNumber () const
	Get the host port number. More...

core_type::Span< std::uint8_t const >	GetPayload () const
	Get the readable view on received payload. More...

SocketState	GetSocketState () const
	Get the state of underlying socket. More...

SocketError	GetSocketError () const
	Get the error of underlying socket. More...

Private Attributes
SocketState	socket_state_
	Store the socket state. More...

SocketError	socket_error_
	Store the socket error. More...

BufferType	payload_
	The reception buffer. More...

std::string	host_ip_address_
	Store remote ip address. More...

std::uint16_t	host_port_number_
	Store remote port number. More...

Detailed Description

Immutable class to store received tcp message.

Definition at line 26 of file tcp_message.h.

Member Typedef Documentation

◆ BufferType

using boost_support::message::tcp::TcpMessage::BufferType = std::vector<std::uint8_t>

Type alias for underlying buffer.

Definition at line 49 of file tcp_message.h.

◆ IpAddressType

using boost_support::message::tcp::TcpMessage::IpAddressType = std::string_view

Type alias of IP address type.

Definition at line 54 of file tcp_message.h.

Member Enumeration Documentation

◆ SocketError

enum boost_support::message::tcp::TcpMessage::SocketError : std::uint8_t

strong

Definition of different socket error that could occur.

Enumerator
kNone

Definition at line 44 of file tcp_message.h.

44 : std::uint8_t { kNone = 0x00 };

◆ SocketState

enum boost_support::message::tcp::TcpMessage::SocketState : std::uint8_t

strong

Definition of different socket state.

Enumerator
kIdle
kSocketOnline
kSocketOffline
kSocketRxMessageReceived
kSocketTxMessageSend
kSocketTxMessageConf
kSocketError

Definition at line 31 of file tcp_message.h.

                          : std::uint8_t {
     kIdle = 0x00,
     kSocketOnline,
     kSocketOffline,
     kSocketRxMessageReceived,
     kSocketTxMessageSend,
     kSocketTxMessageConf,
     kSocketError
   };

Constructor & Destructor Documentation

◆ TcpMessage() [1/3]

boost_support::message::tcp::TcpMessage::TcpMessage	(	IpAddressType	host_ip_address,
		std::uint16_t	host_port_number,
		BufferType	payload
	)

inline

Constructs an instance of TcpMessage.

Parameters

[in]	host_ip_address	The host ip address
[in]	host_port_number	The host port number
[in]	payload	The received data payload

Definition at line 66 of file tcp_message.h.

       : socket_state_{SocketState::kIdle},
         socket_error_{SocketError::kNone},
         payload_{std::move(payload)},
         host_ip_address_{host_ip_address},
         host_port_number_{host_port_number} {}

◆ TcpMessage() [2/3]

boost_support::message::tcp::TcpMessage::TcpMessage ( TcpMessage && other )

defaultnoexcept

◆ TcpMessage() [3/3]

boost_support::message::tcp::TcpMessage::TcpMessage ( const TcpMessage & other )

default

◆ ~TcpMessage()

boost_support::message::tcp::TcpMessage::~TcpMessage ( )

default

Destructs an instance of TcpMessage.

Member Function Documentation

◆ GetHostIpAddress()

IpAddressType boost_support::message::tcp::TcpMessage::GetHostIpAddress ( ) const

inline

Get the host ip address.

Returns: The IP address

Definition at line 88 of file tcp_message.h.

88 { return host_ip_address_; }

References host_ip_address_.

◆ GetHostPortNumber()

std::uint16_t boost_support::message::tcp::TcpMessage::GetHostPortNumber ( ) const

inline

Get the host port number.

Returns: The port number

Definition at line 94 of file tcp_message.h.

94 { return host_port_number_; }

References host_port_number_.

◆ GetPayload()

core_type::Span<std::uint8_t const> boost_support::message::tcp::TcpMessage::GetPayload ( ) const

inline

Get the readable view on received payload.

Returns: The view on payload

Definition at line 100 of file tcp_message.h.

                                                      {
     return core_type::Span<std::uint8_t const>{payload_};
   }

References payload_.

◆ GetSocketError()

SocketError boost_support::message::tcp::TcpMessage::GetSocketError ( ) const

inline

Get the error of underlying socket.

Returns: The socket error

Definition at line 114 of file tcp_message.h.

114 { return socket_error_; }

References socket_error_.

◆ GetSocketState()

SocketState boost_support::message::tcp::TcpMessage::GetSocketState ( ) const

inline

Get the state of underlying socket.

Returns: The socket state

Definition at line 108 of file tcp_message.h.

108 { return socket_state_; }

References socket_state_.

◆ operator=() [1/2]

TcpMessage& boost_support::message::tcp::TcpMessage::operator= ( const TcpMessage & other )

default

◆ operator=() [2/2]

TcpMessage& boost_support::message::tcp::TcpMessage::operator= ( TcpMessage && other )

defaultnoexcept

Member Data Documentation

◆ host_ip_address_

std::string boost_support::message::tcp::TcpMessage::host_ip_address_

private

Store remote ip address.

Definition at line 135 of file tcp_message.h.

Referenced by GetHostIpAddress().

◆ host_port_number_

std::uint16_t boost_support::message::tcp::TcpMessage::host_port_number_

private

Store remote port number.

Definition at line 140 of file tcp_message.h.

Referenced by GetHostPortNumber().

◆ payload_

BufferType boost_support::message::tcp::TcpMessage::payload_

private

The reception buffer.

Definition at line 130 of file tcp_message.h.

Referenced by GetPayload().

◆ socket_error_

SocketError boost_support::message::tcp::TcpMessage::socket_error_

private

Store the socket error.

Definition at line 125 of file tcp_message.h.

Referenced by GetSocketError().

◆ socket_state_

SocketState boost_support::message::tcp::TcpMessage::socket_state_

private

Store the socket state.

Definition at line 120 of file tcp_message.h.

Referenced by GetSocketState().

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

/home/runner/work/diag-client-lib/diag-client-lib/diag-client-lib/lib/boost-support/include/boost-support/message/tcp/tcp_message.h

Public Types

Public Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ BufferType

◆ IpAddressType

Member Enumeration Documentation

◆ SocketError

◆ SocketState

Constructor & Destructor Documentation

◆ TcpMessage() [1/3]

◆ TcpMessage() [2/3]

◆ TcpMessage() [3/3]

◆ ~TcpMessage()

Member Function Documentation

◆ GetHostIpAddress()

◆ GetHostPortNumber()

◆ GetPayload()

◆ GetSocketError()

◆ GetSocketState()

◆ operator=() [1/2]

◆ operator=() [2/2]

Member Data Documentation

◆ host_ip_address_

◆ host_port_number_

◆ payload_

◆ socket_error_

◆ socket_state_