Boost C++ Libraries

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

PrevUpHomeNext

Write token requirements

A write token is a completion token for completion signature void(error_code, size_t).

Examples

A free function as a write token:

void write_handler(
    const boost::system::error_code& ec,
    std::size_t bytes_transferred)
{
  ...
}

A write token function object:

struct write_handler
{
  ...
  void operator()(
      const boost::system::error_code& ec,
      std::size_t bytes_transferred)
  {
    ...
  }
  ...
};

A lambda as a write token:

socket.async_write_some(...,
    [](const boost::system::error_code& ec,
      std::size_t bytes_transferred)
    {
      ...
    });

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

void my_class::write_handler(
    const boost::system::error_code& ec,
    std::size_t bytes_transferred)
{
  ...
}
...
socket.async_write_some(...,
    std::bind(&my_class::write_handler,
      this, std::placeholders::_1,
      std::placeholders::_2));

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

void my_class::write_handler(
    const boost::system::error_code& ec,
    std::size_t bytes_transferred)
{
  ...
}
...
socket.async_write_some(...,
    boost::bind(&my_class::write_handler,
      this, boost::asio::placeholders::error,
      boost::asio::placeholders::bytes_transferred));

Using use_future as a write token:

std::future<std::size_t> f =
  socket.async_write_some(..., boost::asio::use_future);
...
try
{
  std::size_t n = f.get();
  ...
}
catch (const system_error& e)
{
  ...
}

Using use_awaitable as a write token:

boost::asio::awaitable<void> my_coroutine()
{
  try
  {
    ...
    std::size_t n =
      co_await socket.async_write_some(
          ..., boost::asio::use_awaitable);
    ...
  }
  catch (const system_error& e)
  {
    ...
  }
}

PrevUpHomeNext