MySQL 8.0.30
Source Code Documentation
mysql_harness::logging::NullHandler Class Reference

Handler to write to a null device such as /dev/null (unix) or NUL (windows). More...

#include <handler.h>

Inheritance diagram for mysql_harness::logging::NullHandler:
[legend]

Public Member Functions

 NullHandler (bool format_messages=true, LogLevel level=LogLevel::kNotSet, LogTimestampPrecision timestamp_precision=LogTimestampPrecision::kNotSet)
 
void reopen (const std::string) override
 Request to reopen underlying log sink. More...
 
- Public Member Functions inherited from mysql_harness::logging::Handler
 Handler ()=default
 
 Handler (const Handler &)=default
 
Handleroperator= (const Handler &)=default
 
virtual ~Handler ()=default
 
void handle (const Record &record)
 
void set_level (LogLevel level)
 
LogLevel get_level () const
 
void set_timestamp_precision (LogTimestampPrecision precision)
 
bool has_logged () const
 check if the handler has logged at least one record. More...
 

Static Public Attributes

static constexpr const char * kDefaultName = "null"
 
- Static Public Attributes inherited from mysql_harness::logging::Handler
static constexpr const char * kDefaultName = nullptr
 Default identifier. More...
 

Private Member Functions

void do_log (const Record &record) override
 Log message handler primitive. More...
 

Additional Inherited Members

- Protected Member Functions inherited from mysql_harness::logging::Handler
std::string format (const Record &record) const
 
 Handler (bool format_messages, LogLevel level, LogTimestampPrecision timestamp_precision)
 
void has_logged (bool v)
 

Detailed Description

Handler to write to a null device such as /dev/null (unix) or NUL (windows).

This handler produces no output.

Logger logger("my_module");
...
logger.add_handler(NullHandler());
NullHandler(bool format_messages=true, LogLevel level=LogLevel::kNotSet, LogTimestampPrecision timestamp_precision=LogTimestampPrecision::kNotSet)
Definition: handler.cc:156
static Logger logger
The "top-level" logger used when no connection context is given.
Definition: test_trace_plugin.cc:295

Constructor & Destructor Documentation

◆ NullHandler()

mysql_harness::logging::NullHandler::NullHandler ( bool  format_messages = true,
LogLevel  level = LogLevel::kNotSet,
LogTimestampPrecision  timestamp_precision = LogTimestampPrecision::kNotSet 
)
explicit

Member Function Documentation

◆ do_log()

void mysql_harness::logging::NullHandler::do_log ( const Record record)
overrideprivatevirtual

Log message handler primitive.

This member function is implemented by subclasses to properly log a record wherever it need to be logged. If it is not possible to log the message properly, an exception should be thrown and will be caught by the caller.

Parameters
recordRecord containing information about the message.

Implements mysql_harness::logging::Handler.

◆ reopen()

void mysql_harness::logging::NullHandler::reopen ( const std::string  dst)
inlineoverridevirtual

Request to reopen underlying log sink.

Should be no-op for handlers NOT writing to a file. Useful for log rotation, when the logger got the signal with the request to reopen the file. Provide a destination filename for the old file for file based handlers.

Implements mysql_harness::logging::Handler.

Member Data Documentation

◆ kDefaultName

constexpr const char * mysql_harness::logging::NullHandler::kDefaultName = "null"
staticconstexpr

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