Boost C++ Libraries Home Libraries People FAQ More

PrevUpHomeNext
any_connection::async_connect (3 of 3 overloads)

Establishes a connection to a MySQL server.

Synopsis
template<
    class CompletionToken>
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. This function has the same behavior as the other async_connect overloads, but perform less copies.

Object lifetimes

Zero-copy overload: no copies of the value pointed to by params will be made. It must be kept alive for the duration of the operation, until the final completion handler is called. If you are in doubt, prefer the overloads taking a const connect_params&, which will ensure lifetime correctness for you.

Preconditions

params != nullptr

Handler signature

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


PrevUpHomeNext