MySQL 8.3.0
Source Code Documentation
RestRoutingPluginConfig Class Reference
Inheritance diagram for RestRoutingPluginConfig:
[legend]

Public Member Functions

 RestRoutingPluginConfig (const mysql_harness::ConfigSection *section)
 
std::string get_default (const std::string &) const override
 Gets the default for the given option. More...
 
bool is_required (const std::string &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, const std::string &option) const
 get description of the option. More...
 
template<class Func >
decltype(auto) get_option (const mysql_harness::ConfigSection *section, const std::string &option, Func &&transformer) const
 get option value. More...
 
template<class Func >
decltype(auto) get_option_no_default (const mysql_harness::ConfigSection *section, const std::string &option, Func &&transformer) const
 get option value. More...
 
std::string get_option_string (const mysql_harness::ConfigSection *section, const std::string &option) const
 Gets value of given option as string. More...
 
template<class T >
get_uint_option (const mysql_harness::ConfigSection *section, const std::string &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, const std::string &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 require_realm
 

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

◆ RestRoutingPluginConfig()

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

Member Function Documentation

◆ get_default()

std::string RestRoutingPluginConfig::get_default ( const std::string &  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 RestRoutingPluginConfig::is_required ( const std::string &  option) const
inlineoverridevirtual

Returns whether the given option is required.

Returns
bool

Implements mysql_harness::BasePluginConfig.

Member Data Documentation

◆ require_realm

std::string RestRoutingPluginConfig::require_realm

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