boost_support::server::tls::TlsServer Class Reference

Server that manages unsecured/ secured tcp connection. More...

#include <tls_server.h>

Classes
class	TlsServerImpl

Public Types
using	TlsSocket = socket::tls::TlsSocket
	Type alias for tcp unsecured socket. More...
using	Message = boost_support::message::tcp::TcpMessage
	Type alias for Tcp message. More...
using	MessagePtr = boost_support::message::tcp::TcpMessagePtr
	Type alias for Tcp message pointer. More...
using	MessageConstPtr = boost_support::message::tcp::TcpMessageConstPtr
	Type alias for Tcp message const pointer. More...
using	HandlerRead = std::function< void(MessagePtr)>
	Tcp function template used for reception. More...

Public Member Functions
	TlsServer (std::string_view server_name, TlsSocket tls_socket) noexcept
	Constructs an instance of TlsServer. More...
	TlsServer (const TlsServer &other) noexcept=delete
	Deleted copy assignment and copy constructor. More...
TlsServer &	operator= (const TlsServer &other) noexcept=delete
	TlsServer (TlsServer &&other) noexcept
	Move assignment and move constructor. More...
TlsServer &	operator= (TlsServer &&other) noexcept
	~TlsServer () noexcept
	Destruct an instance of TcpServer. More...
void	Initialize () noexcept
	Initialize the server. More...
void	DeInitialize () noexcept
	De-initialize the server. 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
std::unique_ptr< TlsServerImpl >	tls_server_impl_
	Unique pointer to tcp server implementation. More...

Detailed Description

Server that manages unsecured/ secured tcp connection.

Definition at line 30 of file tls_server.h.

Member Typedef Documentation

HandlerRead

using boost_support::server::tls::TlsServer::HandlerRead = std::function<void(MessagePtr)>

Tcp function template used for reception.

Definition at line 55 of file tls_server.h.

Message

using boost_support::server::tls::TlsServer::Message = boost_support::message::tcp::TcpMessage

Type alias for Tcp message.

Definition at line 40 of file tls_server.h.

MessageConstPtr

using boost_support::server::tls::TlsServer::MessageConstPtr = boost_support::message::tcp::TcpMessageConstPtr

Type alias for Tcp message const pointer.

Definition at line 50 of file tls_server.h.

MessagePtr

using boost_support::server::tls::TlsServer::MessagePtr = boost_support::message::tcp::TcpMessagePtr

Type alias for Tcp message pointer.

Definition at line 45 of file tls_server.h.

TlsSocket

using boost_support::server::tls::TlsServer::TlsSocket = socket::tls::TlsSocket

Type alias for tcp unsecured socket.

Definition at line 35 of file tls_server.h.

Constructor & Destructor Documentation

TlsServer() [1/3]

boost_support::server::tls::TlsServer::TlsServer ( std::string_view  server_name, TlsServer::TlsSocket  tls_socket  )

explicitnoexcept

Constructs an instance of TlsServer.

Parameters

[in]

tls_socket

The underlying tls socket required for communication

Definition at line 93 of file tls_server.cpp.

    : tls_server_impl_{std::make_unique<TlsServerImpl>(server_name, std::move(tls_socket))} {}

TlsServer() [2/3]

boost_support::server::tls::TlsServer::TlsServer ( const TlsServer &  other )

deletenoexcept

Deleted copy assignment and copy constructor.

TlsServer() [3/3]

boost_support::server::tls::TlsServer::TlsServer ( TlsServer &&  other )

defaultnoexcept

Move assignment and move constructor.

~TlsServer()

boost_support::server::tls::TlsServer::~TlsServer ( )

defaultnoexcept

Destruct an instance of TcpServer.

Member Function Documentation

DeInitialize()

void boost_support::server::tls::TlsServer::DeInitialize ( )

noexcept

De-initialize the server.

Definition at line 104 of file tls_server.cpp.

{ tls_server_impl_->DeInitialize(); }

References tls_server_impl_.

Initialize()

void boost_support::server::tls::TlsServer::Initialize ( )

noexcept

Initialize the server.

Definition at line 102 of file tls_server.cpp.

{ tls_server_impl_->Initialize(); }

References Initialize().

Referenced by Initialize().

Here is the call graph for this function:

Here is the caller graph for this function:

operator=() [1/2]

TlsServer& boost_support::server::tls::TlsServer::operator= ( const TlsServer &  other )

deletenoexcept

operator=() [2/2]

TlsServer & boost_support::server::tls::TlsServer::operator= ( TlsServer &&  other )

defaultnoexcept

SetReadHandler()

void boost_support::server::tls::TlsServer::SetReadHandler ( TlsServer::HandlerRead  read_handler )

noexcept

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 106 of file tls_server.cpp.

                                                                         {
  tls_server_impl_->SetReadHandler(std::move(read_handler));
}

Transmit()

core_type::Result< void > boost_support::server::tls::TlsServer::Transmit

(

TlsServer::MessageConstPtr

tcp_message

)

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 110 of file tls_server.cpp.

                                                                              {
  return tls_server_impl_->Transmit(std::move(tcp_message));
}

References tls_server_impl_.

Member Data Documentation

tls_server_impl_

std::unique_ptr<TlsServerImpl> boost_support::server::tls::TlsServer::tls_server_impl_

private

Unique pointer to tcp server implementation.

Definition at line 117 of file tls_server.h.

Referenced by DeInitialize(), and Transmit().

---

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

• /home/runner/work/diag-client-lib/diag-client-lib/diag-client-lib/lib/boost-support/include/boost-support/server/tls/tls_server.h
• /home/runner/work/diag-client-lib/diag-client-lib/diag-client-lib/lib/boost-support/src/boost-support/server/tls/tls_server.cpp