Fawkes API  Fawkes Development Version
fawkes::ComponentLogger Class Reference

#include <>>

Public Member Functions

 ComponentLogger (Logger *logger, const char *component)
 Constructor. More...
 
 ~ComponentLogger ()
 Destructor. More...
 
void set_component (const char *format,...)
 Set a new component name. More...
 
void log_debug (const char *format,...)
 Log debug message. More...
 
void log_info (const char *format,...)
 Log info message. More...
 
void log_warn (const char *format,...)
 Log warning message. More...
 
void log_error (const char *format,...)
 Log error message. More...
 
void log_debug (std::string message)
 Log debug message. More...
 
void log_info (std::string message)
 Log info message. More...
 
void log_warn (std::string message)
 Log warning message. More...
 
void log_error (std::string message)
 Log error message. More...
 
void log_debug (Exception &e)
 Log exception at debug log level. More...
 
void log_info (Exception &e)
 Log exception at info log level. More...
 
void log_warn (Exception &e)
 Log exception at warn log level. More...
 
void log_error (Exception &e)
 Log exception at error log level. More...
 

Detailed Description

Component logger. This is a small wrapper around a logger to make it simpler to use in a single component. Once initialized it will only accept messages for a specific component string offers a simplified interface to logging methods.

Author
Tim Niemueller

Definition at line 41 of file component.h.

Constructor & Destructor Documentation

◆ ComponentLogger()

fawkes::ComponentLogger::ComponentLogger ( Logger logger,
const char *  component 
)

Constructor.

Parameters
loggerlogger to use
componentcomponent string, copied to internal buffer

Definition at line 52 of file component.cpp.

◆ ~ComponentLogger()

fawkes::ComponentLogger::~ComponentLogger ( )

Destructor.

Definition at line 59 of file component.cpp.

Member Function Documentation

◆ log_debug() [1/3]

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

Log debug message.

Parameters
formatformat of the message, see man page of sprintf for available tokens.

Definition at line 87 of file component.cpp.

◆ log_debug() [2/3]

void fawkes::ComponentLogger::log_debug ( Exception e)

Log exception at debug log level.

Parameters
eexception to log, exception messages will be logged

Definition at line 174 of file component.cpp.

References fawkes::Logger::log_info().

◆ log_debug() [3/3]

void fawkes::ComponentLogger::log_debug ( std::string  message)

Log debug message.

Parameters
messagemessage to log

Definition at line 138 of file component.cpp.

References fawkes::Logger::log_info().

◆ log_error() [1/3]

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

Log error message.

Parameters
formatformat of the message, see man page of sprintf for available tokens.

Definition at line 126 of file component.cpp.

◆ log_error() [2/3]

void fawkes::ComponentLogger::log_error ( Exception e)

Log exception at error log level.

Parameters
eexception to log, exception messages will be logged

Definition at line 201 of file component.cpp.

◆ log_error() [3/3]

void fawkes::ComponentLogger::log_error ( std::string  message)

Log error message.

Parameters
messagemessage to log

Definition at line 165 of file component.cpp.

References fawkes::Logger::log_debug().

◆ log_info() [1/3]

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

Log info message.

Parameters
formatformat of the message, see man page of sprintf for available tokens.

Definition at line 100 of file component.cpp.

◆ log_info() [2/3]

void fawkes::ComponentLogger::log_info ( Exception e)

Log exception at info log level.

Parameters
eexception to log, exception messages will be logged

Definition at line 183 of file component.cpp.

References fawkes::Logger::log_warn().

◆ log_info() [3/3]

void fawkes::ComponentLogger::log_info ( std::string  message)

Log info message.

Parameters
messagemessage to log

Definition at line 147 of file component.cpp.

References fawkes::Logger::log_warn().

◆ log_warn() [1/3]

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

Log warning message.

Parameters
formatformat of the message, see man page of sprintf for available tokens.

Definition at line 113 of file component.cpp.

◆ log_warn() [2/3]

void fawkes::ComponentLogger::log_warn ( Exception e)

Log exception at warn log level.

Parameters
eexception to log, exception messages will be logged

Definition at line 192 of file component.cpp.

References fawkes::Logger::log_debug().

◆ log_warn() [3/3]

void fawkes::ComponentLogger::log_warn ( std::string  message)

Log warning message.

Parameters
messagemessage to log

Definition at line 156 of file component.cpp.

References fawkes::Logger::log_error().

◆ set_component()

void fawkes::ComponentLogger::set_component ( const char *  format,
  ... 
)

Set a new component name.

Parameters
formatformat string for the new command string, cf. sprintf man page for allowed syntax.

Definition at line 69 of file component.cpp.


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