Fawkes API  Fawkes Development Version
fawkes::CacheLogger Class Reference

Logging Cache. More...

#include <>>

Inheritance diagram for fawkes::CacheLogger:

Classes

struct  CacheEntry
 Cache entry struct. More...
 

Public Member Functions

 CacheLogger (unsigned int num_entries=20, LogLevel log_level=LL_DEBUG)
 Constructor. More...
 
virtual ~CacheLogger ()
 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...
 
std::list< CacheEntry > & get_messages ()
 Get messages. More...
 
void clear ()
 Clear messages. More...
 
unsigned int size () const
 Get maximum number of log entries in cache. More...
 
void set_size (unsigned int new_size)
 Set maximum number of log entries in cache. More...
 
void lock ()
 Lock cache logger, no new messages can be added. More...
 
void unlock ()
 Unlock cache logger. 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

Logging Cache.

The CacheLogger will cache the log messages. By default these are 20 messages.

Author
Tim Niemueller

Definition at line 40 of file cache.h.

Constructor & Destructor Documentation

◆ CacheLogger()

fawkes::CacheLogger::CacheLogger ( unsigned int  num_entries = 20,
LogLevel  log_level = LL_DEBUG 
)

Constructor.

Parameters
num_entriesnumber of entries in the cache, if the cache is full and a new log message arrives the oldest message is erased.
log_levelminimum level to log

Definition at line 51 of file cache.cpp.

◆ ~CacheLogger()

fawkes::CacheLogger::~CacheLogger ( )
virtual

Destructor.

Definition at line 62 of file cache.cpp.

Member Function Documentation

◆ clear()

void fawkes::CacheLogger::clear ( void  )

Clear messages.

Definition at line 75 of file cache.cpp.

References fawkes::Mutex::lock(), and fawkes::Mutex::unlock().

Referenced by XmlRpcThread::init(), and WebviewThread::init().

◆ get_messages()

std::list< CacheLogger::CacheEntry > & fawkes::CacheLogger::get_messages ( )

Get messages.

Returns
reference to message list

Definition at line 69 of file cache.cpp.

◆ lock()

void fawkes::CacheLogger::lock ( )

Lock cache logger, no new messages can be added.

Use with care, can cause critical delays in the whole software stack!

Definition at line 113 of file cache.cpp.

References fawkes::Mutex::lock().

Referenced by log_error(), set_size(), and unlock().

◆ log_debug() [1/2]

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

Log debug message.

Parameters
componentcomponent, used to distuinguish logged messages
formatformat of the message, see man page of sprintf for available tokens.

Implements fawkes::Logger.

Definition at line 224 of file cache.cpp.

References fawkes::Logger::LL_DEBUG.

◆ log_debug() [2/2]

void fawkes::CacheLogger::log_debug ( const char *  component,
Exception e 
)
virtual

Log debug exception.

Parameters
componentcomponent, used to distuinguish logged messages
eexception to log, exception messages will be logged

Implements fawkes::Logger.

Definition at line 260 of file cache.cpp.

References fawkes::Logger::LL_DEBUG.

◆ log_error() [1/2]

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

Log error message.

Parameters
componentcomponent, used to distuinguish logged messages
formatformat of the message, see man page of sprintf for available tokens.

Implements fawkes::Logger.

Definition at line 251 of file cache.cpp.

References fawkes::Logger::LL_ERROR.

◆ log_error() [2/2]

void fawkes::CacheLogger::log_error ( const char *  component,
Exception e 
)
virtual

◆ log_info() [1/2]

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

Log informational message.

Parameters
componentcomponent, used to distuinguish logged messages
formatformat of the message, see man page of sprintf for available tokens.

Implements fawkes::Logger.

Definition at line 233 of file cache.cpp.

References fawkes::Logger::LL_INFO.

◆ log_info() [2/2]

void fawkes::CacheLogger::log_info ( const char *  component,
Exception e 
)
virtual

Log informational exception.

Parameters
componentcomponent, used to distuinguish logged messages
eexception to log, exception messages will be logged

Implements fawkes::Logger.

Definition at line 266 of file cache.cpp.

References fawkes::Logger::LL_INFO.

◆ log_warn() [1/2]

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

Log warning message.

Parameters
componentcomponent, used to distuinguish logged messages
formatformat of the message, see man page of sprintf for available tokens.

Implements fawkes::Logger.

Definition at line 242 of file cache.cpp.

References fawkes::Logger::LL_WARN.

◆ log_warn() [2/2]

void fawkes::CacheLogger::log_warn ( const char *  component,
Exception e 
)
virtual

Log warning exception.

Parameters
componentcomponent, used to distuinguish logged messages
eexception to log, exception messages will be logged

Implements fawkes::Logger.

Definition at line 272 of file cache.cpp.

References fawkes::Logger::LL_WARN.

◆ set_size()

void fawkes::CacheLogger::set_size ( unsigned int  new_size)

Set maximum number of log entries in cache.

Parameters
new_sizenew size

Definition at line 98 of file cache.cpp.

References lock().

◆ size()

unsigned int fawkes::CacheLogger::size ( ) const

Get maximum number of log entries in cache.

Returns
maximum number of cache entries

Definition at line 88 of file cache.cpp.

◆ tlog_debug() [1/2]

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

Log debug message for specific time.

Parameters
ttime for this message to log
componentcomponent, used to distuinguish logged messages
formatformat of the message, see man page of sprintf for available tokens.

Implements fawkes::Logger.

Definition at line 353 of file cache.cpp.

References fawkes::Logger::LL_DEBUG.

◆ tlog_debug() [2/2]

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

Log debug exception for specific time.

Parameters
ttime for this message to log
componentcomponent, used to distuinguish logged messages
eexception to log, exception messages will be logged

Implements fawkes::Logger.

Definition at line 389 of file cache.cpp.

References fawkes::Logger::LL_DEBUG.

◆ tlog_error() [1/2]

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

Log error message for specific time.

Parameters
ttime for this message to log
componentcomponent, used to distuinguish logged messages
formatformat of the message, see man page of sprintf for available tokens.

Implements fawkes::Logger.

Definition at line 380 of file cache.cpp.

References fawkes::Logger::LL_ERROR.

◆ tlog_error() [2/2]

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

Log error exception for specific time.

Parameters
ttime for this message to log
componentcomponent, used to distuinguish logged messages
eexception to log, exception messages will be logged

Implements fawkes::Logger.

Definition at line 407 of file cache.cpp.

References fawkes::Logger::LL_ERROR.

◆ tlog_info() [1/2]

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

Log informational message for specific time.

Parameters
ttime for this message to log
componentcomponent, used to distuinguish logged messages
formatformat of the message, see man page of sprintf for available tokens.

Implements fawkes::Logger.

Definition at line 362 of file cache.cpp.

References fawkes::Logger::LL_INFO.

◆ tlog_info() [2/2]

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

Log informational exception for specific time.

Parameters
ttime for this message to log
componentcomponent, used to distuinguish logged messages
eexception to log, exception messages will be logged

Implements fawkes::Logger.

Definition at line 395 of file cache.cpp.

References fawkes::Logger::LL_INFO.

◆ tlog_warn() [1/2]

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

Log warning message for specific time.

Parameters
ttime for this message to log
componentcomponent, used to distuinguish logged messages
formatformat of the message, see man page of sprintf for available tokens.

Implements fawkes::Logger.

Definition at line 371 of file cache.cpp.

References fawkes::Logger::LL_WARN.

◆ tlog_warn() [2/2]

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

Log warning exception for specific time.

Parameters
ttime for this message to log
componentcomponent, used to distuinguish logged messages
eexception to log, exception messages will be logged

Implements fawkes::Logger.

Definition at line 401 of file cache.cpp.

References fawkes::Logger::LL_WARN.

◆ unlock()

◆ vlog_debug()

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

Log debug message.

Parameters
componentcomponent, used to distuinguish logged messages
formatformat of the message, see man page of sprintf for available tokens.
vavariable argument list

Implements fawkes::Logger.

Definition at line 200 of file cache.cpp.

References fawkes::Logger::LL_DEBUG.

◆ vlog_error()

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

Log error message.

Parameters
componentcomponent, used to distuinguish logged messages
formatformat of the message, see man page of sprintf for available tokens.
vavariable argument list

Implements fawkes::Logger.

Definition at line 218 of file cache.cpp.

References fawkes::Logger::LL_ERROR.

◆ vlog_info()

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

Log informational message.

Parameters
componentcomponent, used to distuinguish logged messages
formatformat of the message, see man page of sprintf for available tokens.
vavariable argument list

Implements fawkes::Logger.

Definition at line 206 of file cache.cpp.

References fawkes::Logger::LL_INFO.

◆ vlog_warn()

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

Log warning message.

Parameters
componentcomponent, used to distuinguish logged messages
formatformat of the message, see man page of sprintf for available tokens.
vavariable argument list

Implements fawkes::Logger.

Definition at line 212 of file cache.cpp.

References fawkes::Logger::LL_WARN.

◆ vtlog_debug()

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

Log debug message for specific time.

Parameters
ttime for this message to log
componentcomponent, used to distuinguish logged messages
formatformat of the message, see man page of sprintf for available tokens.
vavariable argument list

Implements fawkes::Logger.

Definition at line 413 of file cache.cpp.

References fawkes::Logger::LL_DEBUG.

◆ vtlog_error()

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

Log error message for specific time.

Parameters
ttime for this message to log
componentcomponent, used to distuinguish logged messages
formatformat of the message, see man page of sprintf for available tokens.
vavariable argument list

Implements fawkes::Logger.

Definition at line 431 of file cache.cpp.

References fawkes::Logger::LL_ERROR.

◆ vtlog_info()

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

Log informational message for specific time.

Parameters
ttime for this message to log
componentcomponent, used to distuinguish logged messages
formatformat of the message, see man page of sprintf for available tokens.
vavariable argument list

Implements fawkes::Logger.

Definition at line 419 of file cache.cpp.

References fawkes::Logger::LL_INFO.

◆ vtlog_warn()

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

Log warning message for specific time.

Parameters
ttime for this message to log
componentcomponent, used to distuinguish logged messages
formatformat of the message, see man page of sprintf for available tokens.
vavariable argument list

Implements fawkes::Logger.

Definition at line 425 of file cache.cpp.

References fawkes::Logger::LL_WARN.


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