CIRCT  20.0.0git
Public Member Functions | List of all members
esi::NullLogger Class Reference

A logger that does nothing. More...

#include <Logging.h>

Inheritance diagram for esi::NullLogger:
Inheritance graph
[legend]
Collaboration diagram for esi::NullLogger:
Collaboration graph
[legend]

Public Member Functions

 NullLogger ()
 
void log (Level, const std::string &, const std::string &, const std::map< std::string, std::any > *) override
 Report a log message. More...
 
- Public Member Functions inherited from esi::Logger
 Logger (bool debugEnabled)
 
virtual ~Logger ()=default
 
bool getDebugEnabled ()
 
virtual void error (const std::string &subsystem, const std::string &msg, const std::map< std::string, std::any > *details=nullptr)
 Report an error. More...
 
virtual void warning (const std::string &subsystem, const std::string &msg, const std::map< std::string, std::any > *details=nullptr)
 Report a warning. More...
 
virtual void info (const std::string &subsystem, const std::string &msg, const std::map< std::string, std::any > *details=nullptr)
 Report an informational message. More...
 
void debug (const std::string &subsystem, const std::string &msg, const std::map< std::string, std::any > *details=nullptr)
 Report a debug message. More...
 
void debug (std::function< void(std::string &subsystem, std::string &msg, std::unique_ptr< std::map< std::string, std::any >> &details)> debugFunc)
 Call the debug function callback only if debug is enabled then log a debug message. More...
 

Additional Inherited Members

- Public Types inherited from esi::Logger
enum class  Level { Debug , Info , Warning , Error }
 
- Protected Member Functions inherited from esi::Logger
virtual void debugImpl (const std::string &subsystem, const std::string &msg, const std::map< std::string, std::any > *details)
 Overrideable version of debug. Only gets called if debug is enabled. More...
 
virtual void debugImpl (std::function< void(std::string &subsystem, std::string &msg, std::unique_ptr< std::map< std::string, std::any >> &details)> debugFunc)
 Overrideable version of debug. Only gets called if debug is enabled. More...
 
- Protected Attributes inherited from esi::Logger
bool debugEnabled = false
 Enable or disable debug messages. More...
 

Detailed Description

A logger that does nothing.

Definition at line 169 of file Logging.h.

Constructor & Destructor Documentation

◆ NullLogger()

esi::NullLogger::NullLogger ( )
inline

Definition at line 171 of file Logging.h.

Member Function Documentation

◆ log()

void esi::NullLogger::log ( Level  level,
const std::string &  subsystem,
const std::string &  msg,
const std::map< std::string, std::any > *  details 
)
inlineoverridevirtual

Report a log message.

Arguments: level: The log level as defined by the 'Level' enum above. subsystem: The subsystem that generated the log message. msg: The log message. details: Optional additional structured details to include in the log message. If there are no details, this should be nullptr.

Implements esi::Logger.

Definition at line 172 of file Logging.h.


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