#include <classic_protocol_message.h>

Public Types
using	string_type = std::conditional_t< Borrowed, std::string_view, std::string >

Public Member Functions
constexpr	Greeting (classic_protocol::capabilities::value_type capabilities, uint32_t max_packet_size, uint8_t collation, string_type username, string_type auth_method_data, string_type schema, string_type auth_method_name, string_type attributes)
	construct a client::Greeting message. More...

constexpr classic_protocol::capabilities::value_type	capabilities () const

constexpr void	capabilities (classic_protocol::capabilities::value_type caps)

constexpr uint32_t	max_packet_size () const noexcept

constexpr void	max_packet_size (uint32_t sz) noexcept

constexpr uint8_t	collation () const noexcept

constexpr void	collation (uint8_t coll) noexcept

constexpr string_type	username () const

constexpr void	username (const string_type &v)

constexpr string_type	auth_method_data () const

constexpr void	auth_method_data (const string_type &v)

constexpr string_type	schema () const

constexpr void	schema (const string_type &schema)

constexpr string_type	auth_method_name () const
	name of the auth-method that was explicitly set. More...

constexpr void	auth_method_name (const string_type &name)

constexpr string_type	attributes () const

constexpr void	attributes (const string_type &attrs)

Private Attributes
classic_protocol::capabilities::value_type	capabilities_

uint32_t	max_packet_size_

uint8_t	collation_

string_type	username_

string_type	auth_method_data_

string_type	schema_

string_type	auth_method_name_

string_type	attributes_

Member Typedef Documentation

◆ string_type

template<bool Borrowed>

using classic_protocol::borrowable::message::client::Greeting< Borrowed >::string_type = std::conditional_t<Borrowed, std::string_view, std::string>

Constructor & Destructor Documentation

◆ Greeting()

template<bool Borrowed>

constexpr classic_protocol::borrowable::message::client::Greeting< Borrowed >::Greeting	(	classic_protocol::capabilities::value_type	capabilities,
		uint32_t	max_packet_size,
		uint8_t	collation,
		string_type	username,
		string_type	auth_method_data,
		string_type	schema,
		string_type	auth_method_name,
		string_type	attributes
	)

inlineconstexpr

construct a client::Greeting message.

Parameters

capabilities	protocol capabilities of the client
max_packet_size	max size of the frame::Frame client wants to send
collation	initial collation of connection
username	username to authenticate as
auth_method_data	auth-method specific data like hashed password
schema	initial schema of the newly authenticated session
auth_method_name	auth-method the data is for
attributes	session-attributes

Member Function Documentation

◆ attributes() [1/2]

template<bool Borrowed>

constexpr string_type classic_protocol::borrowable::message::client::Greeting< Borrowed >::attributes ( ) const

inlineconstexpr

◆ attributes() [2/2]

template<bool Borrowed>

constexpr void classic_protocol::borrowable::message::client::Greeting< Borrowed >::attributes ( const string_type & attrs )

inlineconstexpr

◆ auth_method_data() [1/2]

template<bool Borrowed>

constexpr string_type classic_protocol::borrowable::message::client::Greeting< Borrowed >::auth_method_data ( ) const

inlineconstexpr

◆ auth_method_data() [2/2]

template<bool Borrowed>

constexpr void classic_protocol::borrowable::message::client::Greeting< Borrowed >::auth_method_data ( const string_type & v )

inlineconstexpr

◆ auth_method_name() [1/2]

template<bool Borrowed>

constexpr string_type classic_protocol::borrowable::message::client::Greeting< Borrowed >::auth_method_name ( ) const

inlineconstexpr

name of the auth-method that was explicitly set.

use classic_protocol::AuthMethod() to get the effective auth-method which may be announced though capability flags (like if capabilities::plugin_auth wasn't set)

◆ auth_method_name() [2/2]

template<bool Borrowed>

constexpr void classic_protocol::borrowable::message::client::Greeting< Borrowed >::auth_method_name ( const string_type & name )

inlineconstexpr

◆ capabilities() [1/2]

template<bool Borrowed>

constexpr classic_protocol::capabilities::value_type classic_protocol::borrowable::message::client::Greeting< Borrowed >::capabilities ( ) const

inlineconstexpr

◆ capabilities() [2/2]

template<bool Borrowed>

constexpr void classic_protocol::borrowable::message::client::Greeting< Borrowed >::capabilities ( classic_protocol::capabilities::value_type caps )

inlineconstexpr

◆ collation() [1/2]

template<bool Borrowed>

constexpr uint8_t classic_protocol::borrowable::message::client::Greeting< Borrowed >::collation ( ) const

inlineconstexprnoexcept

◆ collation() [2/2]

template<bool Borrowed>

constexpr void classic_protocol::borrowable::message::client::Greeting< Borrowed >::collation ( uint8_t coll )

inlineconstexprnoexcept

◆ max_packet_size() [1/2]

template<bool Borrowed>

constexpr uint32_t classic_protocol::borrowable::message::client::Greeting< Borrowed >::max_packet_size ( ) const

inlineconstexprnoexcept

◆ max_packet_size() [2/2]

template<bool Borrowed>

constexpr void classic_protocol::borrowable::message::client::Greeting< Borrowed >::max_packet_size ( uint32_t sz )

inlineconstexprnoexcept

◆ schema() [1/2]

template<bool Borrowed>

constexpr string_type classic_protocol::borrowable::message::client::Greeting< Borrowed >::schema ( ) const

inlineconstexpr

◆ schema() [2/2]

template<bool Borrowed>

constexpr void classic_protocol::borrowable::message::client::Greeting< Borrowed >::schema ( const string_type & schema )

inlineconstexpr

◆ username() [1/2]

template<bool Borrowed>

constexpr string_type classic_protocol::borrowable::message::client::Greeting< Borrowed >::username ( ) const

inlineconstexpr

◆ username() [2/2]

template<bool Borrowed>

constexpr void classic_protocol::borrowable::message::client::Greeting< Borrowed >::username ( const string_type & v )

inlineconstexpr

Member Data Documentation

◆ attributes_

template<bool Borrowed>

string_type classic_protocol::borrowable::message::client::Greeting< Borrowed >::attributes_

private

◆ auth_method_data_

template<bool Borrowed>

string_type classic_protocol::borrowable::message::client::Greeting< Borrowed >::auth_method_data_

private

◆ auth_method_name_

template<bool Borrowed>

string_type classic_protocol::borrowable::message::client::Greeting< Borrowed >::auth_method_name_

private

◆ capabilities_

template<bool Borrowed>

classic_protocol::capabilities::value_type classic_protocol::borrowable::message::client::Greeting< Borrowed >::capabilities_

private

◆ collation_

template<bool Borrowed>

uint8_t classic_protocol::borrowable::message::client::Greeting< Borrowed >::collation_

private

◆ max_packet_size_

template<bool Borrowed>

uint32_t classic_protocol::borrowable::message::client::Greeting< Borrowed >::max_packet_size_

private

◆ schema_

template<bool Borrowed>

string_type classic_protocol::borrowable::message::client::Greeting< Borrowed >::schema_

private

◆ username_

template<bool Borrowed>

string_type classic_protocol::borrowable::message::client::Greeting< Borrowed >::username_

private

The documentation for this class was generated from the following file:

router/src/mysql_protocol/include/mysqlrouter/classic_protocol_message.h

Public Types

Public Member Functions

Private Attributes

Member Typedef Documentation

◆ string_type

Constructor & Destructor Documentation

◆ Greeting()

Member Function Documentation

◆ attributes() [1/2]

◆ attributes() [2/2]

◆ auth_method_data() [1/2]

◆ auth_method_data() [2/2]

◆ auth_method_name() [1/2]

◆ auth_method_name() [2/2]

◆ capabilities() [1/2]

◆ capabilities() [2/2]

◆ collation() [1/2]

◆ collation() [2/2]

◆ max_packet_size() [1/2]

◆ max_packet_size() [2/2]

◆ schema() [1/2]

◆ schema() [2/2]

◆ username() [1/2]

◆ username() [2/2]

Member Data Documentation

◆ attributes_

◆ auth_method_data_

◆ auth_method_name_

◆ capabilities_

◆ collation_

◆ max_packet_size_

◆ schema_

◆ username_