asio C++ library

PrevUpHomeNext

SSL shutdown token requirements

A shutdown token is a completion token for completion signature void(error_code).

Examples

A free function as a shutdown token:

void shutdown_handler(
    const asio::error_code& ec)
{
  ...
}

A shutdown token function object:

struct shutdown_handler
{
  ...
  void operator()(
      const asio::error_code& ec)
  {
    ...
  }
  ...
};

A lambda as a shutdown token:

ssl_stream.async_shutdown(...,
    [](const asio::error_code& ec)
    {
      ...
    });

A non-static class member function adapted to a shutdown token using std::bind():

void my_class::shutdown_handler(
    const asio::error_code& ec)
{
  ...
}
...
ssl_stream.async_shutdown(...,
    std::bind(&my_class::shutdown_handler,
      this, std::placeholders::_1));

A non-static class member function adapted to a shutdown token using boost::bind():

void my_class::shutdown_handler(
    const asio::error_code& ec)
{
  ...
}
...
ssl_stream.async_shutdown(...,
    boost::bind(&my_class::shutdown_handler,
      this, asio::placeholders::error));

Using use_future as a shutdown token:

std::future<void> f = ssl_stream.async_shutdown(..., asio::use_future);
...
try
{
  f.get();
}
catch (const system_error& e)
{
  ...
}

Using use_awaitable as a shutdown token:

asio::awaitable<void> my_coroutine()
{
  try
  {
    ...
    co_await ssl_stream.async_shutdown(..., asio::use_awaitable);
    ...
  }
  catch (const system_error& e)
  {
    ...
  }
}

PrevUpHomeNext