100 lines
2.0 KiB
Plaintext
100 lines
2.0 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:ShutdownToken SSL shutdown token requirements]
|
|
|
|
A shutdown token is a [link boost_asio.overview.model.completion_tokens completion
|
|
token] for completion signature `void(error_code)`.
|
|
|
|
[heading Examples]
|
|
|
|
A free function as a shutdown token:
|
|
|
|
void shutdown_handler(
|
|
const boost::system::error_code& ec)
|
|
{
|
|
...
|
|
}
|
|
|
|
A shutdown token function object:
|
|
|
|
struct shutdown_handler
|
|
{
|
|
...
|
|
void operator()(
|
|
const boost::system::error_code& ec)
|
|
{
|
|
...
|
|
}
|
|
...
|
|
};
|
|
|
|
A lambda as a shutdown token:
|
|
|
|
ssl_stream.async_shutdown(...,
|
|
[](const boost::system::error_code& ec)
|
|
{
|
|
...
|
|
});
|
|
|
|
A non-static class member function adapted to a shutdown token using
|
|
`std::bind()`:
|
|
|
|
void my_class::shutdown_handler(
|
|
const boost::system::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 boost::system::error_code& ec)
|
|
{
|
|
...
|
|
}
|
|
...
|
|
ssl_stream.async_shutdown(...,
|
|
boost::bind(&my_class::shutdown_handler,
|
|
this, boost::asio::placeholders::error));
|
|
|
|
Using [link boost_asio.reference.use_future use_future] as a shutdown token:
|
|
|
|
std::future<void> f = ssl_stream.async_shutdown(..., boost::asio::use_future);
|
|
...
|
|
try
|
|
{
|
|
f.get();
|
|
}
|
|
catch (const system_error& e)
|
|
{
|
|
...
|
|
}
|
|
|
|
Using [link boost_asio.reference.use_awaitable use_awaitable] as a shutdown token:
|
|
|
|
boost::asio::awaitable<void> my_coroutine()
|
|
{
|
|
try
|
|
{
|
|
...
|
|
co_await ssl_stream.async_shutdown(..., boost::asio::use_awaitable);
|
|
...
|
|
}
|
|
catch (const system_error& e)
|
|
{
|
|
...
|
|
}
|
|
}
|
|
|
|
[endsect]
|