MySQL 9.7.0
Source Code Documentation
HostCachePluginConfig Class Reference

#include <host_cache_plugin_config.h>

Inheritance diagram for HostCachePluginConfig:
[legend]

Public Member Functions

 HostCachePluginConfig (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...
 
void expose_configuration (const mysql_harness::ConfigSection &default_section, const bool initial) const
 
 HostCachePluginConfig (const mysql_harness::ConfigSection *section, ResolveActions &ra)
 
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 >
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

ResolveActionsactions_
 
- Public Attributes inherited from HostCacheConfig
uint32_t max_entries_
 
uint32_t ttl_success_
 
uint32_t ttl_negative_
 
double ttl_jitter_ratio_
 
bool enabled_
 

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

◆ HostCachePluginConfig() [1/2]

HostCachePluginConfig::HostCachePluginConfig ( const mysql_harness::ConfigSection section)
explicit

◆ HostCachePluginConfig() [2/2]

HostCachePluginConfig::HostCachePluginConfig ( const mysql_harness::ConfigSection section,
ResolveActions ra 
)
explicit

Member Function Documentation

◆ expose_configuration()

void HostCachePluginConfig::expose_configuration ( const mysql_harness::ConfigSection default_section,
const bool  initial 
) const

◆ get_default() [1/2]

std::string HostCachePluginConfig::get_default ( std::string_view  option) const
overridevirtual

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.

◆ get_default() [2/2]

std::string HostCachePluginConfig::get_default ( std::string_view  option) const
overridevirtual

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() [1/2]

bool HostCachePluginConfig::is_required ( std::string_view  option) const
overridevirtual

Returns whether the given option is required.

Returns
bool

Implements mysql_harness::BasePluginConfig.

◆ is_required() [2/2]

bool HostCachePluginConfig::is_required ( std::string_view  option) const
overridevirtual

Returns whether the given option is required.

Returns
bool

Implements mysql_harness::BasePluginConfig.

Member Data Documentation

◆ actions_

ResolveActions& HostCachePluginConfig::actions_

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