Gcs_debug_manager Class Reference

This class sets up and configures the debugging infrastructure, storing the debugger to be used by the application as a singleton. More...

#include <gcs_logging_system.h>

Inheritance diagram for Gcs_debug_manager:

Static Public Member Functions
static enum_gcs_error	initialize (Gcs_default_debugger *debugger)
	Set the debugger object and initialize it by invoking its initialization method. More...
static Gcs_default_debugger *	get_debugger ()
	Get a reference to the debugger object if there is any. More...
static enum_gcs_error	finalize ()
	Free any resource used in the debugging system. More...
Static Public Member Functions inherited from Gcs_debug_options
static int64_t	load_debug_options ()
	Atomically load information on debug options. More...
static void	store_debug_options (int64_t debug_options)
	Atomically store information on debug options. More...
static bool	test_debug_options (const int64_t debug_options)
	Verify whether any of the debug options are defined. More...
static int64_t	get_current_debug_options ()
	Get the current set of debug options. More...
static int64_t	get_current_debug_options (std::string &res_debug_options)
	Get the current set of debug options as an integer value and as a string separated by comma. More...
static int64_t	get_valid_debug_options ()
	Get the set of valid debug options excluding GCS_DEBUG_NONE and GCS_DEBUG_ALL. More...
static bool	is_valid_debug_options (const int64_t debug_options)
	Check whether the set of debug options is valid or not including GCS_DEBUG_NONE and GCS_DEBUG_ALL. More...
static bool	is_valid_debug_options (const std::string &debug_options)
	Check whether the set of debug options is valid or not including GCS_DEBUG_NONE and GCS_DEBUG_ALL. More...
static bool	get_debug_options (const std::string &debug_options, int64_t &res_debug_options)
	Get the set of debug options passed as parameter as an unsigned integer. More...
static bool	get_debug_options (const int64_t debug_options, std::string &res_debug_options)
	Get the set of debug options passed as parameter as a string. More...
static unsigned int	get_number_debug_options ()
	Get the the number of possible debug options. More...
static bool	set_debug_options (const int64_t debug_options)
	Extend the current set of debug options with new debug options expressed as an integer parameter. More...
static bool	force_debug_options (const int64_t debug_options)
	Change the current set of debug options by the new debug options expressed as an integer parameter. More...
static bool	set_debug_options (const std::string &debug_options)
	Extend the current set of debug options with new debug options expressed as a string. More...
static bool	force_debug_options (const std::string &debug_options)
	Changed the current set of debug options by the new debug options expressed as a string. More...
static bool	unset_debug_options (const int64_t debug_options)
	Reduce the current set of debug options by disabling the debug options expressed as an integer parameter. More...
static bool	unset_debug_options (const std::string &debug_options)
	Reduce the current set of debug options by disabling the debug options expressed as a string. More...

Static Private Attributes
static Gcs_default_debugger *	m_debugger = nullptr
	Reference to the default debugger which is used internally by GCS and XCOM. More...

Detailed Description

This class sets up and configures the debugging infrastructure, storing the debugger to be used by the application as a singleton.

Member Function Documentation

finalize()

static enum_gcs_error Gcs_debug_manager::finalize ( )

inlinestatic

Free any resource used in the debugging system.

Return values

GCS_OK

in case everything goes well. Any other value of gcs_error in case of error.

get_debugger()

static Gcs_default_debugger * Gcs_debug_manager::get_debugger ( )

inlinestatic

Get a reference to the debugger object if there is any.

Returns

The current debugging system.

initialize()

static enum_gcs_error Gcs_debug_manager::initialize ( Gcs_default_debugger *  debugger )

inlinestatic

Set the debugger object and initialize it by invoking its initialization method.

This allows any resources needed by the debugging system to be initialized, and ensures its usage throughout the lifecycle of the current application.

Parameters

[in]

debugger

debugging system

Return values

GCS_OK

in case everything goes well. Any other value of gcs_error in case of error.

Member Data Documentation

m_debugger

Gcs_default_debugger * Gcs_debug_manager::m_debugger = nullptr

staticprivate

Reference to the default debugger which is used internally by GCS and XCOM.

---

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

• plugin/group_replication/libmysqlgcs/include/mysql/gcs/gcs_logging_system.h
• plugin/group_replication/libmysqlgcs/src/interface/gcs_logging_system.cc