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



Start an asynchronous wait on the object handle.

    typename WaitToken = default_completion_token_t<executor_type>>
DEDUCED async_wait(
    WaitToken && token = default_completion_token_t< executor_type >());

This function is be used to initiate an asynchronous wait against the object handle. It is an initiating function for an asynchronous operation, and always returns immediately.



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:

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.

Completion Signature