Singleton class that manages multiple loggers and formatters. More...

#include <Logger.hpp>

Classes
struct	LoggerStrategy
	Structure to hold a logger-formatter pair. More...

Public Member Functions
void	wait ()
	Waits for all asynchronous loggers to finish processing.

void	add_logger (std::unique_ptr< ILogger > logger, std::unique_ptr< ILogFormatter > formatter, bool single_mode=false)
	Adds a logger and its corresponding formatter.

void	set_logger_enabled (int logger_index, bool enabled)
	Enables or disables a logger by index.

bool	is_logger_enabled (int logger_index) const
	Checks whether a logger is enabled.

void	set_logger_single_mode (int logger_index, bool single_mode)
	Sets the single-mode flag for a logger.

bool	is_logger_single_mode (int logger_index) const
	Checks whether a logger is in single mode.

void	log (const LogRecord &record)
	Logs a `LogRecord` using all added loggers and formatters.

std::string	get_string_param (int logger_index, const LoggerParam &param) const
	Retrieves a string parameter from the logger.

int64_t	get_int_param (int logger_index, const LoggerParam &param) const
	Retrieves an integer parameter from the logger.

double	get_float_param (int logger_index, const LoggerParam &param) const
	Retrieves a floating-point parameter from the logger.

template<typename... Ts>
auto	log_and_return (const LogRecord &record, Ts &&... args) -> decltype(std::forward_as_tuple(std::forward< Ts >(args)...))
	Logs the message and returns a tuple of arguments.

template<typename T >
auto	log_and_return (const LogRecord &record, T &&arg) -> decltype(arg)
	Logs the message and returns a single argument.

auto	log_and_return (const LogRecord &record) -> std::tuple<>
	Logs a message without arguments and returns an empty tuple.

Static Public Member Functions
static Logger &	get_instance ()
	Retrieves the singleton instance of `Logger`.

Private Member Functions
template<typename... Ts>
void	print (const LogRecord &record, Ts const &... args)
	Logs a record with the given arguments.

	Logger ()=default

	~Logger ()

	Logger (const Logger &)=delete

Logger &	operator= (const Logger &)=delete

	Logger (Logger &&)=delete

Logger &	operator= (Logger &&)=delete

Private Attributes
std::vector< LoggerStrategy >	m_loggers
	Container for logger-formatter pairs.

std::mutex	m_mutex
	Mutex for thread safety during logging operations.

Detailed Description

Singleton class that manages multiple loggers and formatters.

The Logger class allows adding multiple logger and formatter pairs (strategies) and provides methods to log messages using these strategies. It supports both synchronous and asynchronous logging. The class is thread-safe.

Definition at line 21 of file Logger.hpp.

Constructor & Destructor Documentation

◆ Logger() [1/3]

logit::Logger::Logger ( )

privatedefault

◆ ~Logger()

logit::Logger::~Logger ( )

inlineprivate

Definition at line 220 of file Logger.hpp.

◆ Logger() [2/3]

logit::Logger::Logger ( const Logger & )

privatedelete

◆ Logger() [3/3]

logit::Logger::Logger ( Logger && )

privatedelete

Member Function Documentation

◆ add_logger()

void logit::Logger::add_logger	(	std::unique_ptr< ILogger >	logger,
		std::unique_ptr< ILogFormatter >	formatter,
		bool	single_mode = false )

inline

Adds a logger and its corresponding formatter.

Parameters

logger	A unique pointer to the logger instance.
formatter	A unique pointer to the formatter instance.
single_mode	If true, this logger will only be invoked by specific log macros (e.g., LOGIT_TRACE_TO) that explicitly target it using the logger's index. It will not process logs from general log macros (e.g., LOGIT_TRACE).

Definition at line 47 of file Logger.hpp.

◆ get_float_param()

double logit::Logger::get_float_param	(	int	logger_index,
		const LoggerParam &	param ) const

inline

Retrieves a floating-point parameter from the logger.

Parameters

logger_index	The index of the logger.
param	The logger parameter to retrieve.

Returns: A double representing the requested parameter, or 0.0 if the parameter is unsupported.

Definition at line 150 of file Logger.hpp.

◆ get_instance()

static Logger & logit::Logger::get_instance ( )

inlinestatic

Retrieves the singleton instance of Logger.

Returns: A reference to the single instance of the Logger class.

Definition at line 26 of file Logger.hpp.

◆ get_int_param()

int64_t logit::Logger::get_int_param	(	int	logger_index,
		const LoggerParam &	param ) const

inline

Retrieves an integer parameter from the logger.

Parameters

logger_index	The index of the logger.
param	The logger parameter to retrieve.

Returns: An integer representing the requested parameter, or 0 if the parameter is unsupported.

Definition at line 138 of file Logger.hpp.

◆ get_string_param()

std::string logit::Logger::get_string_param	(	int	logger_index,
		const LoggerParam &	param ) const

inline

Retrieves a string parameter from the logger.

Parameters

logger_index	The index of the logger.
param	The logger parameter to retrieve.

Returns: A string representing the requested parameter, or an empty string if the parameter is unsupported.

Definition at line 126 of file Logger.hpp.

◆ is_logger_enabled()

bool logit::Logger::is_logger_enabled ( int logger_index ) const

inline

Checks whether a logger is enabled.

Parameters

logger_index The index of the logger to check.

Returns: True if the logger is enabled, false otherwise.

Definition at line 73 of file Logger.hpp.

◆ is_logger_single_mode()

bool logit::Logger::is_logger_single_mode ( int logger_index ) const

inline

Checks whether a logger is in single mode.

Parameters

logger_index The index of the logger.

Returns: True if the logger is in single mode, false otherwise.

Definition at line 94 of file Logger.hpp.

◆ log()

void logit::Logger::log ( const LogRecord & record )

inline

Logs a LogRecord using all added loggers and formatters.

The log() method formats the log message using each logger's corresponding formatter and sends the formatted message to each logger.

Parameters

record The log record to be logged.

Definition at line 108 of file Logger.hpp.

◆ log_and_return() [1/3]

auto logit::Logger::log_and_return ( const LogRecord & record ) -> std::tuple<>

inline

Logs a message without arguments and returns an empty tuple.

Parameters

record The log record.

Returns: An empty tuple.

Definition at line 183 of file Logger.hpp.

◆ log_and_return() [2/3]

template<typename T >

auto logit::Logger::log_and_return	(	const LogRecord &	record,
		T &&	arg ) -> decltype(arg)

inline

Logs the message and returns a single argument.

Template Parameters

T	Type of the argument.

Parameters

record	The log record.
arg	The argument to be logged.

Returns: The logged argument.

Definition at line 175 of file Logger.hpp.

◆ log_and_return() [3/3]

template<typename... Ts>

auto logit::Logger::log_and_return	(	const LogRecord &	record,
		Ts &&...	args ) -> decltype(std::forward_as_tuple(std::forward<Ts>(args)...))

inline

Logs the message and returns a tuple of arguments.

Template Parameters

Ts	Types of the arguments.

Parameters

record	The log record.
args	The arguments to be logged.

Returns: A tuple containing the arguments.

Definition at line 164 of file Logger.hpp.

◆ operator=() [1/2]

Logger & logit::Logger::operator= ( const Logger & )

privatedelete

◆ operator=() [2/2]

Logger & logit::Logger::operator= ( Logger && )

privatedelete

◆ print()

template<typename... Ts>

void logit::Logger::print	(	const LogRecord &	record,
		Ts const &...	args )

inlineprivate

Logs a record with the given arguments.

Template Parameters

Ts	Types of the arguments.

Parameters

record	The log record.
args	The arguments to be logged.

Definition at line 207 of file Logger.hpp.

◆ set_logger_enabled()

void logit::Logger::set_logger_enabled	(	int	logger_index,
		bool	enabled )

inline

Enables or disables a logger by index.

Parameters

logger_index	The index of the logger to modify.
enabled	True to enable the logger, false to disable it.

Definition at line 63 of file Logger.hpp.

◆ set_logger_single_mode()

void logit::Logger::set_logger_single_mode	(	int	logger_index,
		bool	single_mode )

inline

Sets the single-mode flag for a logger.

Parameters

logger_index	The index of the logger.
single_mode	True to set the logger to single mode, false otherwise.

Definition at line 84 of file Logger.hpp.

◆ wait()

void logit::Logger::wait ( )

inline

Waits for all asynchronous loggers to finish processing.

This method ensures that all log messages are fully processed before continuing. It calls the wait() function of each logger.

Definition at line 35 of file Logger.hpp.

Member Data Documentation

◆ m_loggers

std::vector<LoggerStrategy> logit::Logger::m_loggers

private

Container for logger-formatter pairs.

Definition at line 199 of file Logger.hpp.

◆ m_mutex

std::mutex logit::Logger::m_mutex

mutableprivate

Mutex for thread safety during logging operations.

Definition at line 200 of file Logger.hpp.

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

include/log-it/parts/Logger.hpp

Classes

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Logger() [1/3]

◆ ~Logger()

◆ Logger() [2/3]

◆ Logger() [3/3]

Member Function Documentation

◆ add_logger()

◆ get_float_param()

◆ get_instance()

◆ get_int_param()

◆ get_string_param()

◆ is_logger_enabled()

◆ is_logger_single_mode()

◆ log()

◆ log_and_return() [1/3]

◆ log_and_return() [2/3]

◆ log_and_return() [3/3]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ print()

◆ set_logger_enabled()

◆ set_logger_single_mode()

◆ wait()

Member Data Documentation

◆ m_loggers

◆ m_mutex