...one 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 SSL handshake.
template< typename HandshakeToken = default_completion_token_t<executor_type>> DEDUCED async_handshake( handshake_type type, HandshakeToken && token = default_completion_token_t< executor_type >());
This function is used to asynchronously perform an SSL handshake on the stream. It is an initiating function for an asynchronous operation, and always returns immediately.
The type of handshaking to be performed, i.e. as a client or as a server.
The completion
token that will be used to produce a completion handler,
which will be called when the handshake 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 async_immediate
.
void(boost::system::error_code)
This asynchronous operation supports cancellation for the following
cancellation_type
values:
cancellation_type::terminal
cancellation_type::partial
if they are also supported by the Stream
type's async_read_some
and async_write_some
operations.