log4cplus_spi_RootLogger(3)

log4cplus::spi::RootLogger(3) log4cplus log4cplus::spi::RootLogger(3)

NAME

log4cplus::spi::RootLogger - RootLogger sits at the top of the logger hierachy.

SYNOPSIS

#include <rootlogger.h>

Inherits log4cplus::spi::LoggerImpl.

Public Member Functions


RootLogger (Hierarchy &h, LogLevel ll)
The root logger names itself as 'root'. virtual LogLevel getChainedLogLevel () const
Return the assigned LogLevel value without walking the logger hierarchy. void setLogLevel (LogLevel)
Setting a NOT_SET_LOG_LEVEL value to the LogLevel of the root logger may have catastrophic results.

Public Member Functions inherited from log4cplus::spi::LoggerImpl
virtual void callAppenders (const InternalLoggingEvent &event)
Call the appenders in the hierrachy starting at this. virtual void closeNestedAppenders ()
Close all attached appenders implementing the AppenderAttachable interface. virtual bool isEnabledFor (LogLevel ll) const
Check whether this logger is enabled for a given LogLevel passed as parameter. virtual void log (LogLevel ll, const log4cplus::tstring &message, const char *file=nullptr, int line=-1, const char *function=nullptr)
This generic form is intended to be used by wrappers. virtual void log (spi::InternalLoggingEvent const &)
LogLevel getLogLevel () const
Returns the assigned LogLevel, if any, for this Logger. void setLogLevel (LogLevel _ll)
Set the LogLevel of this Logger. virtual Hierarchy & getHierarchy () const
Return the the Hierarchy where this Logger instance is attached. log4cplus::tstring const & getName () const
Return the logger name. bool getAdditivity () const
Get the additivity flag for this Logger instance. void setAdditivity (bool additive)
Set the additivity flag for this Logger instance. virtual ~LoggerImpl ()

Public Member Functions inherited from log4cplus::helpers::SharedObject
void addReference () const LOG4CPLUS_NOEXCEPT
void removeReference () const

Public Member Functions inherited from log4cplus::helpers::AppenderAttachableImpl
AppenderAttachableImpl ()
virtual ~AppenderAttachableImpl ()
virtual void addAppender (SharedAppenderPtr newAppender)
Add an appender. virtual SharedAppenderPtrList getAllAppenders ()
Get all previously added appenders as an vectory. virtual SharedAppenderPtr getAppender (const log4cplus::tstring &name)
Look for an attached appender named as name. virtual void removeAllAppenders ()
Remove all previously added appenders. virtual void removeAppender (SharedAppenderPtr appender)
Remove the appender passed as parameter from the list of appenders. virtual void removeAppender (const log4cplus::tstring &name)
Remove the appender with the name passed as parameter from the list of appenders. int appendLoopOnAppenders (const spi::InternalLoggingEvent &event) const
Call the doAppend method on all attached appenders.

Public Member Functions inherited from log4cplus::spi::AppenderAttachable
virtual ~AppenderAttachable ()=0

Additional Inherited Members

Public Types inherited from log4cplus::spi::LoggerImpl
typedef helpers::SharedObjectPtr< LoggerImpl > SharedLoggerImplPtr

Public Attributes inherited from log4cplus::helpers::SharedObject
thread::Mutex access_mutex

Public Attributes inherited from log4cplus::helpers::AppenderAttachableImpl
thread::Mutex appender_list_mutex

Protected Types inherited from log4cplus::helpers::AppenderAttachableImpl
typedef std::vector< SharedAppenderPtr > ListType

Protected Member Functions inherited from log4cplus::spi::LoggerImpl
LoggerImpl (const log4cplus::tstring &name, Hierarchy &h)
This constructor created a new Logger instance and sets its name. virtual void forcedLog (LogLevel ll, const log4cplus::tstring &message, const char *file, int line, const char *function)
This method creates a new logging event and logs the event without further checks. virtual void forcedLog (spi::InternalLoggingEvent const &ev)

Protected Member Functions inherited from log4cplus::helpers::SharedObject
SharedObject ()
SharedObject (const SharedObject &)
SharedObject (SharedObject &&)
virtual ~SharedObject ()
SharedObject & operator= (const SharedObject &) LOG4CPLUS_NOEXCEPT
SharedObject & operator= (SharedObject &&) LOG4CPLUS_NOEXCEPT

Protected Attributes inherited from log4cplus::spi::LoggerImpl
log4cplus::tstring name
The name of this logger. LogLevel ll
The assigned LogLevel of this logger. SharedLoggerImplPtr parent
The parent of this logger. bool additive
Additivity is set to true by default, that is children inherit the appenders of their ancestors by default.

Protected Attributes inherited from log4cplus::helpers::AppenderAttachableImpl
ListType appenderList
Array of appenders.

Detailed Description

RootLogger sits at the top of the logger hierachy.

It is a regular logger except that it provides several guarantees.

First, it cannot be assigned a NOT_SET_LOG_LEVEL LogLevel. Second, since root logger cannot have a parent, the getChainedLogLevel method always returns the value of the ll field without walking the hierarchy.

Definition at line 47 of file rootlogger.h.

Constructor & Destructor Documentation

log4cplus::spi::RootLogger::RootLogger (Hierarchy & h, LogLevel ll)

The root logger names itself as 'root'. However, the root logger cannot be retrieved by name.

Member Function Documentation

virtual LogLevel log4cplus::spi::RootLogger::getChainedLogLevel () const [virtual]

Return the assigned LogLevel value without walking the logger hierarchy.

Reimplemented from log4cplus::spi::LoggerImpl.

void log4cplus::spi::RootLogger::setLogLevel (LogLevel)

Setting a NOT_SET_LOG_LEVEL value to the LogLevel of the root logger may have catastrophic results. We prevent this here.

Author

Generated automatically by Doxygen for log4cplus from the source code.

Mon Jun 5 2023 21:46:10 Version 2.0.7