Apache Log4cxx  Version 2.0.0
Loading...
Searching...
No Matches
log4cxx::AppenderSkeleton Class Referenceabstract

Implementation base class for all appenders. More...

#include <appenderskeleton.h>

Inheritance diagram for log4cxx::AppenderSkeleton:
log4cxx::Appender log4cxx::spi::OptionHandler log4cxx::helpers::Object log4cxx::AsyncAppender log4cxx::WriterAppender log4cxx::db::DBAppender log4cxx::db::ODBCAppender log4cxx::net::SMTPAppender log4cxx::net::SocketAppenderSkeleton log4cxx::net::SyslogAppender log4cxx::net::TelnetAppender log4cxx::nt::NTEventLogAppender log4cxx::nt::OutputDebugStringAppender

Public Member Functions

 AppenderSkeleton (const LayoutPtr &layout={})
virtual ~AppenderSkeleton ()
void activateOptions () override
 Activate the options that were previously set with calls to option setters.
void setOption (const LogString &option, const LogString &value) override
 Override this method to set option to value.
void addFilter (const spi::FilterPtr &newFilter) override
 Add newFilter to end of the spi::Filter chain.
void clearFilters () override
 Clear the spi::Filter chain.
void close () override
 Release any resources allocated within the appender such as file handles, network connections, etc.
const spi::ErrorHandlerPtr getErrorHandler () const
 The currently set spi::ErrorHandler for this Appender.
spi::FilterPtr getFilter () const override
 The first spi::Filter in the filter chain for this Appender.
const spi::FilterPtr getFirstFilter () const
 The first spi::Filter in the filter chain for this Appender.
LayoutPtr getLayout () const override
 The currently set Layout for this appender.
LogString getName () const override
 The name of this Appender.
const LevelPtr getThreshold () const
 This appender's current threshold level.
bool isAsSevereAsThreshold (const LevelPtr &level) const
 Is level greater than or equal to this appender's threshold?
void doAppend (const spi::LoggingEventPtr &event) override
 Call doAppendImpl after acquiring a lock that prevents other threads from concurrently executing doAppendImpl.
void setErrorHandler (const spi::ErrorHandlerPtr &newValue)
 Use newValue as the spi::ErrorHandler for this Appender.
void setLayout (const LayoutPtr &newValue) override
 Use newValue as the layout for this appender.
void setName (const LogString &newValue) override
 Use newValue for the name of this Appender.
void setThreshold (const LevelPtr &newValue)
 Use newValue as this appender's threshold level.
void activateOptions (helpers::Pool &)
Public Member Functions inherited from log4cxx::Appender
virtual ~Appender ()
void doAppend (const spi::LoggingEventPtr &event, helpers::Pool &pool)
virtual bool requiresLayout () const
Public Member Functions inherited from log4cxx::spi::OptionHandler
virtual ~OptionHandler ()
void activateOptions (helpers::Pool &)
Public Member Functions inherited from log4cxx::helpers::Object
virtual ~Object ()
virtual const helpers::Class & getClass () const =0
virtual bool instanceof (const Class &clazz) const =0
virtual const void * cast (const Class &clazz) const =0

Protected Member Functions

 AppenderSkeleton (LOG4CXX_PRIVATE_PTR(AppenderSkeletonPrivate) priv)
virtual void append (const spi::LoggingEventPtr &event)=0
 Subclasses of AppenderSkeleton must implement this method to perform actual logging.
void doAppendImpl (const spi::LoggingEventPtr &event)
 Call the AppenderSkeleton::append method if the level of event is not lower than this appender's threshold and no attached spi::Filter indicates event is rejected.
bool isAccepted (const spi::LoggingEventPtr &event) const
 Does no attached filter deny event or does an attached filter accept event?

Detailed Description

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.

Examples
custom-appender.cpp.

Constructor & Destructor Documentation

◆ AppenderSkeleton() [1/2]

log4cxx::AppenderSkeleton::AppenderSkeleton ( LOG4CXX_PRIVATE_PTR(AppenderSkeletonPrivate) priv)
protected

◆ AppenderSkeleton() [2/2]

log4cxx::AppenderSkeleton::AppenderSkeleton ( const LayoutPtr & layout = {})

◆ ~AppenderSkeleton()

virtual log4cxx::AppenderSkeleton::~AppenderSkeleton ( )
virtual

Member Function Documentation

◆ activateOptions() [1/2]

void log4cxx::AppenderSkeleton::activateOptions ( )
overridevirtual

◆ activateOptions() [2/2]

Deprecated
This function is deprecated and will be removed in a future version.
Deprecated
Use activateOptions() without parameters instead

◆ addFilter()

void log4cxx::AppenderSkeleton::addFilter ( const spi::FilterPtr & newFilter)
overridevirtual

Add newFilter to end of the spi::Filter chain.

Implements log4cxx::Appender.

◆ append()

◆ clearFilters()

void log4cxx::AppenderSkeleton::clearFilters ( )
overridevirtual

Clear the spi::Filter chain.

Implements log4cxx::Appender.

◆ close()

void log4cxx::AppenderSkeleton::close ( )
overridevirtual

Release any resources allocated within the appender such as file handles, network connections, etc.

Calling doAppend() on a closed appender generates one warning on stderr.

Implements log4cxx::Appender.

◆ doAppend()

void log4cxx::AppenderSkeleton::doAppend ( const spi::LoggingEventPtr & event)
overridevirtual

Call doAppendImpl after acquiring a lock that prevents other threads from concurrently executing doAppendImpl.

Reimplement this method in your appender if you use a different concurrency control technique.

Implements log4cxx::Appender.

Reimplemented in log4cxx::AsyncAppender.

◆ doAppendImpl()

void log4cxx::AppenderSkeleton::doAppendImpl ( const spi::LoggingEventPtr & event)
protected

Call the AppenderSkeleton::append method if the level of event is not lower than this appender's threshold and no attached spi::Filter indicates event is rejected.

◆ getErrorHandler()

const spi::ErrorHandlerPtr log4cxx::AppenderSkeleton::getErrorHandler ( ) const

The currently set spi::ErrorHandler for this Appender.

◆ getFilter()

spi::FilterPtr log4cxx::AppenderSkeleton::getFilter ( ) const
overridevirtual

The first spi::Filter in the filter chain for this Appender.

Implements log4cxx::Appender.

◆ getFirstFilter()

const spi::FilterPtr log4cxx::AppenderSkeleton::getFirstFilter ( ) const

The first spi::Filter in the filter chain for this Appender.

◆ getLayout()

LayoutPtr log4cxx::AppenderSkeleton::getLayout ( ) const
overridevirtual

The currently set Layout for this appender.

Implements log4cxx::Appender.

◆ getName()

LogString log4cxx::AppenderSkeleton::getName ( ) const
overridevirtual

The name of this Appender.

Implements log4cxx::Appender.

◆ getThreshold()

const LevelPtr log4cxx::AppenderSkeleton::getThreshold ( ) const

This appender's current threshold level.

See the setThreshold method for the meaning of this option.

◆ isAccepted()

bool log4cxx::AppenderSkeleton::isAccepted ( const spi::LoggingEventPtr & event) const
protected

Does no attached filter deny event or does an attached filter accept event?

◆ isAsSevereAsThreshold()

bool log4cxx::AppenderSkeleton::isAsSevereAsThreshold ( const LevelPtr & level) const

Is level greater than or equal to this appender's threshold?

◆ setErrorHandler()

void log4cxx::AppenderSkeleton::setErrorHandler ( const spi::ErrorHandlerPtr & newValue)

Use newValue as the spi::ErrorHandler for this Appender.

◆ setLayout()

void log4cxx::AppenderSkeleton::setLayout ( const LayoutPtr & newValue)
overridevirtual

Use newValue as the layout for this appender.

Note that some appenders have their own (fixed) layouts sor do not need one.

Implements log4cxx::Appender.

◆ setName()

void log4cxx::AppenderSkeleton::setName ( const LogString & newValue)
overridevirtual

Use newValue for the name of this Appender.

Implements log4cxx::Appender.

◆ setOption()

void log4cxx::AppenderSkeleton::setOption ( const LogString & option,
const LogString & value )
overridevirtual

◆ setThreshold()

void log4cxx::AppenderSkeleton::setThreshold ( const LevelPtr & newValue)

Use newValue as this appender's threshold level.

All log events with lower level than the appender's 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.

The default level is "ALL", the lowest possible level, meaning no event is blocked by this threshold.


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