...one of the most highly
regarded and expertly designed C++ library projects in the
world.
— Herb Sutter and Andrei
Alexandrescu, C++
Coding Standards
Start an asynchronous accept.
template< typename Executor1, typename AcceptToken = DEFAULT> DEDUCED async_accept( basic_socket< protocol_type, Executor1 > & peer, endpoint_type & peer_endpoint, AcceptToken && token = DEFAULT);
This function is used to asynchronously accept a new connection into a socket, and additionally obtain the endpoint of the remote peer. It is an initiating function for an asynchronous operation, and always returns immediately.
The socket into which the new connection will be accepted. Ownership of the peer object is retained by the caller, which must guarantee that it is valid until the completion handler is called.
An endpoint object into which the endpoint of the remote peer will be written. Ownership of the peer_endpoint object is retained by the caller, which must guarantee that it is valid until the handler is called.
The completion
token that will be used to produce a completion handler,
which will be called when the accept completes. Potential completion
tokens include use_future
, use_awaitable
, yield_context
, or a function
object with the correct completion signature. The function signature
of the completion handler must be:
void handler( const boost::system::error_code& error // Result of operation. );
Regardless of whether the asynchronous operation completes immediately
or not, the completion handler will not be invoked from within
this function. On immediate completion, invocation of the handler
will be performed in a manner equivalent to using post
.
void(boost::system::error_code)
On POSIX or Windows operating systems, this asynchronous operation supports
cancellation for the following cancellation_type
values:
cancellation_type::terminal
cancellation_type::partial
cancellation_type::total