Boost C++ Libraries of the most highly regarded and expertly designed C++ library projects in the world. Herb Sutter and Andrei Alexandrescu, C++ Coding Standards



Inherited from basic_socket.

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

    typename WaitHandler = DEFAULT>
DEDUCED async_wait(
    wait_type w,
    WaitHandler && handler = DEFAULT);

This function is used to perform an asynchronous wait for a socket to enter a ready to read, write or error condition state.



Specifies the desired socket state.


The handler to be called when the wait operation completes. Copies will be made of the handler as required. The function signature of the 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 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 wait_handler(const boost::system::error_code& error)
  if (!error)
    // Wait succeeded.


boost::asio::ip::tcp::socket socket(my_context);
socket.async_wait(boost::asio::ip::tcp::socket::wait_read, wait_handler);
Per-Operation Cancellation

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