Sys_var_charptr_func Class Reference

#include <sys_vars.h>

Inheritance diagram for Sys_var_charptr_func:

Collaboration diagram for Sys_var_charptr_func:

Public Member Functions
	Sys_var_charptr_func (const char *name_arg, const char *comment, flag_enum flag_arg)
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	do_check (THD *thd, set_var *var)
bool	check_update_type (Item_result type)
virtual uchar *	session_value_ptr (THD *thd, LEX_STRING *base)
virtual uchar *	global_value_ptr (THD *thd, LEX_STRING *base)
Public Member Functions inherited from sys_var
	sys_var (sys_var_chain *chain, const char *name_arg, const char *comment, int flag_args, ptrdiff_t off, int getopt_id, enum get_opt_arg_type getopt_arg_type, SHOW_TYPE show_val_type_arg, longlong def_val, PolyLock *lock, enum binlog_status_enum binlog_status_arg, on_check_function on_check_func, on_update_function on_update_func, const char *substitute, int parse_flag)
virtual void	cleanup ()
virtual sys_var_pluginvar *	cast_pluginvar ()
bool	check (THD *thd, set_var *var)
uchar *	value_ptr (THD *thd, enum_var_type type, LEX_STRING *base)
virtual void	update_default (longlong new_def_value)
bool	set_default (THD *thd, set_var *var)
bool	update (THD *thd, set_var *var)
SHOW_TYPE	show_type ()
int	scope () const
const CHARSET_INFO *	charset (THD *thd)
bool	is_readonly () const
bool	not_visible () const
bool	is_struct ()
bool	is_written_to_binlog (enum_var_type type)
bool	check_type (enum_var_type type)
bool	register_option (std::vector< my_option > *array, int parse_flags)
void	do_deprecated_warning (THD *thd)

Additional Inherited Members
Public Types inherited from sys_var
enum	flag_enum {   GLOBAL, SESSION, ONLY_SESSION, SCOPE_MASK = 1023,   READONLY = 1024, ALLOCATED = 2048, INVISIBLE = 4096 }
enum	binlog_status_enum { VARIABLE_NOT_IN_BINLOG, SESSION_VARIABLE_IN_BINLOG }
Public Attributes inherited from sys_var
sys_var *	next
LEX_CSTRING	name
enum sys_var::binlog_status_enum	binlog_status
Static Public Attributes inherited from sys_var
static const int	PARSE_EARLY = 1
static const int	PARSE_NORMAL = 2
Protected Types inherited from sys_var
typedef bool(*	on_check_function )(sys_var *self, THD *thd, set_var *var)
typedef bool(*	on_update_function )(sys_var *self, THD *thd, enum_var_type type)
Protected Member Functions inherited from sys_var
uchar *	session_var_ptr (THD *thd)
uchar *	global_var_ptr ()
Protected Attributes inherited from sys_var
int	flags
	or'ed flag_enum values
int	m_parse_flag
	either PARSE_EARLY or PARSE_NORMAL.
const SHOW_TYPE	show_val_type
	what value_ptr() returns for sql_show.cc
my_option	option
	min, max, default values are stored here
PolyLock *	guard
	second lock that protects the variable
ptrdiff_t	offset
	offset to the value from global_system_variables
on_check_function	on_check
on_update_function	on_update
const char *const	deprecation_substitute
bool	is_os_charset
	true if the value is in character_set_filesystem

Detailed Description

Abstract base class for read-only variables (global or session) of string type where the value is generated by some function. This needs to be subclassed; the session_value_ptr or global_value_ptr function should be overridden.

Definition at line 2025 of file sys_vars.h.

Member Function Documentation

void Sys_var_charptr_func::global_save_default ( THD *  thd, set_var *  var  )

inlinevirtual

save the global default value of the variable in var

Implements sys_var.

Definition at line 2045 of file sys_vars.h.

void Sys_var_charptr_func::session_save_default ( THD *  thd, set_var *  var  )

inlinevirtual

save the session default value of the variable in var

Implements sys_var.

Definition at line 2044 of file sys_vars.h.

virtual uchar* Sys_var_charptr_func::session_value_ptr ( THD *  thd, LEX_STRING *  base  )

inlinevirtual

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.

Definition at line 2048 of file sys_vars.h.

---

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

• sql/sys_vars.h