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

This is the documentation for an old version of Boost. Click here to view this page for the latest version.
PrevUpHomeNext
ssl::stream::async_handshake (1 of 2 overloads)

Start an asynchronous SSL handshake.

template<
    typename HandshakeHandler = DEFAULT>
DEDUCED async_handshake(
    handshake_type type,
    HandshakeHandler && handler = DEFAULT);

This function is used to asynchronously perform an SSL handshake on the stream. This function call always returns immediately.

Parameters

type

The type of handshaking to be performed, i.e. as a client or as a server.

handler

The handler to be called when the handshake operation completes. Copies will be made of the handler as required. The equivalent function signature of the handler must be:

void handler(
  const boost::system::error_code& error // Result of operation.
);

Per-Operation Cancellation

This asynchronous operation supports cancellation for the following cancellation_type values:

if they are also supported by the Stream type's async_read_some and async_write_some operations.


PrevUpHomeNext