OFFIS DCMTK  Version 3.6.0
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
log4cplus::Appender Class Referenceabstract

Extend this class for implementing your own strategies for printing log statements. More...

Inheritance diagram for log4cplus::Appender:
[legend]
Collaboration diagram for log4cplus::Appender:
[legend]

Public Member Functions

 Appender (const log4cplus::helpers::Properties properties)
 
void destructorImpl ()
 
virtual void close ()=0
 Release any resources allocated within the appender such as file handles, network connections, etc.
 
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.
 
virtual void setName (const log4cplus::tstring &name)
 Set the name of this appender.
 
virtual void setErrorHandler (OFauto_ptr< ErrorHandler > eh)
 Set the ErrorHandler for this Appender.
 
virtual ErrorHandlergetErrorHandler ()
 Return the currently set ErrorHandler for this Appender.
 
virtual void setLayout (OFauto_ptr< Layout > layout)
 Set the layout for this appender.
 
virtual LayoutgetLayout ()
 Returns the layout of this appender.
 
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.
 
void setThreshold (LogLevel th)
 Set the threshold LogLevel.
 
bool isAsSevereAsThreshold (LogLevel ll) const
 Check whether the message LogLevel is below the appender's threshold.
 
- Public Member Functions inherited from log4cplus::helpers::SharedObject
void addReference () const
 
void removeReference () const
 

Protected Member Functions

virtual void append (const log4cplus::spi::InternalLoggingEvent &event)=0
 Subclasses of Appender should implement this method to perform actual logging.
 
- Protected Member Functions inherited from log4cplus::helpers::SharedObject
 SharedObject (const SharedObject &)
 
SharedObjectoperator= (const SharedObject &)
 
- Protected Member Functions inherited from log4cplus::helpers::LogLogUser
 LogLogUser (const LogLogUser &)
 
LogLoggetLogLog () const
 
LogLogUseroperator= (const LogLogUser &rhs)
 

Protected Attributes

OFauto_ptr< Layoutlayout
 The layout variable does not need to be set if the appender implementation has its own layout.
 
log4cplus::tstring name
 Appenders are named.
 
LogLevel threshold
 There is no LogLevel threshold filtering by default.
 
log4cplus::spi::FilterPtr filter
 The first filter in the filter chain.
 
OFauto_ptr< ErrorHandlererrorHandler
 It is assumed and enforced that errorHandler is never null.
 
bool closed
 Is this appender closed?
 

Additional Inherited Members

- Public Attributes inherited from log4cplus::helpers::SharedObject
LOG4CPLUS_MUTEX_PTR_DECLARE access_mutex
 

Detailed Description

Extend this class for implementing your own strategies for printing log statements.

Definition at line 73 of file appender.h.

Member Function Documentation

virtual void log4cplus::Appender::append ( const log4cplus::spi::InternalLoggingEvent event)
protectedpure virtual

Subclasses of Appender should implement this method to perform actual logging.

See Also
doAppend method.
virtual void log4cplus::Appender::close ( )
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 Layout* log4cplus::Appender::getLayout ( )
virtual

Returns the layout of this appender.

The value may be NULL.

This class owns the returned pointer.

virtual log4cplus::tstring log4cplus::Appender::getName ( )
virtual

Get the name of this appender.

The name uniquely identifies the appender.

LogLevel log4cplus::Appender::getThreshold ( ) const
inline

Returns this appenders threshold LogLevel.

See the setThreshold method for the meaning of this option.

Definition at line 155 of file appender.h.

bool log4cplus::Appender::isAsSevereAsThreshold ( LogLevel  ll) const
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.

Definition at line 172 of file appender.h.

virtual void log4cplus::Appender::setLayout ( OFauto_ptr< Layout layout)
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 void log4cplus::Appender::setName ( const log4cplus::tstring name)
virtual

Set the name of this appender.

The name is used by other components to identify this appender.

void log4cplus::Appender::setThreshold ( LogLevel  th)
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.

Definition at line 165 of file appender.h.

Member Data Documentation

OFauto_ptr<ErrorHandler> log4cplus::Appender::errorHandler
protected

It is assumed and enforced that errorHandler is never null.

Definition at line 201 of file appender.h.

log4cplus::spi::FilterPtr log4cplus::Appender::filter
protected

The first filter in the filter chain.

Set to null initially.

Definition at line 198 of file appender.h.

OFauto_ptr<Layout> log4cplus::Appender::layout
protected

The layout variable does not need to be set if the appender implementation has its own layout.

Definition at line 188 of file appender.h.

log4cplus::tstring log4cplus::Appender::name
protected

Appenders are named.

Definition at line 191 of file appender.h.

LogLevel log4cplus::Appender::threshold
protected

There is no LogLevel threshold filtering by default.

Definition at line 194 of file appender.h.


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


Generated on Thu Dec 20 2012 for OFFIS DCMTK Version 3.6.0 by Doxygen 1.8.2