boost::asio::basic_socket_acceptor::async_wait

Asynchronously wait for the acceptor to become ready to read, ready to write, or to have pending error conditions.

Synopsis

Declared in <boost/asio/basic_socket_acceptor.hpp>

template<boost::asio::completion_token_for<void(boost::system::error_code)> WaitToken = default_completion_token_t<executor_type>>
decltype(async_initiate<WaitToken, void (boost::system::error_code)>(
        declval<initiate_async_wait>(), token, w))
async_wait(
    wait_type w,
    WaitToken&& token = default_completion_token_t<executor_type>());

Description

This function is used to perform an asynchronous wait for an acceptor to enter a ready to read, write or error condition state. It is an initiating function for an asynchronous_operation, and always returns immediately.

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 boost::asio::async_immediate().

Completion Signature

void(boost::system::error_code)

Example

void wait_handler(const boost::system::error_code& error)
{
  if (!error)
  {
    // Wait succeeded.
  }
}

...

boost::asio::ip::tcp::acceptor acceptor(my_context);
...
acceptor.async_wait(
    boost::asio::ip::tcp::acceptor::wait_read,
    wait_handler);

Per‐Operation Cancellation

On POSIX or Windows operating systems, this asynchronous operation supports cancellation for the following boost::asio::cancellation_type values:

  • cancellation_type::terminal

  • cancellation_type::partial

  • cancellation_type::total

Parameters

Name

Description

w

Specifies the desired acceptor state.

token

The completion_token that will be used to produce a completion handler, which will be called when the wait 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:

Created with MrDocs

Edit this Page