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

handshake_params

handshake_params

(Legacy) Parameters defining how to perform the handshake with a MySQL server.

Synopsis

Defined in header <boost/mysql/handshake_params.hpp>

class handshake_params;

Member Functions

Name	Description
connection_collation	Retrieves the connection collation.
database	Retrieves the database name to use when connecting.
handshake_params [constructor]	Initializing constructor.
multi_queries	Retrieves whether multi-query support is enabled.
password	Retrieves the password.
set_connection_collation	Sets the connection collation.
set_database	Sets the database name to use when connecting.
set_multi_queries	Enables or disables support for the multi-query feature.
set_password	Sets the password.
set_ssl	Sets the SSL mode.
set_username	Sets the username.
ssl	Retrieves the SSL mode.
username	Retrieves the username.

Static Members

Name	Description
default_collation	The default collation to use with the connection (`utf8mb4_general_ci` on both MySQL and MariaDB).

Object lifetimes

This object stores references to strings (like username and password), performing no copy of these values. Users are resposible for keeping them alive until required.

Legacy

This class is used with the legacy connection class. New code should use any_connection, instead. The equivalent to handshake_params is connect_params.

Convenience header <boost/mysql.hpp>