boost_support::server::tls::TlsAcceptor< TlsVersion >::TlsAcceptorImpl Class Reference

Collaboration diagram for boost_support::server::tls::TlsAcceptor< TlsVersion >::TlsAcceptorImpl:

Public Types
using	TlsSocket = socket::tls::TlsSocket
	Type alias for tcp secured socket. More...
using	TlsContext = socket::tls::TlsContext
	Type alias for tls context. More...

Public Member Functions
	TlsAcceptorImpl (std::string_view acceptor_name, std::string_view local_ip_address, std::uint16_t local_port_num, std::uint8_t maximum_connection, TlsVersion tls_version, std::string_view certificate_path, std::string_view private_key_path) noexcept
	Constructs an instance of Acceptor. More...
std::optional< TlsServer >	GetTlsServer () noexcept
	Get a tls server ready to communicate. More...

Private Types
using	Acceptor = boost::asio::ip::tcp::acceptor
	Type alias for tcp acceptor. More...

Private Attributes
boost::asio::io_context	io_context_
	Store the io context. More...
TlsContext	tls_context_
	Store the tls context. More...
std::uint16_t	server_count_
	Keeps the count of server created. More...
std::string	acceptor_name_
	Store the name of the acceptor. More...
Acceptor	acceptor_
	Store the tcp acceptor. More...

Detailed Description

template<typename TlsVersion>
class boost_support::server::tls::TlsAcceptor< TlsVersion >::TlsAcceptorImpl

Definition at line 44 of file tls_acceptor.cpp.

Member Typedef Documentation

Acceptor

template<typename TlsVersion >

using boost_support::server::tls::TlsAcceptor< TlsVersion >::TlsAcceptorImpl::Acceptor = boost::asio::ip::tcp::acceptor

private

Type alias for tcp acceptor.

Definition at line 117 of file tls_acceptor.cpp.

TlsContext

template<typename TlsVersion >

using boost_support::server::tls::TlsAcceptor< TlsVersion >::TlsAcceptorImpl::TlsContext = socket::tls::TlsContext

Type alias for tls context.

Definition at line 54 of file tls_acceptor.cpp.

TlsSocket

template<typename TlsVersion >

using boost_support::server::tls::TlsAcceptor< TlsVersion >::TlsAcceptorImpl::TlsSocket = socket::tls::TlsSocket

Type alias for tcp secured socket.

Definition at line 49 of file tls_acceptor.cpp.

Constructor & Destructor Documentation

TlsAcceptorImpl()

template<typename TlsVersion >

boost_support::server::tls::TlsAcceptor< TlsVersion >::TlsAcceptorImpl::TlsAcceptorImpl ( std::string_view  acceptor_name, std::string_view  local_ip_address, std::uint16_t  local_port_num, std::uint8_t  maximum_connection, TlsVersion  tls_version, std::string_view  certificate_path, std::string_view  private_key_path  )

inlinenoexcept

Constructs an instance of Acceptor.

Tcp connection shall be accepted on this ip address and port

Parameters

[in]	local_ip_address	The local ip address
[in]	local_port_num	The local port number
[in]	maximum_connection	The maximum number of accepted connection

Definition at line 67 of file tls_acceptor.cpp.

      : io_context_{},
        tls_context_{std::forward<TlsVersion>(tls_version), certificate_path, private_key_path},
        server_count_{0u},
        acceptor_name_{acceptor_name},
        acceptor_{io_context_,
                  Tcp::endpoint(TcpIpAddress::from_string(std::string{local_ip_address}.c_str()),
                                local_port_num)} {
    acceptor_.listen(maximum_connection);
  }

Member Function Documentation

GetTlsServer()

template<typename TlsVersion >

std::optional<TlsServer> boost_support::server::tls::TlsAcceptor< TlsVersion >::TlsAcceptorImpl::GetTlsServer ( )

inlinenoexcept

Get a tls server ready to communicate.

This blocks until new server is created

Returns

Tcp server object on success, else nothing

Definition at line 86 of file tls_acceptor.cpp.

                                                 {
    using TcpErrorCodeType = boost::system::error_code;
    std::optional<TlsServer> tls_server{};
    TcpErrorCodeType ec{};
    Tcp::endpoint endpoint{};
 
    // blocking accept
    TlsSocket::TcpSocket accepted_socket{acceptor_.accept(endpoint, ec)};
    if (ec.value() == boost::system::errc::success) {
      tls_server.emplace(CreateServerName(acceptor_name_, server_count_),
                         TlsSocket{std::move(accepted_socket), tls_context_});
      common::logger::LibBoostLogger::GetLibBoostLogger().GetLogger().LogDebug(
          FILE_NAME, __LINE__, __func__, [&endpoint](std::stringstream &msg) {
            msg << "Tls socket connection received from client "
                << "<" << endpoint.address().to_string() << "," << endpoint.port() << ">";
          });
      // increment the server count
      server_count_++;
    } else {
      common::logger::LibBoostLogger::GetLibBoostLogger().GetLogger().LogError(
          FILE_NAME, __LINE__, __func__, [ec](std::stringstream &msg) {
            msg << "Tcp socket accept failed with error: " << ec.message();
          });
    }
    return tls_server;
  }

References boost_support::server::tls::anonymous_namespace{tls_acceptor.cpp}::CreateServerName(), FILE_NAME, and boost_support::common::logger::LibBoostLogger::GetLibBoostLogger().

Here is the call graph for this function:

Member Data Documentation

acceptor_

template<typename TlsVersion >

Acceptor boost_support::server::tls::TlsAcceptor< TlsVersion >::TlsAcceptorImpl::acceptor_

private

Store the tcp acceptor.

Definition at line 142 of file tls_acceptor.cpp.

acceptor_name_

template<typename TlsVersion >

std::string boost_support::server::tls::TlsAcceptor< TlsVersion >::TlsAcceptorImpl::acceptor_name_

private

Store the name of the acceptor.

Definition at line 137 of file tls_acceptor.cpp.

io_context_

template<typename TlsVersion >

boost::asio::io_context boost_support::server::tls::TlsAcceptor< TlsVersion >::TlsAcceptorImpl::io_context_

private

Store the io context.

Definition at line 122 of file tls_acceptor.cpp.

server_count_

template<typename TlsVersion >

std::uint16_t boost_support::server::tls::TlsAcceptor< TlsVersion >::TlsAcceptorImpl::server_count_

private

Keeps the count of server created.

Definition at line 132 of file tls_acceptor.cpp.

tls_context_

template<typename TlsVersion >

TlsContext boost_support::server::tls::TlsAcceptor< TlsVersion >::TlsAcceptorImpl::tls_context_

private

Store the tls context.

Definition at line 127 of file tls_acceptor.cpp.

---

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/tls/tls_acceptor.cpp