MySQL 8.3.0
Source Code Documentation
Sink_interface Class Referenceabstract

Common sink that may be shared by the logging and debugging systems. More...

#include <gcs_logging.h>

Inheritance diagram for Sink_interface:
[legend]

Public Member Functions

 ~Sink_interface () override=default
 Define a virtual destructor as instances of this interface can be polymorphically used. More...
 
virtual void log_event (const std::string &message)=0
 The purpose of this method is to effectively log the information. More...
 
virtual void log_event (const char *message, size_t message_size)=0
 The purpose of this method is to effectively log the information. More...
 
virtual const std::string get_information () const =0
 The purpose of this method is to return information on the sink such as its location. More...
 
- Public Member Functions inherited from Common_interface
virtual ~Common_interface ()=default
 Define a virtual destructor as instances of this interface can be polymorphically used. More...
 
virtual enum_gcs_error initialize ()=0
 The purpose of this method is to initialize resources used by the objects that implement this interface. More...
 
virtual enum_gcs_error finalize ()=0
 The purpose of this method is to free any resources used by the objects that implement this interface. More...
 

Detailed Description

Common sink that may be shared by the logging and debugging systems.

Constructor & Destructor Documentation

◆ ~Sink_interface()

Sink_interface::~Sink_interface ( )
overridedefault

Define a virtual destructor as instances of this interface can be polymorphically used.

Member Function Documentation

◆ get_information()

virtual const std::string Sink_interface::get_information ( ) const
pure virtual

The purpose of this method is to return information on the sink such as its location.

Implemented in Gcs_output_sink, and Gcs_file_sink.

◆ log_event() [1/2]

virtual void Sink_interface::log_event ( const char *  message,
size_t  message_size 
)
pure virtual

The purpose of this method is to effectively log the information.

Parameters
[in]messagethe message to log
[in]message_sizemessage size to log

Implemented in Gcs_output_sink, and Gcs_file_sink.

◆ log_event() [2/2]

virtual void Sink_interface::log_event ( const std::string &  message)
pure virtual

The purpose of this method is to effectively log the information.

Parameters
[in]messagethe message to log

Implemented in Gcs_output_sink, and Gcs_file_sink.


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