DCMTK
Version 3.6.3
OFFIS DICOM Toolkit
|
Extend this class for implementing your own strategies for printing log statements. More...
Public Member Functions | |
virtual void | close ()=0 |
Release any resources allocated within the appender such as file handles, network connections, etc. More... | |
void | doAppend (const log4cplus::spi::InternalLoggingEvent &event) |
This method performs threshold checks and invokes filters before delegating actual logging to the subclasses specific append method. | |
virtual log4cplus::tstring | getName () |
Get the name of this appender. More... | |
virtual void | setName (const log4cplus::tstring &name) |
Set the name of this appender. More... | |
virtual void | setErrorHandler (OFunique_ptr< ErrorHandler > eh) |
Set the ErrorHandler for this Appender. | |
virtual ErrorHandler * | getErrorHandler () |
Return the currently set ErrorHandler for this Appender. | |
virtual void | setLayout (OFunique_ptr< Layout > layout) |
Set the layout for this appender. More... | |
virtual Layout * | getLayout () |
Returns the layout of this appender. More... | |
void | setFilter (log4cplus::spi::FilterPtr f) |
Set the filter chain on this Appender. | |
log4cplus::spi::FilterPtr | getFilter () const |
Get the filter chain on this Appender. | |
LogLevel | getThreshold () const |
Returns this appenders threshold LogLevel. More... | |
void | setThreshold (LogLevel th) |
Set the threshold LogLevel. More... | |
bool | isAsSevereAsThreshold (LogLevel ll) const |
Check whether the message LogLevel is below the appender's threshold. More... | |
Protected Member Functions | |
virtual void | append (const log4cplus::spi::InternalLoggingEvent &event)=0 |
Subclasses of Appender should implement this method to perform actual logging. More... | |
Protected Attributes | |
OFunique_ptr< Layout > | layout |
The layout variable does not need to be set if the appender implementation has its own layout. More... | |
log4cplus::tstring | name |
Appenders are named. More... | |
LogLevel | threshold |
There is no LogLevel threshold filtering by default. More... | |
log4cplus::spi::FilterPtr | filter |
The first filter in the filter chain. More... | |
OFunique_ptr< ErrorHandler > | errorHandler |
It is assumed and enforced that errorHandler is never null. More... | |
OFunique_ptr< helpers::LockFile > | lockFile |
Optional system wide synchronization lock. | |
bool | useLockFile |
Use lock file for inter-process synchronization of access to log file. More... | |
bool | closed |
Is this appender closed? | |
Extend this class for implementing your own strategies for printing log statements.
UseLockFile
true
if you want your output through this appender to be synchronized between multiple processes. When this property is set to true then log4cplus uses OS specific facilities (e.g., lockf()
) to provide inter-process locking. With the exception of FileAppender and its derived classes, it is also necessary to provide path to a lock file using the LockFile
property. LockFile
UseLockFile
is set to true. Then it is mandatory.
|
protectedpure virtual |
|
pure virtual |
Release any resources allocated within the appender such as file handles, network connections, etc.
It is a programming error to append to a closed appender.
|
virtual |
Returns the layout of this appender.
The value may be NULL.
This class owns the returned pointer.
|
virtual |
Get the name of this appender.
The name uniquely identifies the appender.
|
inline |
Returns this appenders threshold LogLevel.
See the setThreshold method for the meaning of this option.
|
inline |
Check whether the message LogLevel is below the appender's threshold.
If there is no threshold set, then the return value is always true
.
References dcmtk::log4cplus::NOT_SET_LOG_LEVEL.
|
virtual |
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.
|
virtual |
Set the name of this appender.
The name is used by other components to identify this appender.
|
inline |
Set the threshold LogLevel.
All log events with lower LogLevel than the threshold LogLevel are ignored by the appender.
In configuration files this option is specified by setting the value of the Threshold option to a LogLevel string, such as "DEBUG", "INFO" and so on.
|
protected |
It is assumed and enforced that errorHandler is never null.
|
protected |
The first filter in the filter chain.
Set to null
initially.
|
protected |
The layout variable does not need to be set if the appender implementation has its own layout.
|
protected |
Appenders are named.
|
protected |
There is no LogLevel threshold filtering by default.
|
protected |
Use lock file for inter-process synchronization of access to log file.