MySQL 8.4.0
Source Code Documentation
Gcs_log_manager Class Reference

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

#include <gcs_logging.h>

Static Public Member Functions

static enum_gcs_error initialize (Logger_interface *logger)
 Set the logger object and initialize it by invoking its initialization method. More...
 
static Logger_interfaceget_logger ()
 Get a reference to the logger object if there is any. More...
 
static enum_gcs_error finalize ()
 Free any resource used in the logging system. More...
 

Static Private Attributes

static Logger_interfacem_logger = nullptr
 

Detailed Description

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

Member Function Documentation

◆ finalize()

enum_gcs_error Gcs_log_manager::finalize ( )
static

Free any resource used in the logging system.

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

◆ get_logger()

Logger_interface * Gcs_log_manager::get_logger ( )
static

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

Returns
The current logging system.

◆ initialize()

enum_gcs_error Gcs_log_manager::initialize ( Logger_interface logger)
static

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

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

Parameters
[in]loggerlogging system
Return values
GCS_OKin case everything goes well. Any other value of gcs_error in case of error.

Member Data Documentation

◆ m_logger

Logger_interface * Gcs_log_manager::m_logger = nullptr
staticprivate

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