blocxx
BLOCXX_NAMESPACE::AppenderLogger Class Reference

This implementation of Logger is used to send a Log message to multiple LogAppenders. More...

#include <AppenderLogger.hpp>

Inheritance diagram for BLOCXX_NAMESPACE::AppenderLogger:
BLOCXX_NAMESPACE::Logger BLOCXX_NAMESPACE::IntrusiveCountableBase

Public Member Functions

 AppenderLogger (const String &defaultComponent, const LogAppenderRef &appender)
 Create an AppenderLogger with one LogAppender.
 
 AppenderLogger (const String &defaultComponent, const Array< LogAppenderRef > &appenders)
 Create an AppenderLogger with multiple LogAppenders.
 
 AppenderLogger (const String &defaultComponent, ELogLevel logLevel, const LogAppenderRef &appender)
 Create an AppenderLogger with one LogAppender.
 
 AppenderLogger (const String &defaultComponent, ELogLevel logLevel, const Array< LogAppenderRef > &appenders)
 Create an AppenderLogger with multiple LogAppenders.
 
virtual ~AppenderLogger ()
 Destroy this AppenderLogger.
 
void addLogAppender (const LogAppenderRef &appender)
 
- Public Member Functions inherited from BLOCXX_NAMESPACE::Logger
 Logger (const String &defaultComponent=STR_DEFAULT_COMPONENT, const LogAppenderRef &appender=LogAppenderRef())
 
 Logger (const String &defaultComponent, const ELogLevel logLevel)
 
 Logger (const Logger &)
 
Loggeroperator= (const Logger &)
 
void swap (Logger &x)
 
virtual ~Logger ()
 
virtual LoggerRef clone () const BLOCXX_DEPRECATED
 
void logFatalError (const String &message, const char *filename=0, int fileline=-1, const char *methodname=0) const
 Log message with a fatal error category and the default component.
 
void logError (const String &message, const char *filename=0, int fileline=-1, const char *methodname=0) const
 If getLogLevel() >= E_ERROR_LEVEL, Log message with an error category and the default component.
 
void logWarning (const String &message, const char *filename=0, int fileline=-1, const char *methodname=0) const
 If getLogLevel() >= E_WARNING_LEVEL, Log info.
 
void logInfo (const String &message, const char *filename=0, int fileline=-1, const char *methodname=0) const
 If getLogLevel() >= E_INFO_LEVEL, Log info.
 
void logDebug (const String &message, const char *filename=0, int fileline=-1, const char *methodname=0) const
 If getLogLevel() >= E_DEBUG_LEVEL, Log debug info.
 
void logDebug2 (const String &message, const char *filename=0, int fileline=-1, const char *methodname=0) const
 If getLogLevel() >= E_DEBUG2_LEVEL, Log debug info.
 
void logDebug3 (const String &message, const char *filename=0, int fileline=-1, const char *methodname=0) const
 If getLogLevel() >= E_DEBUG3_LEVEL, Log debug info.
 
void logMessage (const String &component, const String &category, const String &message) const
 Log a message using the specified component and category The current log level is ignored.
 
void logMessage (const String &component, const String &category, const String &message, const char *filename, int fileline, const char *methodname) const
 Log a message using the specified component and category The current log level is ignored.
 
void logMessage (const String &category, const String &message) const
 Log a message using the default component and specified category.
 
void logMessage (const String &category, const String &message, const char *filename, int fileline, const char *methodname) const
 Log a message using the default component and specified category.
 
void logMessage (const LogMessage &message) const
 Log a message.
 
void setDefaultComponent (const String &component)
 Sets the default component.
 
String getDefaultComponent () const
 Gets the default component.
 
ELogLevel getLogLevel () const
 
void setLogLevel (ELogLevel logLevel)
 Set the log level.
 
void setLogLevel (const String &logLevel)
 Set the log level.
 
bool categoryIsEnabled (const String &category) const
 Determine if the log category is enabled.
 
bool levelIsEnabled (const ELogLevel level) const
 Check if the logger is enabled for given level.
 
bool componentAndCategoryAreEnabled (const String &component, const String &category) const
 Determine if the component and category are both enabled.
 

Static Public Member Functions

static ELogLevel getLevel (const Array< LogAppenderRef > &appenders)
 
- Static Public Member Functions inherited from BLOCXX_NAMESPACE::Logger
static ELogLevel stringToLogLevel (const String &logLevel)
 Convert a log level string to an enum value.
 
static String logLevelToString (ELogLevel logLevel)
 Convert a log level enum to a string.
 
static const LoggerasLogger (const Logger &lgr)
 Utility functions for backward compatibility with LoggerRef and the BLOCXX_LOG macros.
 
static const LoggerasLogger (const LoggerRef &lgr)
 

Additional Inherited Members

- Public Types inherited from BLOCXX_NAMESPACE::Logger
enum  ELoggerErrorCodes { E_UNKNOWN_LOG_APPENDER_TYPE , E_INVALID_MAX_FILE_SIZE , E_INVALID_MAX_BACKUP_INDEX }
 
- Static Public Attributes inherited from BLOCXX_NAMESPACE::Logger
static const GlobalString STR_NONE_CATEGORY = { "NONE", 0, {0, PTHREAD_MUTEX_INITIALIZER} }
 
static const GlobalString STR_FATAL_CATEGORY = { "FATAL", 0, {0, PTHREAD_MUTEX_INITIALIZER} }
 
static const GlobalString STR_ERROR_CATEGORY = { "ERROR", 0, {0, PTHREAD_MUTEX_INITIALIZER} }
 
static const GlobalString STR_WARNING_CATEGORY = { "WARNING", 0, {0, PTHREAD_MUTEX_INITIALIZER} }
 
static const GlobalString STR_INFO_CATEGORY = { "INFO", 0, {0, PTHREAD_MUTEX_INITIALIZER} }
 
static const GlobalString STR_DEBUG_CATEGORY = { "DEBUG", 0, {0, PTHREAD_MUTEX_INITIALIZER} }
 
static const GlobalString STR_DEBUG2_CATEGORY = { "DEBUG2", 0, {0, PTHREAD_MUTEX_INITIALIZER} }
 
static const GlobalString STR_DEBUG3_CATEGORY = { "DEBUG3", 0, {0, PTHREAD_MUTEX_INITIALIZER} }
 
static const GlobalString STR_ALL_CATEGORY = { "ALL", 0, {0, PTHREAD_MUTEX_INITIALIZER} }
 
static const GlobalString STR_DEFAULT_COMPONENT = { "none", 0, {0, PTHREAD_MUTEX_INITIALIZER} }
 
- Protected Member Functions inherited from BLOCXX_NAMESPACE::IntrusiveCountableBase
 IntrusiveCountableBase ()
 
 IntrusiveCountableBase (const IntrusiveCountableBase &)
 
IntrusiveCountableBaseoperator= (const IntrusiveCountableBase &)
 
virtual ~IntrusiveCountableBase ()
 
- Protected Attributes inherited from BLOCXX_NAMESPACE::Logger
String m_defaultComponent
 
LogAppenderRef m_appender
 
ELogLevel m_logLevel
 

Detailed Description

This implementation of Logger is used to send a Log message to multiple LogAppenders.

Definition at line 53 of file AppenderLogger.hpp.

Constructor & Destructor Documentation

◆ AppenderLogger() [1/4]

BLOCXX_NAMESPACE::AppenderLogger::AppenderLogger ( const String & defaultComponent,
const LogAppenderRef & appender )

Create an AppenderLogger with one LogAppender.

The log level that will be used will be the lowest priority (i.e. debug) found in the given log apppenders.

Parameters
defaultComponentThe default component for logging used when no component was passed to in logMessage().
appenderThe LogAppender messages will be send to.

Definition at line 51 of file AppenderLogger.cpp.

References BLOCXX_NAMESPACE::Logger::Logger().

◆ AppenderLogger() [2/4]

BLOCXX_NAMESPACE::AppenderLogger::AppenderLogger ( const String & defaultComponent,
const Array< LogAppenderRef > & appenders )

Create an AppenderLogger with multiple LogAppenders.

The log level that will be used will be the lowest priority (i.e. debug) found in the given log apppenders.

Parameters
defaultComponentThe default component for logging used when no component was passed to in logMessage().
appendersThe LogAppenders the messages will be routed to.

Definition at line 57 of file AppenderLogger.cpp.

References BLOCXX_NAMESPACE::Logger::Logger().

◆ AppenderLogger() [3/4]

BLOCXX_NAMESPACE::AppenderLogger::AppenderLogger ( const String & defaultComponent,
ELogLevel logLevel,
const LogAppenderRef & appender )

Create an AppenderLogger with one LogAppender.

Parameters
defaultComponentThe default component for logging used when no component was passed to in logMessage().
logLevelThe default log level to use.
appenderThe LogAppender messages will be send to.

Definition at line 63 of file AppenderLogger.cpp.

References BLOCXX_NAMESPACE::Logger::Logger(), and BLOCXX_NAMESPACE::Logger::setLogLevel().

◆ AppenderLogger() [4/4]

BLOCXX_NAMESPACE::AppenderLogger::AppenderLogger ( const String & defaultComponent,
ELogLevel logLevel,
const Array< LogAppenderRef > & appenders )

Create an AppenderLogger with multiple LogAppenders.

Parameters
defaultComponentThe default component for logging used when no component was passed to in logMessage().
logLevelThe default log level to use.
appendersThe LogAppenders the messages will be routed to.

Definition at line 70 of file AppenderLogger.cpp.

References BLOCXX_NAMESPACE::Logger::Logger(), and BLOCXX_NAMESPACE::Logger::setLogLevel().

◆ ~AppenderLogger()

BLOCXX_NAMESPACE::AppenderLogger::~AppenderLogger ( )
virtual

Destroy this AppenderLogger.

Definition at line 77 of file AppenderLogger.cpp.

Member Function Documentation

◆ addLogAppender()

void BLOCXX_NAMESPACE::AppenderLogger::addLogAppender ( const LogAppenderRef & appender)

◆ getLevel()

ELogLevel BLOCXX_NAMESPACE::AppenderLogger::getLevel ( const Array< LogAppenderRef > & appenders)
static

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