Fawkes API  Fawkes Development Version
fawkes::MultiLogger Class Reference

#include <>>

Inheritance diagram for fawkes::MultiLogger:

Public Member Functions

 MultiLogger ()
 Constructor. More...
 
 MultiLogger (Logger *logger)
 Constructor. More...
 
virtual ~MultiLogger ()
 Destructor. More...
 
void add_logger (Logger *logger)
 Add a logger. More...
 
void remove_logger (Logger *logger)
 Remove logger. More...
 
virtual void set_loglevel (LogLevel level)
 Sets the log level. More...
 
virtual void log (LogLevel level, const char *component, const char *format,...)
 Log message of given log level. More...
 
virtual void log_debug (const char *component, const char *format,...)
 
virtual void log_info (const char *component, const char *format,...)
 
virtual void log_warn (const char *component, const char *format,...)
 
virtual void log_error (const char *component, const char *format,...)
 
virtual void log (LogLevel level, const char *component, Exception &e)
 Log exception for given log level. More...
 
virtual void log_debug (const char *component, Exception &e)
 
virtual void log_info (const char *component, Exception &e)
 
virtual void log_warn (const char *component, Exception &e)
 
virtual void log_error (const char *component, Exception &e)
 
virtual void vlog (LogLevel level, const char *component, const char *format, va_list va)
 Log message for given log level. More...
 
virtual void vlog_debug (const char *component, const char *format, va_list va)
 
virtual void vlog_info (const char *component, const char *format, va_list va)
 
virtual void vlog_warn (const char *component, const char *format, va_list va)
 
virtual void vlog_error (const char *component, const char *format, va_list va)
 
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_debug (struct timeval *t, const char *component, const char *format,...)
 
virtual void tlog_info (struct timeval *t, const char *component, const char *format,...)
 
virtual void tlog_warn (struct timeval *t, const char *component, const char *format,...)
 
virtual void tlog_error (struct timeval *t, const char *component, const char *format,...)
 
virtual void tlog (LogLevel level, struct timeval *t, const char *component, Exception &e)
 Log exception for given log level. More...
 
virtual void tlog_debug (struct timeval *t, const char *component, Exception &e)
 
virtual void tlog_info (struct timeval *t, const char *component, Exception &e)
 
virtual void tlog_warn (struct timeval *t, const char *component, Exception &e)
 
virtual void tlog_error (struct timeval *t, const char *component, Exception &e)
 
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...
 
virtual void vtlog_debug (struct timeval *t, const char *component, const char *format, va_list va)
 
virtual void vtlog_info (struct timeval *t, const char *component, const char *format, va_list va)
 
virtual void vtlog_warn (struct timeval *t, const char *component, const char *format, va_list va)
 
virtual void vtlog_error (struct timeval *t, const char *component, const char *format, va_list va)
 
- Public Member Functions inherited from fawkes::Logger
 Logger (LogLevel log_level=LL_DEBUG)
 Constructor. More...
 
virtual ~Logger ()
 Virtual empty destructor. More...
 
virtual LogLevel loglevel ()
 Get log level. More...
 
- Public Member Functions inherited from fawkes::LoggerEmployer
virtual ~LoggerEmployer ()
 Virtual empty destructor. 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

Log through multiple loggers. It can be hand to have the opportunity to log to multiple channels, for example log to a file and via network to a remote console. This can be done with the MultiLogger. You can add an arbitrary number of loggers to log the output to. Use the minimum number of necessary loggers though because this can cause a high burden on log users if you have too many loggers.

Note that the multi logger takes over the ownership of the logger. That means that the multi logger destroys all sub-loggers when it is deleted itself. If you want to take over the loggers without destroying them you have to properly remove them before destroying the multi logger.

Author
Tim Niemueller

Definition at line 38 of file multi.h.

Constructor & Destructor Documentation

◆ MultiLogger() [1/2]

fawkes::MultiLogger::MultiLogger ( )

Constructor.

This will create the logger without any sub-loggers. Message that are logged are simply ignored.

Definition at line 81 of file multi.cpp.

◆ MultiLogger() [2/2]

fawkes::MultiLogger::MultiLogger ( Logger logger)

Constructor.

This sets one sub-logger that messages are sent to.

Parameters
loggersub-logger

Definition at line 90 of file multi.cpp.

◆ ~MultiLogger()

fawkes::MultiLogger::~MultiLogger ( )
virtual

Destructor.

This will destroy all sub-data->loggers (they are deleted).

Definition at line 99 of file multi.cpp.

Member Function Documentation

◆ add_logger()

void fawkes::MultiLogger::add_logger ( Logger logger)
virtual

Add a logger.

Parameters
loggernew sub-logger to add

Implements fawkes::LoggerEmployer.

Definition at line 114 of file multi.cpp.

◆ log() [1/2]

void fawkes::MultiLogger::log ( LogLevel  level,
const char *  component,
const char *  format,
  ... 
)
virtual

Log message of given log level.

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

Reimplemented from fawkes::Logger.

Definition at line 157 of file multi.cpp.

◆ log() [2/2]

void fawkes::MultiLogger::log ( LogLevel  level,
const char *  component,
Exception e 
)
virtual

Log exception for given log level.

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

Reimplemented from fawkes::Logger.

Definition at line 262 of file multi.cpp.

◆ log_debug() [1/2]

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

◆ log_debug() [2/2]

void fawkes::MultiLogger::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 277 of file multi.cpp.

◆ log_error() [1/2]

void fawkes::MultiLogger::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 241 of file multi.cpp.

Referenced by LaserPointCloudThread::bb_interface_created(), BBLoggerThread::bb_interface_data_changed(), AmclThread::loop(), MiniImageProducer::MiniImageProducer(), BlackBoardSynchronizationThread::writer_added(), and BlackBoardSynchronizationThread::writer_removed().

◆ log_error() [2/2]

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

Log error exception.

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

Implements fawkes::Logger.

Definition at line 323 of file multi.cpp.

◆ log_info() [1/2]

◆ log_info() [2/2]

void fawkes::MultiLogger::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 293 of file multi.cpp.

◆ log_warn() [1/2]

◆ log_warn() [2/2]

void fawkes::MultiLogger::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 308 of file multi.cpp.

◆ remove_logger()

void fawkes::MultiLogger::remove_logger ( Logger logger)
virtual

Remove logger.

Parameters
loggerSub-logger to remove

Implements fawkes::LoggerEmployer.

Definition at line 132 of file multi.cpp.

◆ set_loglevel()

void fawkes::MultiLogger::set_loglevel ( LogLevel  level)
virtual

Sets the log level.

The log level determines the minimum log level. If a message is logged that is below this level the message is ignored.

Parameters
levelnew log level

Reimplemented from fawkes::Logger.

Definition at line 143 of file multi.cpp.

◆ tlog() [1/2]

void fawkes::MultiLogger::tlog ( LogLevel  level,
struct timeval *  t,
const char *  component,
const char *  format,
  ... 
)
virtual

Log message of given log level and time.

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

Reimplemented from fawkes::Logger.

Definition at line 428 of file multi.cpp.

Referenced by tlog().

◆ tlog() [2/2]

void fawkes::MultiLogger::tlog ( LogLevel  level,
struct timeval *  t,
const char *  component,
Exception e 
)
virtual

Log exception for given log level.

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

Reimplemented from fawkes::Logger.

Definition at line 521 of file multi.cpp.

References tlog().

◆ tlog_debug() [1/2]

void fawkes::MultiLogger::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 446 of file multi.cpp.

◆ tlog_debug() [2/2]

void fawkes::MultiLogger::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 534 of file multi.cpp.

◆ tlog_error() [1/2]

void fawkes::MultiLogger::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 502 of file multi.cpp.

Referenced by tlog_error(), tlog_info(), and tlog_warn().

◆ tlog_error() [2/2]

void fawkes::MultiLogger::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 568 of file multi.cpp.

References tlog_error().

◆ tlog_info() [1/2]

void fawkes::MultiLogger::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 464 of file multi.cpp.

◆ tlog_info() [2/2]

void fawkes::MultiLogger::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 542 of file multi.cpp.

References tlog_error().

◆ tlog_warn() [1/2]

void fawkes::MultiLogger::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 483 of file multi.cpp.

◆ tlog_warn() [2/2]

void fawkes::MultiLogger::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 555 of file multi.cpp.

References tlog_error().

◆ vlog()

void fawkes::MultiLogger::vlog ( LogLevel  level,
const char *  component,
const char *  format,
va_list  va 
)
virtual

Log message for given log level.

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

Reimplemented from fawkes::Logger.

Definition at line 338 of file multi.cpp.

◆ vlog_debug()

void fawkes::MultiLogger::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 356 of file multi.cpp.

◆ vlog_error()

void fawkes::MultiLogger::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 410 of file multi.cpp.

◆ vlog_info()

void fawkes::MultiLogger::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 374 of file multi.cpp.

◆ vlog_warn()

void fawkes::MultiLogger::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 392 of file multi.cpp.

◆ vtlog()

void fawkes::MultiLogger::vtlog ( LogLevel  level,
struct timeval *  t,
const char *  component,
const char *  format,
va_list  va 
)
virtual

Log message for given log level and time.

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

Reimplemented from fawkes::Logger.

Definition at line 581 of file multi.cpp.

References fawkes::Thread::CANCEL_DISABLED, and fawkes::Thread::set_cancel_state().

◆ vtlog_debug()

void fawkes::MultiLogger::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 601 of file multi.cpp.

◆ vtlog_error()

void fawkes::MultiLogger::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 649 of file multi.cpp.

◆ vtlog_info()

void fawkes::MultiLogger::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 617 of file multi.cpp.

◆ vtlog_warn()

void fawkes::MultiLogger::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 633 of file multi.cpp.


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