Sys_var_bit Class Reference

#include <sys_vars.h>

Inheritance diagram for Sys_var_bit:

List of all members.

Public Member Functions
	Sys_var_bit (const char *name_arg, const char *comment, int flag_args, ptrdiff_t off, size_t size, CMD_LINE getopt, ulonglong bitmask_arg, my_bool 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)
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)
uchar *	session_value_ptr (THD *thd, LEX_STRING *base)
uchar *	global_value_ptr (THD *thd, LEX_STRING *base)

---

Detailed Description

The class for bit variables - a variant of boolean that stores the value in a bit.

Class specific constructor arguments: ulonglong bitmask_arg - the mask for the bit to set in the ulonglong backing store

Backing store: ulonglong

Note:

This class supports the "reverse" semantics, when the value of the bit being 0 corresponds to the value of variable being set. To activate it use REVERSE(bitmask) instead of simply bitmask in the constructor.

variables of this class cannot be set from the command line as my_getopt does not support bits.

---

Member Function Documentation

void Sys_var_bit::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_bit::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_bit::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