kouta::utils::LoggerAware Class Reference

Abstract class providing integration with external loggers. More...

#include <logger-aware.hpp>

Collaboration diagram for kouta::utils::LoggerAware:

Public Member Functions
	LoggerAware (const LoggerAware &)=default
LoggerAware &	operator= (const LoggerAware &)=default
	LoggerAware (LoggerAware &&)=default
LoggerAware &	operator= (LoggerAware &&)=default
virtual	~LoggerAware ()=default
void	set_logger (ILogger *logger)
	Update the internal logger pointer.

Protected Member Functions
	LoggerAware ()=default
	Default constructor.
	LoggerAware (ILogger *logger)
	Constructor using an existing logger.
void	log_debug (std::string_view msg)
	Log a message with DEBUG (or equivalent) level.
void	log_info (std::string_view msg)
	Log a message with INFO (or equivalent) level.
void	log_warning (std::string_view msg)
	Log a message with WARNING (or equivalent) level.
void	log_error (std::string_view msg)
	Log a message with ERROR (or equivalent) level.
void	log_critical (std::string_view msg)
	Log a message with CRITICAL (or equivalent) level.

Private Attributes
ILogger *	m_logger

Detailed Description

Abstract class providing integration with external loggers.

The integration is provided via the ILogger interface. This class expects to receive a pointer to an object implementing the ILogger interface, which will be used by the internal logging methods to determine whether the message received can be sent to a logger or not.

Warning

Developers must guarantee that the pointer to the logger remains valid during lifetime of the logger aware class.

Constructor & Destructor Documentation

LoggerAware() [1/4]

kouta::utils::LoggerAware::LoggerAware ( const LoggerAware &  )

default

LoggerAware() [2/4]

kouta::utils::LoggerAware::LoggerAware ( LoggerAware &&  )

default

~LoggerAware()

virtual kouta::utils::LoggerAware::~LoggerAware ( )

virtualdefault

LoggerAware() [3/4]

kouta::utils::LoggerAware::LoggerAware ( )

protecteddefault

Default constructor.

LoggerAware() [4/4]

kouta::utils::LoggerAware::LoggerAware ( ILogger *  logger )

inlineexplicitprotected

Constructor using an existing logger.

Parameters

[in]

logger

Pointer to the logger to use. Set to ǹullptr` to disable logging.

Member Function Documentation

log_critical()

void kouta::utils::LoggerAware::log_critical ( std::string_view  msg )

inlineprotected

Log a message with CRITICAL (or equivalent) level.

Note

If no logger has been configured, this method simply discards the message.

log_debug()

void kouta::utils::LoggerAware::log_debug ( std::string_view  msg )

inlineprotected

Log a message with DEBUG (or equivalent) level.

Note

If no logger has been configured, this method simply discards the message.

log_error()

void kouta::utils::LoggerAware::log_error ( std::string_view  msg )

inlineprotected

Log a message with ERROR (or equivalent) level.

Note

If no logger has been configured, this method simply discards the message.

log_info()

void kouta::utils::LoggerAware::log_info ( std::string_view  msg )

inlineprotected

Log a message with INFO (or equivalent) level.

Note

If no logger has been configured, this method simply discards the message.

log_warning()

void kouta::utils::LoggerAware::log_warning ( std::string_view  msg )

inlineprotected

Log a message with WARNING (or equivalent) level.

Note

If no logger has been configured, this method simply discards the message.

operator=() [1/2]

LoggerAware & kouta::utils::LoggerAware::operator= ( const LoggerAware &  )

default

operator=() [2/2]

LoggerAware & kouta::utils::LoggerAware::operator= ( LoggerAware &&  )

default

set_logger()

void kouta::utils::LoggerAware::set_logger ( ILogger *  logger )

inline

Update the internal logger pointer.

Parameters

[in]

logger

Pointer to the logger to use. Set to nullptr to disable logging.

Member Data Documentation

m_logger

ILogger* kouta::utils::LoggerAware::m_logger

private

---

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

• include/kouta/utils/logger-aware.hpp