basic_socket_acceptor::async_accept (6 of 8 overloads)

Start an asynchronous accept.

template<
    typename MoveAcceptHandler = DEFAULT>
DEDUCED async_accept(
    endpoint_type & peer_endpoint,
    MoveAcceptHandler && handler = DEFAULT);

This function is used to asynchronously accept a new connection. The function call always returns immediately.

This overload requires that the Protocol template parameter satisfy the AcceptableProtocol type requirements.

Parameters

peer_endpoint

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.

handler

The handler to be called when the accept operation completes. Copies will be made of the handler as required. The function signature of the handler must be:

void handler(
  // Result of operation.
  const asio::error_code& error,
  // On success, the newly accepted socket.
  typename Protocol::socket::template
    rebind_executor<executor_type>::other peer
);

Regardless of whether the asynchronous operation completes immediately or not, the 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.

Example

void accept_handler(const asio::error_code& error,
    asio::ip::tcp::socket peer)
{
  if (!error)
  {
    // Accept succeeded.
  }
}

...

asio::ip::tcp::acceptor acceptor(my_context);
...
asio::ip::tcp::endpoint endpoint;
acceptor.async_accept(endpoint, accept_handler);

Per-Operation Cancellation

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