Interface for logging to a specified file. More...

#include <>>

Inheritance diagram for fawkes::FileLogger:

Public Member Functions
	FileLogger (const char *filename, LogLevel min_level=LL_DEBUG)
	Constructor. More...

virtual	~FileLogger ()
	Destructor. More...

virtual void	log_debug (const char component, const char format,...)
	Log debug message. More...

virtual void	log_info (const char component, const char format,...)
	Log informational message. More...

virtual void	log_warn (const char component, const char format,...)
	Log warning message. More...

virtual void	log_error (const char component, const char format,...)
	Log error message. More...

virtual void	vlog_debug (const char component, const char format, va_list va)
	Log debug message. More...

virtual void	vlog_info (const char component, const char format, va_list va)
	Log informational message. More...

virtual void	vlog_warn (const char component, const char format, va_list va)
	Log warning message. More...

virtual void	vlog_error (const char component, const char format, va_list va)
	Log error message. More...

virtual void	log_debug (const char *component, Exception &e)
	Log debug exception. More...

virtual void	log_info (const char *component, Exception &e)
	Log informational exception. More...

virtual void	log_warn (const char *component, Exception &e)
	Log warning exception. More...

virtual void	log_error (const char *component, Exception &e)
	Log error exception. More...

virtual void	tlog_debug (struct timeval t, const char component, const char *format,...)
	Log debug message for specific time. More...

virtual void	tlog_info (struct timeval t, const char component, const char *format,...)
	Log informational message for specific time. More...

virtual void	tlog_warn (struct timeval t, const char component, const char *format,...)
	Log warning message for specific time. More...

virtual void	tlog_error (struct timeval t, const char component, const char *format,...)
	Log error message for specific time. More...

virtual void	tlog_debug (struct timeval t, const char component, Exception &e)
	Log debug exception for specific time. More...

virtual void	tlog_info (struct timeval t, const char component, Exception &e)
	Log informational exception for specific time. More...

virtual void	tlog_warn (struct timeval t, const char component, Exception &e)
	Log warning exception for specific time. More...

virtual void	tlog_error (struct timeval t, const char component, Exception &e)
	Log error exception for specific time. More...

virtual void	vtlog_debug (struct timeval t, const char component, const char *format, va_list va)
	Log debug message for specific time. More...

virtual void	vtlog_info (struct timeval t, const char component, const char *format, va_list va)
	Log informational message for specific time. More...

virtual void	vtlog_warn (struct timeval t, const char component, const char *format, va_list va)
	Log warning message for specific time. More...

virtual void	vtlog_error (struct timeval t, const char component, const char *format, va_list va)
	Log error message for specific time. More...

Public Member Functions inherited from fawkes::Logger
	Logger (LogLevel log_level=LL_DEBUG)
	Constructor. More...

virtual	~Logger ()
	Virtual empty destructor. More...

virtual void	set_loglevel (LogLevel level)
	Sets the log level. More...

virtual LogLevel	loglevel ()
	Get log level. More...

virtual void	log (LogLevel level, const char component, const char format,...)
	Log message of given log level. More...

virtual void	log (LogLevel level, const char *component, Exception &e)
	Log exception for given log level. More...

virtual void	vlog (LogLevel level, const char component, const char format, va_list va)
	Log message for given log level. More...

virtual void	tlog (LogLevel level, struct timeval t, const char component, const char *format,...)
	Log message of given log level and time. More...

virtual void	tlog (LogLevel level, struct timeval t, const char component, Exception &e)
	Log exception for given log level. More...

virtual void	vtlog (LogLevel level, struct timeval t, const char component, const char *format, va_list va)
	Log message for given log level and time. More...

Additional Inherited Members
Public Types inherited from fawkes::Logger
enum	LogLevel { LL_DEBUG = 0 , LL_INFO = 1 , LL_WARN = 2 , LL_ERROR = 4 , LL_NONE = 8 }
	Log level. More...

Protected Attributes inherited from fawkes::Logger
LogLevel	log_level
	Minimum log level. More...

Detailed Description

Interface for logging to a specified file.

The FileLogger will pipe all output into the given file. The output will be prepended by a single character which determines the type of output (E for error, W for warning, etc.).

Definition at line 37 of file file.h.

Constructor & Destructor Documentation

◆ FileLogger()

fawkes::FileLogger::FileLogger	(	const char *	filename_pattern,
		LogLevel	log_level = `LL_DEBUG`
	)

Constructor.

The filename is generated from the filename pattern by replacing '$time' with the current time.

Parameters

filename_pattern	the name pattern of the log-file
log_level	minimum log level

Definition at line 55 of file file.cpp.

◆ ~FileLogger()

fawkes::FileLogger::~FileLogger ( )

virtual

Destructor.

Definition at line 120 of file file.cpp.

Member Function Documentation

◆ log_debug() [1/2]

void fawkes::FileLogger::log_debug	(	const char *	component,
		const char *	format,
			...
	)

virtual

Log debug message.

Parameters

component	component, used to distuinguish logged messages
format	format of the message, see man page of sprintf for available tokens.

Implements fawkes::Logger.

Definition at line 128 of file file.cpp.

References vlog_debug().

◆ log_debug() [2/2]

void fawkes::FileLogger::log_debug	(	const char *	component,
		Exception &	e
	)

virtual

Log debug exception.

Parameters

component	component, used to distuinguish logged messages
e	exception to log, exception messages will be logged

Implements fawkes::Logger.

Definition at line 164 of file file.cpp.

References fawkes::Exception::begin(), fawkes::Exception::end(), fawkes::Logger::LL_DEBUG, fawkes::Mutex::lock(), fawkes::Logger::log_level, and fawkes::Mutex::unlock().

◆ log_error() [1/2]

void fawkes::FileLogger::log_error	(	const char *	component,
		const char *	format,
			...
	)

virtual

Log error message.

Parameters

component	component, used to distuinguish logged messages
format	format of the message, see man page of sprintf for available tokens.

Implements fawkes::Logger.

Definition at line 155 of file file.cpp.

References vlog_error().

◆ log_error() [2/2]

void fawkes::FileLogger::log_error	(	const char *	component,
		Exception &	e
	)

virtual

Log error exception.

Parameters

component	component, used to distuinguish logged messages
e	exception to log, exception messages will be logged

Implements fawkes::Logger.

Definition at line 239 of file file.cpp.

References fawkes::Exception::begin(), fawkes::Exception::end(), fawkes::Logger::LL_ERROR, fawkes::Mutex::lock(), fawkes::Logger::log_level, and fawkes::Mutex::unlock().

◆ log_info() [1/2]

void fawkes::FileLogger::log_info	(	const char *	component,
		const char *	format,
			...
	)

virtual

Log informational message.

Parameters

component	component, used to distuinguish logged messages
format	format of the message, see man page of sprintf for available tokens.

Implements fawkes::Logger.

Definition at line 137 of file file.cpp.

References vlog_info().

◆ log_info() [2/2]

void fawkes::FileLogger::log_info	(	const char *	component,
		Exception &	e
	)

virtual

Log informational exception.

Parameters

component	component, used to distuinguish logged messages
e	exception to log, exception messages will be logged

Implements fawkes::Logger.

Definition at line 189 of file file.cpp.

References fawkes::Exception::begin(), fawkes::Exception::end(), fawkes::Logger::LL_INFO, fawkes::Mutex::lock(), fawkes::Logger::log_level, and fawkes::Mutex::unlock().

◆ log_warn() [1/2]

void fawkes::FileLogger::log_warn	(	const char *	component,
		const char *	format,
			...
	)

virtual

Log warning message.

Parameters

component	component, used to distuinguish logged messages
format	format of the message, see man page of sprintf for available tokens.

Implements fawkes::Logger.

Definition at line 146 of file file.cpp.

References vlog_warn().

◆ log_warn() [2/2]

void fawkes::FileLogger::log_warn	(	const char *	component,
		Exception &	e
	)

virtual

Log warning exception.

Parameters

component	component, used to distuinguish logged messages
e	exception to log, exception messages will be logged

Implements fawkes::Logger.

Definition at line 214 of file file.cpp.

References fawkes::Exception::begin(), fawkes::Exception::end(), fawkes::Logger::LL_WARN, fawkes::Mutex::lock(), fawkes::Logger::log_level, and fawkes::Mutex::unlock().

◆ tlog_debug() [1/2]

void fawkes::FileLogger::tlog_debug	(	struct timeval *	t,
		const char *	component,
		const char *	format,
			...
	)

virtual

Log debug message for specific time.

Parameters

t	time for this message to log
component	component, used to distuinguish logged messages
format	format of the message, see man page of sprintf for available tokens.

Implements fawkes::Logger.

Definition at line 356 of file file.cpp.

References vtlog_debug().

◆ tlog_debug() [2/2]

void fawkes::FileLogger::tlog_debug	(	struct timeval *	t,
		const char *	component,
		Exception &	e
	)

virtual

Log debug exception for specific time.

Parameters

t	time for this message to log
component	component, used to distuinguish logged messages
e	exception to log, exception messages will be logged

Implements fawkes::Logger.

Definition at line 392 of file file.cpp.

References fawkes::Exception::begin(), fawkes::Exception::end(), fawkes::Logger::LL_DEBUG, fawkes::Mutex::lock(), fawkes::Logger::log_level, and fawkes::Mutex::unlock().

◆ tlog_error() [1/2]

void fawkes::FileLogger::tlog_error	(	struct timeval *	t,
		const char *	component,
		const char *	format,
			...
	)

virtual

Log error message for specific time.

Parameters

t	time for this message to log
component	component, used to distuinguish logged messages
format	format of the message, see man page of sprintf for available tokens.

Implements fawkes::Logger.

Definition at line 383 of file file.cpp.

References vtlog_error().

◆ tlog_error() [2/2]

void fawkes::FileLogger::tlog_error	(	struct timeval *	t,
		const char *	component,
		Exception &	e
	)

virtual

Log error exception for specific time.

Parameters

t	time for this message to log
component	component, used to distuinguish logged messages
e	exception to log, exception messages will be logged

Implements fawkes::Logger.

Definition at line 461 of file file.cpp.

References fawkes::Exception::begin(), fawkes::Exception::end(), fawkes::Logger::LL_ERROR, fawkes::Mutex::lock(), fawkes::Logger::log_level, and fawkes::Mutex::unlock().

◆ tlog_info() [1/2]

void fawkes::FileLogger::tlog_info	(	struct timeval *	t,
		const char *	component,
		const char *	format,
			...
	)

virtual

Log informational message for specific time.

Parameters

t	time for this message to log
component	component, used to distuinguish logged messages
format	format of the message, see man page of sprintf for available tokens.

Implements fawkes::Logger.

Definition at line 365 of file file.cpp.

References vtlog_info().

◆ tlog_info() [2/2]

void fawkes::FileLogger::tlog_info	(	struct timeval *	t,
		const char *	component,
		Exception &	e
	)

virtual

Log informational exception for specific time.

Parameters

t	time for this message to log
component	component, used to distuinguish logged messages
e	exception to log, exception messages will be logged

Implements fawkes::Logger.

Definition at line 415 of file file.cpp.

References fawkes::Exception::begin(), fawkes::Exception::end(), fawkes::Logger::LL_INFO, fawkes::Mutex::lock(), fawkes::Logger::log_level, and fawkes::Mutex::unlock().

◆ tlog_warn() [1/2]

void fawkes::FileLogger::tlog_warn	(	struct timeval *	t,
		const char *	component,
		const char *	format,
			...
	)

virtual

Log warning message for specific time.

Parameters

t	time for this message to log
component	component, used to distuinguish logged messages
format	format of the message, see man page of sprintf for available tokens.

Implements fawkes::Logger.

Definition at line 374 of file file.cpp.

References vtlog_warn().

◆ tlog_warn() [2/2]

void fawkes::FileLogger::tlog_warn	(	struct timeval *	t,
		const char *	component,
		Exception &	e
	)

virtual

Log warning exception for specific time.

Parameters

t	time for this message to log
component	component, used to distuinguish logged messages
e	exception to log, exception messages will be logged

Implements fawkes::Logger.

Definition at line 438 of file file.cpp.

References fawkes::Exception::begin(), fawkes::Exception::end(), fawkes::Logger::LL_WARN, fawkes::Mutex::lock(), fawkes::Logger::log_level, and fawkes::Mutex::unlock().

◆ vlog_debug()

void fawkes::FileLogger::vlog_debug	(	const char *	component,
		const char *	format,
		va_list	va
	)

virtual

Log debug message.

Parameters

component	component, used to distuinguish logged messages
format	format of the message, see man page of sprintf for available tokens.
va	variable argument list

Implements fawkes::Logger.

Definition at line 264 of file file.cpp.

References fawkes::Logger::LL_DEBUG, fawkes::Mutex::lock(), fawkes::Logger::log_level, and fawkes::Mutex::unlock().

Referenced by log_debug().

◆ vlog_error()

void fawkes::FileLogger::vlog_error	(	const char *	component,
		const char *	format,
		va_list	va
	)

virtual

Log error message.

Parameters

component	component, used to distuinguish logged messages
format	format of the message, see man page of sprintf for available tokens.
va	variable argument list

Implements fawkes::Logger.

Definition at line 333 of file file.cpp.

References fawkes::Logger::LL_ERROR, fawkes::Mutex::lock(), fawkes::Logger::log_level, and fawkes::Mutex::unlock().

Referenced by log_error().

◆ vlog_info()

void fawkes::FileLogger::vlog_info	(	const char *	component,
		const char *	format,
		va_list	va
	)

virtual

Log informational message.

Parameters

component	component, used to distuinguish logged messages
format	format of the message, see man page of sprintf for available tokens.
va	variable argument list

Implements fawkes::Logger.

Definition at line 287 of file file.cpp.

References fawkes::Logger::LL_INFO, fawkes::Mutex::lock(), fawkes::Logger::log_level, and fawkes::Mutex::unlock().

Referenced by log_info().

◆ vlog_warn()

void fawkes::FileLogger::vlog_warn	(	const char *	component,
		const char *	format,
		va_list	va
	)

virtual

Log warning message.

Parameters

component	component, used to distuinguish logged messages
format	format of the message, see man page of sprintf for available tokens.
va	variable argument list

Implements fawkes::Logger.

Definition at line 310 of file file.cpp.

References fawkes::Logger::LL_WARN, fawkes::Mutex::lock(), fawkes::Logger::log_level, and fawkes::Mutex::unlock().

Referenced by log_warn().

◆ vtlog_debug()

void fawkes::FileLogger::vtlog_debug	(	struct timeval *	t,
		const char *	component,
		const char *	format,
		va_list	va
	)

virtual

Log debug message for specific time.

Parameters

t	time for this message to log
component	component, used to distuinguish logged messages
format	format of the message, see man page of sprintf for available tokens.
va	variable argument list

Implements fawkes::Logger.

Definition at line 484 of file file.cpp.

References fawkes::Logger::LL_DEBUG, fawkes::Mutex::lock(), fawkes::Logger::log_level, and fawkes::Mutex::unlock().

Referenced by tlog_debug().

◆ vtlog_error()

void fawkes::FileLogger::vtlog_error	(	struct timeval *	t,
		const char *	component,
		const char *	format,
		va_list	va
	)

virtual

Log error message for specific time.

Parameters

t	time for this message to log
component	component, used to distuinguish logged messages
format	format of the message, see man page of sprintf for available tokens.
va	variable argument list

Implements fawkes::Logger.

Definition at line 547 of file file.cpp.

References fawkes::Logger::LL_ERROR, fawkes::Mutex::lock(), fawkes::Logger::log_level, and fawkes::Mutex::unlock().

Referenced by tlog_error().

◆ vtlog_info()

void fawkes::FileLogger::vtlog_info	(	struct timeval *	t,
		const char *	component,
		const char *	format,
		va_list	va
	)

virtual

Log informational message for specific time.

Parameters

t	time for this message to log
component	component, used to distuinguish logged messages
format	format of the message, see man page of sprintf for available tokens.
va	variable argument list

Implements fawkes::Logger.

Definition at line 505 of file file.cpp.

References fawkes::Logger::LL_INFO, fawkes::Mutex::lock(), fawkes::Logger::log_level, and fawkes::Mutex::unlock().

Referenced by tlog_info().

◆ vtlog_warn()

void fawkes::FileLogger::vtlog_warn	(	struct timeval *	t,
		const char *	component,
		const char *	format,
		va_list	va
	)

virtual

Log warning message for specific time.

Parameters

t	time for this message to log
component	component, used to distuinguish logged messages
format	format of the message, see man page of sprintf for available tokens.
va	variable argument list

Implements fawkes::Logger.

Definition at line 526 of file file.cpp.

References fawkes::Logger::LL_WARN, fawkes::Mutex::lock(), fawkes::Logger::log_level, and fawkes::Mutex::unlock().

Referenced by tlog_warn().

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

src/libs/logging/file.h
src/libs/logging/file.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FileLogger()

◆ ~FileLogger()

Member Function Documentation

◆ log_debug() [1/2]

◆ log_debug() [2/2]

◆ log_error() [1/2]

◆ log_error() [2/2]

◆ log_info() [1/2]

◆ log_info() [2/2]

◆ log_warn() [1/2]

◆ log_warn() [2/2]

◆ tlog_debug() [1/2]

◆ tlog_debug() [2/2]

◆ tlog_error() [1/2]

◆ tlog_error() [2/2]

◆ tlog_info() [1/2]

◆ tlog_info() [2/2]

◆ tlog_warn() [1/2]

◆ tlog_warn() [2/2]

◆ vlog_debug()

◆ vlog_error()

◆ vlog_info()

◆ vlog_warn()

◆ vtlog_debug()

◆ vtlog_error()

◆ vtlog_info()

◆ vtlog_warn()