Handler to write to an output stream. More...

#include <handler.h>

Inheritance diagram for mysql_harness::logging::StreamHandler:

Public Member Functions
	StreamHandler (std::ostream &stream, 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

Handler &	operator= (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 = "stream"

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

Protected Attributes
std::ostream &	stream_

std::mutex	stream_mutex_

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 an output stream.

Logger logger("my_module");
...
logger.add_handler(StreamHandler(std::clog));

Constructor & Destructor Documentation

◆ StreamHandler()

mysql_harness::logging::StreamHandler::StreamHandler	(	std::ostream &	stream,
		bool	format_messages = `true`,
		LogLevel	level = `LogLevel::kNotSet`,
		LogTimestampPrecision	timestamp_precision = `LogTimestampPrecision::kNotSet`
	)

explicit

Member Function Documentation

◆ do_log()

void mysql_harness::logging::StreamHandler::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

record Record containing information about the message.

Implements mysql_harness::logging::Handler.

Reimplemented in mysql_harness::logging::FileHandler.

◆ reopen()

void mysql_harness::logging::StreamHandler::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.

Reimplemented in mysql_harness::logging::FileHandler.

Member Data Documentation

◆ kDefaultName

constexpr const char* mysql_harness::logging::StreamHandler::kDefaultName = "stream"

staticconstexpr

◆ stream_

std::ostream& mysql_harness::logging::StreamHandler::stream_

protected

◆ stream_mutex_

std::mutex mysql_harness::logging::StreamHandler::stream_mutex_

protected

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

router/src/harness/include/mysql/harness/logging/handler.h
router/src/harness/src/logging/handler.cc

Public Member Functions

Static Public Attributes

Protected Attributes

Private Member Functions

Additional Inherited Members