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

The acceptor to create new tcp servers. More...

#include <tcp_acceptor.h>

Classes
class	TcpAcceptorImpl

Public Member Functions
	TcpAcceptor (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...
	~TcpAcceptor () noexcept
	Destruct an instance of TcpAcceptor. More...
std::optional< TcpServer >	GetTcpServer () noexcept
	Get a tcp server ready to communicate. More...

Private Attributes
std::unique_ptr< TcpAcceptorImpl >	tcp_acceptor_impl_
	Unique pointer to tcp acceptor implementation. More...

Detailed Description

The acceptor to create new tcp servers.

Definition at line 20 of file tcp_acceptor.h.

Constructor & Destructor Documentation

TcpAcceptor()

boost_support::server::tcp::TcpAcceptor::TcpAcceptor ( 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.

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 allowed

Definition at line 129 of file tcp_acceptor.cpp.

    : tcp_acceptor_impl_{std::make_unique<TcpAcceptorImpl>(acceptor_name, local_ip_address,
                                                           local_port_num, maximum_connection)} {}

~TcpAcceptor()

boost_support::server::tcp::TcpAcceptor::~TcpAcceptor ( )

defaultnoexcept

Destruct an instance of TcpAcceptor.

Member Function Documentation

GetTcpServer()

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

noexcept

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

                                                          {
  return tcp_acceptor_impl_->GetTcpServer();
}

References GetTcpServer().

Referenced by GetTcpServer().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

tcp_acceptor_impl_

std::unique_ptr<TcpAcceptorImpl> boost_support::server::tcp::TcpAcceptor::tcp_acceptor_impl_

private

Unique pointer to tcp acceptor implementation.

Definition at line 56 of file tcp_acceptor.h.

---

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/tcp/tcp_acceptor.h
• /home/runner/work/diag-client-lib/diag-client-lib/diag-client-lib/lib/boost-support/src/boost-support/server/tcp/tcp_acceptor.cpp