boost_support::server::tcp::TcpServer::TcpServerImpl Class Reference

Collaboration diagram for boost_support::server::tcp::TcpServer::TcpServerImpl:

Public Types
using	TcpConnection = connection::tcp::TcpConnection< connection::tcp::ConnectionType::kServer, TcpSocket >
	Type alias for tcp server connection. More...

Public Member Functions
	TcpServerImpl (std::string_view server_name, TcpSocket tcp_socket) noexcept
	Constructs an instance of TcpServerImpl. More...
	TcpServerImpl (const TcpServerImpl &other) noexcept=delete
	Deleted copy assignment and copy constructor. More...
TcpServerImpl &	operator= (const TcpServerImpl &other) noexcept=delete
	TcpServerImpl (TcpServerImpl &&other) noexcept=delete
	Deleted move assignment and move constructor. More...
TcpServerImpl &	operator= (TcpServerImpl &&other) noexcept=delete
	~TcpServerImpl () noexcept=default
	Destruct an instance of TcpServerImpl. More...
void	Initialize () noexcept
	Initialize the TcpServerImpl. More...
void	DeInitialize () noexcept
	De-initialize the TcpServerImpl. More...
void	SetReadHandler (HandlerRead read_handler) noexcept
	Function to set the read handler that is invoked when message is received. More...
core_type::Result< void >	Transmit (MessageConstPtr tcp_message)
	Function to transmit the provided tcp message. More...

Private Attributes
TcpConnection	tcp_connection_
	Store the tcp connection. More...

Detailed Description

Definition at line 18 of file tcp_server.cpp.

Member Typedef Documentation

TcpConnection

using boost_support::server::tcp::TcpServer::TcpServerImpl::TcpConnection = connection::tcp::TcpConnection<connection::tcp::ConnectionType::kServer, TcpSocket>

Type alias for tcp server connection.

Definition at line 23 of file tcp_server.cpp.

Constructor & Destructor Documentation

TcpServerImpl() [1/3]

boost_support::server::tcp::TcpServer::TcpServerImpl::TcpServerImpl ( std::string_view  server_name, TcpSocket  tcp_socket  )

inlineexplicitnoexcept

Constructs an instance of TcpServerImpl.

Parameters

[in]

tcp_socket

The underlying tcp socket required for communication

Definition at line 31 of file tcp_server.cpp.

      : tcp_connection_{server_name, std::move(tcp_socket)} {}

TcpServerImpl() [2/3]

boost_support::server::tcp::TcpServer::TcpServerImpl::TcpServerImpl ( const TcpServerImpl &  other )

deletenoexcept

Deleted copy assignment and copy constructor.

TcpServerImpl() [3/3]

boost_support::server::tcp::TcpServer::TcpServerImpl::TcpServerImpl ( TcpServerImpl &&  other )

deletenoexcept

Deleted move assignment and move constructor.

~TcpServerImpl()

boost_support::server::tcp::TcpServer::TcpServerImpl::~TcpServerImpl ( )

defaultnoexcept

Destruct an instance of TcpServerImpl.

Member Function Documentation

DeInitialize()

void boost_support::server::tcp::TcpServer::TcpServerImpl::DeInitialize ( )

inlinenoexcept

De-initialize the TcpServerImpl.

Definition at line 59 of file tcp_server.cpp.

{ tcp_connection_.DeInitialize(); }

References tcp_connection_.

Initialize()

void boost_support::server::tcp::TcpServer::TcpServerImpl::Initialize ( )

inlinenoexcept

Initialize the TcpServerImpl.

Definition at line 54 of file tcp_server.cpp.

{ tcp_connection_.Initialize(); }

References tcp_connection_.

operator=() [1/2]

TcpServerImpl& boost_support::server::tcp::TcpServer::TcpServerImpl::operator= ( const TcpServerImpl &  other )

deletenoexcept

operator=() [2/2]

TcpServerImpl& boost_support::server::tcp::TcpServer::TcpServerImpl::operator= ( TcpServerImpl &&  other )

deletenoexcept

SetReadHandler()

void boost_support::server::tcp::TcpServer::TcpServerImpl::SetReadHandler ( HandlerRead  read_handler )

inlinenoexcept

Function to set the read handler that is invoked when message is received.

The ownership of provided read handler is moved

Parameters

[in]

read_handler

The handler to be set

Definition at line 67 of file tcp_server.cpp.

                                                         {
    tcp_connection_.SetReadHandler(std::move(read_handler));
  }

References tcp_connection_.

Transmit()

core_type::Result<void> boost_support::server::tcp::TcpServer::TcpServerImpl::Transmit ( MessageConstPtr  tcp_message )

inline

Function to transmit the provided tcp message.

Parameters

[in]

tcp_message

The tcp message

Returns

Empty void on success, otherwise error is returned

Definition at line 77 of file tcp_server.cpp.

                                                              {
    return tcp_connection_.Transmit(std::move(tcp_message));
  }

References tcp_connection_.

Member Data Documentation

tcp_connection_

TcpConnection boost_support::server::tcp::TcpServer::TcpServerImpl::tcp_connection_

private

Store the tcp connection.

Definition at line 85 of file tcp_server.cpp.

Referenced by DeInitialize(), Initialize(), SetReadHandler(), and Transmit().

---

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/src/boost-support/server/tcp/tcp_server.cpp