logit::ILogger Interface Reference

Interface for loggers that handle log message output. More...

#include <ILogger.hpp>

Inheritance diagram for logit::ILogger:

Public Member Functions
virtual	~ILogger ()=default
virtual void	log (const LogRecord &record, const std::string &message)=0
	Logs a message.
virtual std::string	get_string_param (const LoggerParam &param) const =0
	Retrieves a string parameter from the logger.
virtual int64_t	get_int_param (const LoggerParam &param) const =0
	Retrieves an integer parameter from the logger.
virtual double	get_float_param (const LoggerParam &param) const =0
	Retrieves a floating-point parameter from the logger.
virtual void	set_log_level (LogLevel level)=0
	Sets the minimal log level for this logger.
virtual LogLevel	get_log_level () const =0
	Gets the minimal log level for this logger.
virtual void	wait ()=0
	Waits for all asynchronous logging operations to complete.

Detailed Description

Interface for loggers that handle log message output.

Definition at line 15 of file ILogger.hpp.

Constructor & Destructor Documentation

~ILogger()

virtual logit::ILogger::~ILogger ( )

virtualdefault

Member Function Documentation

get_float_param()

virtual double logit::ILogger::get_float_param ( const LoggerParam & param ) const

pure virtual

Retrieves a floating-point parameter from the logger.

Derived classes should implement this to return specific floating-point-based parameters.

Parameters

param

The parameter type to retrieve.

Returns

A double representing the requested parameter.

Implemented in logit::ConsoleLogger, logit::FileLogger, and logit::UniqueFileLogger.

get_int_param()

virtual int64_t logit::ILogger::get_int_param ( const LoggerParam & param ) const

pure virtual

Retrieves an integer parameter from the logger.

Derived classes should implement this to return specific integer-based parameters.

Parameters

param

The parameter type to retrieve.

Returns

An integer representing the requested parameter.

Implemented in logit::ConsoleLogger, logit::FileLogger, and logit::UniqueFileLogger.

get_log_level()

virtual LogLevel logit::ILogger::get_log_level ( ) const

pure virtual

Gets the minimal log level for this logger.

Returns

Current minimal log level.

Implemented in logit::ConsoleLogger, logit::FileLogger, and logit::UniqueFileLogger.

get_string_param()

virtual std::string logit::ILogger::get_string_param ( const LoggerParam & param ) const

pure virtual

Retrieves a string parameter from the logger.

Derived classes should implement this to return specific string-based parameters.

Parameters

param

The parameter type to retrieve.

Returns

A string representing the requested parameter.

Implemented in logit::ConsoleLogger, logit::FileLogger, and logit::UniqueFileLogger.

log()

virtual void logit::ILogger::log ( const LogRecord & record, const std::string & message )

pure virtual

Logs a message.

This pure virtual function must be implemented by derived logger classes. It handles the logging of messages, which could be output to a console, file, or other destinations.

Parameters

record	The log record containing details about the log event.
message	The formatted log message.

Implemented in logit::ConsoleLogger, logit::FileLogger, and logit::UniqueFileLogger.

set_log_level()

virtual void logit::ILogger::set_log_level ( LogLevel level )

pure virtual

Sets the minimal log level for this logger.

Parameters

level

Minimum log level.

Implemented in logit::ConsoleLogger, logit::FileLogger, and logit::UniqueFileLogger.

wait()

virtual void logit::ILogger::wait ( )

pure virtual

Waits for all asynchronous logging operations to complete.

This pure virtual function must be implemented by derived logger classes. It ensures that any pending log messages are fully processed, especially when logging asynchronously.

Implemented in logit::ConsoleLogger, logit::FileLogger, and logit::UniqueFileLogger.

---

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

• include/logit_cpp/logit/loggers/ILogger.hpp