Inherited by AsyncAppender [virtual]
, ODBCAppender, SMTPAppender, SocketAppenderSkeleton, SocketHubAppender, SyslogAppender, TelnetAppender, NTEventLogAppender, OutputDebugStringAppender, and WriterAppender.
This class provides the code for common functionality, such as support for threshold filtering and support for general filters.
Public Member Functions | |
AppenderSkeleton () | |
AppenderSkeleton (const LayoutPtr &layout) | |
void | addRef () const |
void | releaseRef () const |
void | finalize () |
Finalize this appender by calling the derived class' close method. | |
virtual void | activateOptions (log4cxx::helpers::Pool &) |
Derived appenders should override this method if option structure requires it. | |
virtual void | setOption (const LogString &option, const LogString &value) |
Set option to value . | |
void | addFilter (const spi::FilterPtr &newFilter) |
Add a filter to end of the filter list. | |
void | clearFilters () |
Clear the filters chain. | |
const spi::ErrorHandlerPtr & | getErrorHandler () const |
Return the currently set spi::ErrorHandler for this Appender. | |
spi::FilterPtr | getFilter () const |
Returns the head Filter. | |
const spi::FilterPtr & | getFirstFilter () const |
Return the first filter in the filter chain for this Appender. | |
LayoutPtr | getLayout () const |
Returns the layout of this appender. | |
LogString | getName () const |
Returns the name of this Appender. | |
const LevelPtr & | getThreshold () |
Returns this appenders threshold level. | |
bool | isAsSevereAsThreshold (const LevelPtr &level) const |
Check whether the message level is below the appender's threshold. | |
void | doAppend (const spi::LoggingEventPtr &event, log4cxx::helpers::Pool &pool) |
This method performs threshold checks and invokes filters before delegating actual logging to the subclasses specific AppenderSkeleton::append method. | |
void | setErrorHandler (const spi::ErrorHandlerPtr &eh) |
Set the ErrorHandler for this Appender. | |
void | setLayout (const LayoutPtr &layout1) |
Set the layout for this appender. | |
void | setName (const LogString &name1) |
Set the name of this Appender. | |
void | setThreshold (const LevelPtr &threshold) |
Set the threshold level. | |
Protected Member Functions | |
virtual void | append (const spi::LoggingEventPtr &event, log4cxx::helpers::Pool &p)=0 |
Subclasses of AppenderSkeleton should implement this method to perform actual logging. | |
Protected Attributes | |
LayoutPtr | layout |
The layout variable does not need to be set if the appender implementation has its own layout. | |
LogString | name |
Appenders are named. | |
LevelPtr | threshold |
There is no level threshold filtering by default. | |
spi::ErrorHandlerPtr | errorHandler |
It is assumed and enforced that errorHandler is never null. | |
spi::FilterPtr | headFilter |
The first filter in the filter chain. | |
spi::FilterPtr | tailFilter |
The last filter in the filter chain. | |
bool | closed |
Is this appender closed? | |
log4cxx::helpers::Pool | pool |
log4cxx::helpers::Mutex | mutex |
|
|
|
|
|
Derived appenders should override this method if option structure requires it.
Implements OptionHandler. Reimplemented in ConsoleAppender, DailyRollingFileAppender, ODBCAppender, FileAppender, SMTPAppender, SocketAppenderSkeleton, SocketHubAppender, SyslogAppender, TelnetAppender, NTEventLogAppender, RollingFileAppenderSkeleton, RollingFileAppender, and WriterAppender. |
|
Add a filter to end of the filter list.
Implements Appender. |
|
Reimplemented from ObjectImpl. Reimplemented in AsyncAppender. |
|
Subclasses of See also AppenderSkeleton::doAppend method. Implemented in AsyncAppender, ODBCAppender, SMTPAppender, SocketAppender, SocketHubAppender, SyslogAppender, TelnetAppender, XMLSocketAppender, NTEventLogAppender, OutputDebugStringAppender, and WriterAppender. |
|
Clear the filters chain.
Implements Appender. |
|
This method performs threshold checks and invokes filters before delegating actual logging to the subclasses specific AppenderSkeleton::append method.
Implements Appender. |
|
Finalize this appender by calling the derived class'
|
|
Return the currently set spi::ErrorHandler for this Appender.
|
|
Returns the head Filter.
Implements Appender. |
|
Return the first filter in the filter chain for this Appender.
The return value may be |
|
Returns the layout of this appender. The value may be 0. Implements Appender. |
|
Returns the name of this Appender.
Implements Appender. |
|
Returns this appenders threshold level. See the setThreshold method for the meaning of this option. |
|
Check whether the message level is below the appender's threshold.
If there is no threshold set, then the return value is always |
|
Reimplemented from ObjectImpl. Reimplemented in AsyncAppender. |
|
Set the ErrorHandler for this Appender.
|
|
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. |
|
Set the name of this Appender.
Implements Appender. |
|
Set 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 AsyncAppender, ConsoleAppender, DailyRollingFileAppender, ODBCAppender, FileAppender, SMTPAppender, SocketAppenderSkeleton, SocketHubAppender, SyslogAppender, TelnetAppender, NTEventLogAppender, RollingFileAppender, and WriterAppender. |
|
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. |
|
Is this appender closed?
|
|
It is assumed and enforced that errorHandler is never null.
|
|
The first filter in the filter chain.
Set to |
|
The layout variable does not need to be set if the appender implementation has its own layout.
|
|
|
|
Appenders are named.
|
|
|
|
The last filter in the filter chain.
|
|
There is no level threshold filtering by default.
|