Boost C++ Libraries Home Libraries People FAQ More

PrevUpHomeNext
any_connection::async_connect (1 of 2 overloads)

Establishes a connection to a MySQL server.

Synopsis
template<
    class CompletionToken = with_diagnostics_t<asio::deferred_t>>
auto
async_connect(
    const connect_params& params,
    diagnostics& diag,
    CompletionToken&& token = {});
Description

This function performs the following:

You can configure some options using the connect_params struct.

The decision to use TLS or not is performed using the following:

If params.connection_collation is within a set of well-known collations, this function sets the current character set, such that current_character_set returns a non-null value. The default collation (utf8mb4_general_ci) is the only one guaranteed to be in the set of well-known collations.

Object lifetimes

params needs to be kept alive until the operation completes, as no copies will be 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.


PrevUpHomeNext