AimRT/_deps/boost-src/libs/asio/doc/requirements/RangeConnectToken.qbk
2025-01-12 20:37:50 +08:00

115 lines
2.7 KiB
Plaintext

[/
/ Copyright (c) 2003-2023 Christopher M. Kohlhoff (chris at kohlhoff dot com)
/
/ Distributed under the Boost Software License, Version 1.0. (See accompanying
/ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
/]
[section:RangeConnectToken Range connect token requirements]
A range connect token is a [link boost_asio.overview.model.completion_tokens
completion token] for completion signature `void(error_code, typename
Protocol::endpoint)`, where the type `Protocol` is used in the corresponding
`async_connect()` function.
[heading Examples]
A free function as a range connect token:
void connect_handler(
const boost::system::error_code& ec,
const boost::asio::ip::tcp::endpoint& endpoint)
{
...
}
A range connect token function object:
struct connect_handler
{
...
template <typename Range>
void operator()(
const boost::system::error_code& ec,
const boost::asio::ip::tcp::endpoint& endpoint)
{
...
}
...
};
A lambda as a range connect token:
boost::asio::async_connect(...,
[](const boost::system::error_code& ec,
const boost::asio::ip::tcp::endpoint& endpoint)
{
...
});
A non-static class member function adapted to a range connect token using
`std::bind()`:
void my_class::connect_handler(
const boost::system::error_code& ec,
const boost::asio::ip::tcp::endpoint& endpoint)
{
...
}
...
boost::asio::async_connect(...,
std::bind(&my_class::connect_handler,
this, std::placeholders::_1,
std::placeholders::_2));
A non-static class member function adapted to a range connect token using
`boost::bind()`:
void my_class::connect_handler(
const boost::system::error_code& ec,
const boost::asio::ip::tcp::endpoint& endpoint)
{
...
}
...
boost::asio::async_connect(...,
boost::bind(&my_class::connect_handler,
this, boost::asio::placeholders::error,
boost::asio::placeholders::endpoint));
Using [link boost_asio.reference.use_future use_future] as a range connect token:
std::future<boost::asio::ip::tcp::endpoint> f =
boost::asio::async_connect(..., boost::asio::use_future);
...
try
{
boost::asio::ip::tcp::endpoint e = f.get();
...
}
catch (const system_error& e)
{
...
}
Using [link boost_asio.reference.use_awaitable use_awaitable] as a range connect
token:
boost::asio::awaitable<void> my_coroutine()
{
try
{
...
boost::asio::ip::tcp::endpoint e =
co_await boost::asio::async_connect(
..., boost::asio::use_awaitable);
...
}
catch (const system_error& e)
{
...
}
}
[endsect]