Implementation base class for all appenders.
More...
Inherits Appender, and ObjectImpl.
Inherited by AsyncAppender [virtual]
, ODBCAppender, SMTPAppender, SocketAppenderSkeleton, SocketHubAppender, SyslogAppender, TelnetAppender, NTEventLogAppender, OutputDebugStringAppender, and WriterAppender.
Implementation base class for all appenders.
This class provides the code for common functionality, such as support for threshold filtering and support for general filters.
§ AppenderSkeleton() [1/2]
§ AppenderSkeleton() [2/2]
§ activateOptions()
Derived appenders should override this method if option structure requires it.
Implements OptionHandler.
Reimplemented in DailyRollingFileAppender, ODBCAppender, FileAppender, SocketHubAppender, RollingFileAppender, SMTPAppender, TelnetAppender, WriterAppender, SyslogAppender, SocketAppenderSkeleton, RollingFileAppenderSkeleton, ConsoleAppender, and NTEventLogAppender.
§ addFilter()
Add a filter to end of the filter list.
Implements Appender.
§ addRef()
§ append()
Subclasses of AppenderSkeleton
should implement this method to perform actual logging.
See also AppenderSkeleton::doAppend method.
Implemented in ODBCAppender, SocketHubAppender, XMLSocketAppender, SocketAppender, WriterAppender, TelnetAppender, SMTPAppender, AsyncAppender, NTEventLogAppender, SyslogAppender, and OutputDebugStringAppender.
§ clearFilters()
Clear the filters chain.
Implements Appender.
§ doAppend()
This method performs threshold checks and invokes filters before delegating actual logging to the subclasses specific AppenderSkeleton::append method.
Implements Appender.
§ finalize()
Finalize this appender by calling the derived class' close
method.
§ getErrorHandler()
§ getFilter()
Returns the head Filter.
Implements Appender.
§ getFirstFilter()
Return the first filter in the filter chain for this Appender.
The return value may be 0
if no is filter is set.
§ getLayout()
Returns the layout of this appender.
The value may be 0.
Implements Appender.
§ getName()
§ getThreshold()
Returns this appenders threshold level.
See the setThreshold method for the meaning of this option.
§ isAsSevereAsThreshold()
bool isAsSevereAsThreshold |
( |
const LevelPtr & |
level | ) |
const |
Check whether the message level is below the appender's threshold.
If there is no threshold set, then the return value is always true
.
§ releaseRef()
void releaseRef |
( |
| ) |
const |
|
virtual |
§ setErrorHandler()
§ setLayout()
Set the layout for this appender.
Note that some appenders have their own (fixed) layouts or do not use one. For example, the SocketAppender ignores the layout set here.
Implements Appender.
§ setName()
§ setOption()
Set option
to value
.
The handling of each option depends on the OptionHandler instance. Some options may become active immediately whereas other may be activated only when activateOptions is called.
Implements OptionHandler.
Reimplemented in DailyRollingFileAppender, AsyncAppender, WriterAppender, ODBCAppender, FileAppender, SocketAppenderSkeleton, SocketHubAppender, TelnetAppender, RollingFileAppender, SMTPAppender, SyslogAppender, ConsoleAppender, and NTEventLogAppender.
§ setThreshold()
void setThreshold |
( |
const LevelPtr & |
threshold | ) |
|
Set the threshold level.
All log events with lower level than the threshold level are ignored by the appender.
In configuration files this option is specified by setting the value of the Threshold option to a level string, such as "DEBUG", "INFO" and so on.
§ closed
§ errorHandler
It is assumed and enforced that errorHandler is never null.
§ headFilter
The first filter in the filter chain.
Set to null
initially.
§ layout
The layout variable does not need to be set if the appender implementation has its own layout.
§ mutex
§ name
§ pool
§ tailFilter
The last filter in the filter chain.
§ threshold
There is no level threshold filtering by default.
The documentation for this class was generated from the following file: