Sys_var_struct Class Reference

#include <sys_vars.h>

Inheritance diagram for Sys_var_struct:

List of all members.

Public Member Functions
	Sys_var_struct (const char *name_arg, const char *comment, int flag_args, ptrdiff_t off, size_t size, CMD_LINE getopt, ptrdiff_t name_off, void *def_val, PolyLock *lock=0, enum binlog_status_enum binlog_status_arg=VARIABLE_NOT_IN_BINLOG, on_check_function on_check_func=0, on_update_function on_update_func=0, const char *substitute=0, int parse_flag=PARSE_NORMAL)
bool	do_check (THD *thd, set_var *var)
bool	session_update (THD *thd, set_var *var)
bool	global_update (THD *thd, set_var *var)
void	session_save_default (THD *thd, set_var *var)
void	global_save_default (THD *thd, set_var *var)
bool	check_update_type (Item_result type)
uchar *	session_value_ptr (THD *thd, LEX_STRING *base)
uchar *	global_value_ptr (THD *thd, LEX_STRING *base)

---

Detailed Description

Generic class for variables for storing entities that are internally represented as structures, have names, and possibly can be referred to by numbers. Examples: character sets, collations, locales,

Class specific constructor arguments: ptrdiff_t name_offset - offset of the 'name' field in the structure

Backing store: void*

Note:

As every such a structure requires special treatment from my_getopt, these variables don't support command-line equivalents, any such command-line options should be added manually to my_long_options in mysqld.cc

---

Member Function Documentation

void Sys_var_struct::global_save_default	(	THD *	thd,
		set_var *	var
	)		[inline, virtual]

save the global default value of the variable in var

Implements sys_var.

void Sys_var_struct::session_save_default	(	THD *	thd,
		set_var *	var
	)		[inline, virtual]

save the session default value of the variable in var

Implements sys_var.

uchar* Sys_var_struct::session_value_ptr	(	THD *	thd,
		LEX_STRING *	base
	)		[inline, virtual]

A pointer to a value of the variable for SHOW. It must be of show_val_type type (bool for SHOW_BOOL, int for SHOW_INT, longlong for SHOW_LONGLONG, etc).

Reimplemented from sys_var.

---

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

• sys_vars.h