Tomographer  v5.3
Tomographer C++ Framework Documentation
Tomographer::Logger::OriginPrefixedLogger< BaseLogger > Class Template Reference

Logger which prepends to each origin string a fixed prefix. More...

#include <tomographer/tools/loggers.h>

+ Inheritance diagram for Tomographer::Logger::OriginPrefixedLogger< BaseLogger >:
+ Collaboration diagram for Tomographer::Logger::OriginPrefixedLogger< BaseLogger >:

Public Member Functions

 OriginPrefixedLogger (BaseLogger &baselogger_, std::string prefix_)
 Constructor from a base logger. More...
 
void setPrefix (std::string prefix_)
 Change the prefix to a new value. Obviously not thread-safe.
 
void emitLog (int level, const char *origin, std::string msg)
 Emit a log by relaying to the base logger.
 
int level () const
 Get the base logger's set level.
 
template<ENABLED_IF( LoggerTraits< BaseLogger >::HasFilterByOrigin) >
bool filterByOrigin (int level, const char *origin)
 If relevant for the base logger, filter the messages by origin from the base logger.
 
- Public Member Functions inherited from Tomographer::Logger::LoggerBase< OriginPrefixedLogger< BaseLogger > >
 LoggerBase (int level_=INFO)
 Construct the base logger object. More...
 
bool enabledFor (int level_) const
 Check whether messages at the given log level are enabled. More...
 
int level () const
 Get the log level set for this logger. More...
 
void error (const char *origin, const char *fmt,...)
 emit an error message More...
 
void error (const char *origin, std::string msg)
 emit an error message More...
 
void error (const char *origin, Fn &&f)
 emit an error message More...
 
void error (Args &&...)
 Special-case implementation for messages which are known to be discarded at compile time.
 
void warning (const char *origin, const char *fmt,...)
 emit a warning message More...
 
void warning (const char *origin, std::string msg)
 emit a warning message More...
 
void warning (const char *origin, Fn &&f)
 emit a warning message More...
 
void warning (Args &&...)
 Special-case implementation for messages which are known to be discarded at compile time.
 
void info (const char *origin, const char *fmt,...)
 emit an information/notice message More...
 
void info (const char *origin, std::string msg)
 emit an information/notice message More...
 
void info (const char *origin, Fn &&f)
 emit an information/notice message More...
 
void info (Args &&...)
 Special-case implementation for messages which are known to be discarded at compile time.
 
void debug (const char *origin, const char *fmt,...)
 emit an debug message More...
 
void debug (const char *origin, std::string msg)
 emit an debug message More...
 
void debug (const char *origin, Fn &&f)
 emit an debug message More...
 
void debug (Args &&...)
 Special-case implementation for messages which are known to be discarded at compile time.
 
void longdebug (const char *origin, const char *fmt,...)
 emit a very verbose debugging message More...
 
void longdebug (const char *origin, std::string msg)
 emit a very verbose debugging message More...
 
void longdebug (const char *origin, Fn &&f)
 emit a very verbose debugging message More...
 
void longdebug (Args &&...)
 Special-case implementation for messages which are known to be discarded at compile time.
 
void log (int level, const char *origin, const char *fmt,...)
 emit a log message at the given log level. More...
 
void log (int level, const char *origin, std::string msg)
 emit a log message at the given log level. More...
 
void log (int level, const char *origin, Fn &&f)
 emit a log message at the given log level. More...
 
void log (const char *origin, const char *fmt,...)
 emit a log message at the given log level. More...
 
void log (const char *origin, const char *fmt, va_list ap)
 emit a log message at the given log level. More...
 
void log (const char *origin, std::string msg)
 emit a log message at the given log level. More...
 
void log (const char *origin, Fn f)
 emit a log message at the given log level. More...
 
void log (Args &&...)
 Special-case implementation for messages which are known to be discarded at compile time.
 

Additional Inherited Members

- Public Types inherited from Tomographer::Logger::LoggerBase< OriginPrefixedLogger< BaseLogger > >
enum  
 Shortcuts to properties defined in the traits class.
 
- Static Public Member Functions inherited from Tomographer::Logger::LoggerBase< OriginPrefixedLogger< BaseLogger > >
static bool staticallyEnabledFor (int level)
 Check whether the logger is statically disabled for some levels. More...
 
static constexpr bool staticallyEnabledFor ()
 Static version of staticallyEnabledFor() More...
 
- Protected Member Functions inherited from Tomographer::Logger::LoggerBase< OriginPrefixedLogger< BaseLogger > >
int getLevel () const
 
int getLevel () const
 
OriginPrefixedLogger< BaseLogger > * derived ()
 
const OriginPrefixedLogger< BaseLogger > * derived () const
 
void setLogLevel (int level)
 Store a new run-time log level. More...
 

Detailed Description

template<typename BaseLogger>
class Tomographer::Logger::OriginPrefixedLogger< BaseLogger >

Logger which prepends to each origin string a fixed prefix.

This logger interfaces another logger of type BaseLogger.

If BaseLogger is thread-safe, then this logger is also thread-safe.

If the BaseLogger implements by-origin filtering, then the filtering is still honored, using the unmodified origin string.

Since
This class was introduced in Tomographer 5.3.

Definition at line 1303 of file loggers.h.

Constructor & Destructor Documentation

§ OriginPrefixedLogger()

template<typename BaseLogger >
Tomographer::Logger::OriginPrefixedLogger< BaseLogger >::OriginPrefixedLogger ( BaseLogger &  baselogger_,
std::string  prefix_ 
)
inline

Constructor from a base logger.

You must provide a reference to an instance of a logger, to which we will relay relevant calls.

Definition at line 1342 of file loggers.h.


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