log4cxx::AppenderSkeleton Class Reference

Implementation base class for all appenders. More...

#include <appenderskeleton.h>

Inheritance diagram for log4cxx::AppenderSkeleton:

Public Member Functions
	AppenderSkeleton ()
	AppenderSkeleton (const LayoutPtr &layout)
virtual	~AppenderSkeleton ()
void	finalize ()
	Finalize this appender by calling the derived class' close method.
void	activateOptions (helpers::Pool &) override
	Activate the options that were previously set with calls to option setters.
void	setOption (const LogString &option, const LogString &value) override
	Set option to value.
void	addFilter (const spi::FilterPtr newFilter) override
	Add a filter to end of the filter list.
void	clearFilters () override
	Clear the filters chain.
const spi::ErrorHandlerPtr	getErrorHandler () const
	Return the currently set spi::ErrorHandler for this Appender.
spi::FilterPtr	getFilter () const override
	Returns the head Filter.
const spi::FilterPtr	getFirstFilter () const
	Return the first filter in the filter chain for this Appender.
LayoutPtr	getLayout () const override
	Returns the layout of this appender.
LogString	getName () const override
	Returns the name of this Appender.
const LevelPtr	getThreshold () const
	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, helpers::Pool &pool) override
	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) override
	Set the layout for this appender.
void	setName (const LogString &name1) override
	Set the name of this Appender.
void	setThreshold (const LevelPtr &threshold)
	Set the threshold level.
Public Member Functions inherited from log4cxx::Appender
virtual	~Appender ()
virtual void	addFilter (const spi::FilterPtr newFilter)=0
	Add a filter to the end of the filter list.
virtual spi::FilterPtr	getFilter () const =0
	Returns the head Filter.
virtual void	clearFilters ()=0
	Clear the list of filters by removing all the filters in it.
virtual void	close ()=0
	Release any resources allocated within the appender such as file handles, network connections, etc.
virtual void	doAppend (const spi::LoggingEventPtr &event, log4cxx::helpers::Pool &pool)=0
	Log in Appender specific way.
virtual LogString	getName () const =0
	Get the name of this appender.
virtual void	setLayout (const LayoutPtr layout)=0
	Set the Layout for this appender.
virtual LayoutPtr	getLayout () const =0
	Returns this appenders layout.
virtual void	setName (const LogString &name)=0
	Set the name of this appender.
virtual bool	requiresLayout () const =0
	Configurators call this method to determine if the appender requires a layout.
Public Member Functions inherited from log4cxx::spi::OptionHandler
virtual	~OptionHandler ()
virtual void	activateOptions (helpers::Pool &p)=0
	Activate the options that were previously set with calls to option setters.
virtual void	setOption (const LogString &option, const LogString &value)=0
	Set option to value.
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, log4cxx::helpers::Pool &p)=0
	Subclasses of AppenderSkeleton should implement this method to perform actual logging.
void	doAppendImpl (const spi::LoggingEventPtr &event, log4cxx::helpers::Pool &pool)

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/3]

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

protected

AppenderSkeleton() [2/3]

log4cxx::AppenderSkeleton::AppenderSkeleton

(

)

AppenderSkeleton() [3/3]

log4cxx::AppenderSkeleton::AppenderSkeleton

(

const LayoutPtr &

layout

)

~AppenderSkeleton()

virtual log4cxx::AppenderSkeleton::~AppenderSkeleton ( )

virtual

Member Function Documentation

activateOptions()

void log4cxx::AppenderSkeleton::activateOptions ( helpers::Pool &  )

inlineoverridevirtual

Activate the options that were previously set with calls to option setters.

No action is performed in this implementation.

Implements log4cxx::spi::OptionHandler.

Reimplemented in log4cxx::rolling::MultiprocessRollingFileAppender, log4cxx::ConsoleAppender, log4cxx::db::DBAppender, log4cxx::db::ODBCAppender, log4cxx::FileAppender, log4cxx::net::SMTPAppender, log4cxx::net::SocketAppenderSkeleton, log4cxx::net::SyslogAppender, log4cxx::net::TelnetAppender, log4cxx::nt::NTEventLogAppender, log4cxx::rolling::RollingFileAppender, and log4cxx::WriterAppender.

addFilter()

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

overridevirtual

Add a filter to end of the filter list.

Implements log4cxx::Appender.

append()

virtual void log4cxx::AppenderSkeleton::append ( const spi::LoggingEventPtr &  event, log4cxx::helpers::Pool &  p  )

protectedpure virtual

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

See also AppenderSkeleton::doAppend method.

Implemented in log4cxx::db::DBAppender, log4cxx::db::ODBCAppender, log4cxx::AsyncAppender, log4cxx::net::SMTPAppender, log4cxx::net::SyslogAppender, log4cxx::net::TelnetAppender, log4cxx::nt::NTEventLogAppender, log4cxx::nt::OutputDebugStringAppender, log4cxx::WriterAppender, and log4cxx::net::XMLSocketAppender.

clearFilters()

void log4cxx::AppenderSkeleton::clearFilters ( )

overridevirtual

Clear the filters chain.

Implements log4cxx::Appender.

doAppend()

void log4cxx::AppenderSkeleton::doAppend ( const spi::LoggingEventPtr &  event, helpers::Pool &  pool  )

overridevirtual

This method performs threshold checks and invokes filters before delegating actual logging to the subclasses specific AppenderSkeleton::append method.

Implements log4cxx::Appender.

Reimplemented in log4cxx::AsyncAppender.

doAppendImpl()

void log4cxx::AppenderSkeleton::doAppendImpl ( const spi::LoggingEventPtr &  event, log4cxx::helpers::Pool &  pool  )

protected

finalize()

void log4cxx::AppenderSkeleton::finalize

(

)

Finalize this appender by calling the derived class' close method.

getErrorHandler()

const spi::ErrorHandlerPtr log4cxx::AppenderSkeleton::getErrorHandler

(

)

const

Return the currently set spi::ErrorHandler for this Appender.

getFilter()

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

overridevirtual

Returns the head Filter.

Implements log4cxx::Appender.

getFirstFilter()

const spi::FilterPtr log4cxx::AppenderSkeleton::getFirstFilter

(

)

const

Return the first filter in the filter chain for this Appender.

The return value may be nullptr if no is filter is set.

getLayout()

LayoutPtr log4cxx::AppenderSkeleton::getLayout ( ) const

overridevirtual

Returns the layout of this appender.

The value may be nullptr.

Implements log4cxx::Appender.

getName()

LogString log4cxx::AppenderSkeleton::getName ( ) const

overridevirtual

Returns the name of this Appender.

Implements log4cxx::Appender.

getThreshold()

const LevelPtr log4cxx::AppenderSkeleton::getThreshold

(

)

const

Returns this appenders threshold level.

See the setThreshold method for the meaning of this option.

isAsSevereAsThreshold()

bool log4cxx::AppenderSkeleton::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.

setErrorHandler()

void log4cxx::AppenderSkeleton::setErrorHandler

(

const spi::ErrorHandlerPtr

eh

)

Set the ErrorHandler for this Appender.

setLayout()

void log4cxx::AppenderSkeleton::setLayout ( const LayoutPtr  layout1 )

overridevirtual

Set the layout for this appender.

Note that some appenders have their own (fixed) layouts or do not use one.

Implements log4cxx::Appender.

setName()

void log4cxx::AppenderSkeleton::setName ( const LogString &  name1 )

overridevirtual

Set the name of this Appender.

Implements log4cxx::Appender.

setOption()

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

overridevirtual

Set option to value.

Supported options	Supported values	Default value
Threshold	Trace,Debug,Info,Warn,Error,Fatal,Off,All	All

Implements log4cxx::spi::OptionHandler.

Reimplemented in log4cxx::AsyncAppender, log4cxx::ConsoleAppender, log4cxx::db::DBAppender, log4cxx::db::ODBCAppender, log4cxx::FileAppender, log4cxx::net::SMTPAppender, log4cxx::net::SocketAppenderSkeleton, log4cxx::net::SyslogAppender, log4cxx::net::TelnetAppender, log4cxx::nt::NTEventLogAppender, log4cxx::rolling::RollingFileAppender, and log4cxx::WriterAppender.

setThreshold()

void log4cxx::AppenderSkeleton::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.

---

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

• appenderskeleton.h