asio C++ library

PrevUpHomeNext
ssl::stream::async_handshake (2 of 2 overloads)

Start an asynchronous SSL handshake.

template<
    typename ConstBufferSequence,
    typename BufferedHandshakeHandler>
void-or-deduced async_handshake(
    handshake_type type,
    const ConstBufferSequence & buffers,
    BufferedHandshakeHandler && handler);

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.

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 asio::error_code& error, // Result of operation.
  std::size_t bytes_transferred // Amount of buffers used in handshake.
);


PrevUpHomeNext