boost_support::server::tcp::TcpAcceptor::TcpAcceptorImpl Class Reference

Public Types
using	TcpSocket = socket::tcp::TcpSocket
	Type alias for tcp unsecured socket. More...

Public Member Functions
	TcpAcceptorImpl (std::string_view acceptor_name, std::string_view local_ip_address, std::uint16_t local_port_num, std::uint8_t maximum_connection) noexcept
	Constructs an instance of Acceptor. More...
std::optional< TcpServer >	GetTcpServer () noexcept
	Get a tcp 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...
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

Definition at line 41 of file tcp_acceptor.cpp.

Member Typedef Documentation

Acceptor

using boost_support::server::tcp::TcpAcceptor::TcpAcceptorImpl::Acceptor = boost::asio::ip::tcp::acceptor

private

Type alias for tcp acceptor.

Definition at line 106 of file tcp_acceptor.cpp.

TcpSocket

using boost_support::server::tcp::TcpAcceptor::TcpAcceptorImpl::TcpSocket = socket::tcp::TcpSocket

Type alias for tcp unsecured socket.

Definition at line 46 of file tcp_acceptor.cpp.

Constructor & Destructor Documentation

TcpAcceptorImpl()

boost_support::server::tcp::TcpAcceptor::TcpAcceptorImpl::TcpAcceptorImpl ( std::string_view  acceptor_name, std::string_view  local_ip_address, std::uint16_t  local_port_num, std::uint8_t  maximum_connection  )

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 59 of file tcp_acceptor.cpp.

      : io_context_{},
        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

GetTcpServer()

std::optional<TcpServer> boost_support::server::tcp::TcpAcceptor::TcpAcceptorImpl::GetTcpServer ( )

inlinenoexcept

Get a tcp server ready to communicate.

This blocks until new server is created

Returns

Tcp server object on success, else nothing

Definition at line 75 of file tcp_acceptor.cpp.

                                                 {
    using TcpErrorCodeType = boost::system::error_code;
    std::optional<TcpServer> tcp_server{};
    TcpErrorCodeType ec{};
    Tcp::endpoint endpoint{};
 
    // blocking accept
    TcpSocket::Socket accepted_socket{acceptor_.accept(endpoint, ec)};
    if (ec.value() == boost::system::errc::success) {
      tcp_server.emplace(CreateServerName(acceptor_name_, server_count_),
                         TcpSocket{std::move(accepted_socket)});
      common::logger::LibBoostLogger::GetLibBoostLogger().GetLogger().LogDebug(
          FILE_NAME, __LINE__, __func__, [&endpoint](std::stringstream &msg) {
            msg << "Tcp 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 tcp_server;
  }

References acceptor_, acceptor_name_, boost_support::server::tcp::anonymous_namespace{tcp_acceptor.cpp}::CreateServerName(), FILE_NAME, boost_support::common::logger::LibBoostLogger::GetLibBoostLogger(), and server_count_.

Here is the call graph for this function:

Member Data Documentation

acceptor_

Acceptor boost_support::server::tcp::TcpAcceptor::TcpAcceptorImpl::acceptor_

private

Store the tcp acceptor.

Definition at line 126 of file tcp_acceptor.cpp.

Referenced by GetTcpServer().

acceptor_name_

std::string boost_support::server::tcp::TcpAcceptor::TcpAcceptorImpl::acceptor_name_

private

Store the name of the acceptor.

Definition at line 121 of file tcp_acceptor.cpp.

Referenced by GetTcpServer().

io_context_

boost::asio::io_context boost_support::server::tcp::TcpAcceptor::TcpAcceptorImpl::io_context_

private

Store the io context.

Definition at line 111 of file tcp_acceptor.cpp.

server_count_

std::uint16_t boost_support::server::tcp::TcpAcceptor::TcpAcceptorImpl::server_count_

private

Keeps the count of server created.

Definition at line 116 of file tcp_acceptor.cpp.

Referenced by GetTcpServer().

---

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_acceptor.cpp