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 a snapshot of the develop branch, built from commit ecbc607568.
PrevUpHomeNext
ssl_stream::async_handshake (2 of 2 overloads)

Start an asynchronous SSL handshake.

Synopsis
template<
    class ConstBufferSequence,
    class BufferedHandshakeHandler = net::default_completion_token_t<executor_type>>
DEDUCED
async_handshake(
    handshake_type type,
    ConstBufferSequence const& buffers,
    BOOST_ASIO_MOVE_ARG(BufferedHandshakeHandler) handler = net::default_completion_token_t< executor_type >{});
Description

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

Parameters

Name

Description

type

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

buffers

The buffered data to be reused for the handshake. Although the buffers object may be copied as necessary, ownership of the underlying buffers is retained by the caller, which must guarantee that they remain valid until the handler is called.

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.
  std::size_t bytes_transferred // Amount of buffers used in handshake.
);

PrevUpHomeNext