MySQL 8.4.0
Source Code Documentation
PluginConfig Class Reference
Inheritance diagram for PluginConfig:
[legend]

Public Member Functions

 PluginConfig (const mysql_harness::ConfigSection *section)
 
std::string get_default (std::string_view option) const override
 Gets the default for the given option. More...
 
bool is_required (std::string_view option) const override
 Returns whether the given option is required. More...
 
- Public Member Functions inherited from mysql_harness::BasePluginConfig
 BasePluginConfig ()=default
 
 BasePluginConfig (const BasePluginConfig &)=default
 
 BasePluginConfig (BasePluginConfig &&)=default
 
BasePluginConfigoperator= (const BasePluginConfig &)=default
 
BasePluginConfigoperator= (BasePluginConfig &&)=default
 
virtual ~BasePluginConfig ()=default
 destructor More...
 
std::string get_option_description (const mysql_harness::ConfigSection *section, std::string_view option) const
 get description of the option. More...
 
template<class Func >
decltype(auto) get_option (const mysql_harness::ConfigSection *section, std::string_view option, Func &&transformer) const
 get option value. More...
 
template<class Func >
decltype(auto) get_option_no_default (const mysql_harness::ConfigSection *section, std::string_view option, Func &&transformer) const
 get option value. More...
 
std::string get_option_string (const mysql_harness::ConfigSection *section, std::string_view option) const
 Gets value of given option as string. More...
 
template<class T >
get_uint_option (const mysql_harness::ConfigSection *section, std::string_view option, T min_value=0, T max_value=std::numeric_limits< T >::max()) const
 Gets an unsigned integer using the given option. More...
 
std::chrono::milliseconds get_option_milliseconds (const mysql_harness::ConfigSection *section, std::string_view option, double min_value=0.0, double max_value=std::numeric_limits< double >::max()) const
 Gets a number of milliseconds using the given option. More...
 

Public Attributes

std::string trace_filename
 
std::vector< std::string > module_prefixes
 
std::string srv_address
 
uint16_t srv_port
 
std::string srv_protocol
 
std::string ssl_ca
 
std::string ssl_capath
 
std::string ssl_cert
 
std::string ssl_key
 
std::string ssl_cipher
 
std::string ssl_crl
 
std::string ssl_crlpath
 
mysql_ssl_mode ssl_mode
 
std::string tls_version
 

Additional Inherited Members

- Protected Member Functions inherited from mysql_harness::BasePluginConfig
 BasePluginConfig (const mysql_harness::ConfigSection *section)
 Constructor for derived classes. More...
 
- Static Protected Member Functions inherited from mysql_harness::BasePluginConfig
static std::string get_section_name (const mysql_harness::ConfigSection *section)
 Generate the name for this configuration. More...
 

Constructor & Destructor Documentation

◆ PluginConfig()

PluginConfig::PluginConfig ( const mysql_harness::ConfigSection section)
inlineexplicit

Member Function Documentation

◆ get_default()

std::string PluginConfig::get_default ( std::string_view  option) const
inlineoverridevirtual

Gets the default for the given option.

Gets the default value of the given option. If no default option is available, an empty string is returned.

Parameters
optionname of the option
Returns
default value for given option as std::string

Implements mysql_harness::BasePluginConfig.

◆ is_required()

bool PluginConfig::is_required ( std::string_view  option) const
inlineoverridevirtual

Returns whether the given option is required.

Returns
bool

Implements mysql_harness::BasePluginConfig.

Member Data Documentation

◆ module_prefixes

std::vector<std::string> PluginConfig::module_prefixes

◆ srv_address

std::string PluginConfig::srv_address

◆ srv_port

uint16_t PluginConfig::srv_port

◆ srv_protocol

std::string PluginConfig::srv_protocol

◆ ssl_ca

std::string PluginConfig::ssl_ca

◆ ssl_capath

std::string PluginConfig::ssl_capath

◆ ssl_cert

std::string PluginConfig::ssl_cert

◆ ssl_cipher

std::string PluginConfig::ssl_cipher

◆ ssl_crl

std::string PluginConfig::ssl_crl

◆ ssl_crlpath

std::string PluginConfig::ssl_crlpath

◆ ssl_key

std::string PluginConfig::ssl_key

◆ ssl_mode

mysql_ssl_mode PluginConfig::ssl_mode

◆ tls_version

std::string PluginConfig::tls_version

◆ trace_filename

std::string PluginConfig::trace_filename

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