Boost C++ Libraries

Performs the MySQL-level handshake.

Synopsis

template<
    class CompletionToken>
auto
async_handshake(
    const handshake_params& params,
    diagnostics& diag,
    CompletionToken&& token);

Description

Does not connect the underlying stream. If the Stream template parameter fulfills the SocketConnection requirements, use connection::connect instead of this function.

If using a SSL-capable stream, the SSL handshake will be performed by this function.

Object lifetimes

The strings pointed to by params should be kept alive by the caller until the operation completes, as no copy is made by the library.

Handler signature

The handler signature for this operation is void(boost::mysql::error_code).

Executor

Intermediate completion handlers, as well as the final handler, are executed using token's associated executor, or this->get_executor() if the token doesn't have an associated executor.

If the final handler has an associated immediate executor, and the operation completes immediately, the final handler is dispatched to it. Otherwise, the final handler is called as if it was submitted using asio::post, and is never be called inline from within this function.