MySQL  8.0.19
Source Code Documentation
mysql_component_sys_variable_imp Class Reference

An implementation of the configutration system variables Service to register variable and unregister variable. More...

#include <component_sys_var_service.h>

Static Public Member Functions

static mysql_service_status_t register_variable (const char *component_name, const char *var_name, int flags, const char *comment, mysql_sys_var_check_func check_func, mysql_sys_var_update_func update_func, void *check_arg, void *variable_value) noexcept
 Register's component system variables. More...
 
static mysql_service_status_t get_variable (const char *component_name, const char *var_name, void **val, size_t *out_length_of_val) noexcept
 Get the component system variable value from the global structure. More...
 
static mysql_service_status_t unregister_variable (const char *component_name, const char *var_name) noexcept
 Unregister's component system variable. More...
 

Detailed Description

An implementation of the configutration system variables Service to register variable and unregister variable.

Member Function Documentation

◆ get_variable()

mysql_service_status_t mysql_component_sys_variable_imp::get_variable ( const char *  component_name,
const char *  var_name,
void **  val,
size_t *  out_length_of_val 
)
staticnoexcept

Get the component system variable value from the global structure.

Get the system variable value from the global structure.

Parameters
component_nameName of the component
var_nameName of the variable
[in,out]valOn input: a buffer to hold the value. On output a pointer to the value.
[in,out]out_length_of_valOn input: size of longest string that the buffer can contain. On output the length of the copied string.
Returns
Status of performed operation
Return values
falsesuccess
truefailure

◆ register_variable()

mysql_service_status_t mysql_component_sys_variable_imp::register_variable ( const char *  component_name,
const char *  var_name,
int  flags,
const char *  comment,
mysql_sys_var_check_func  check_func,
mysql_sys_var_update_func  update_func,
void *  check_arg,
void *  variable_value 
)
staticnoexcept

Register's component system variables.

Register system variables.

Parameters
component_namename of the componentnt
var_namevariable name
flagstells about the variable type
commentvariable comment message
check_funcfunction pointer, which is called at variable check time
update_funcfunction pointer, which is called at update time
check_argtype defined check constraints block
variable_valueplace holder for variable value
Returns
Status of performed operation
Return values
falsesuccess
truefailure
Parameters
component_nameName of the component
var_nameName of the variable
flagstells about the variable type
commentvariable comment information
check_functrigger function to be called at Check time
update_functrigger function to be called at Update time
check_argtype defined check constraints block
variable_valueplace holder for variable value
Returns
Status of performed operation
Return values
falsesuccess
truefailure

◆ unregister_variable()

mysql_service_status_t mysql_component_sys_variable_imp::unregister_variable ( const char *  component_name,
const char *  var_name 
)
staticnoexcept

Unregister's component system variable.

Unregister system variables.

Parameters
component_namename of the component
var_nameVariable name
Returns
Status of performed operation
Return values
falsesuccess
truefailure
Parameters
component_nameName of the component
var_nameVariable name
Returns
Status of performed operation
Return values
falsesuccess
truefailure

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