log4cxx::Appender Class Reference

Implement this interface for your own strategies for outputting log statements. More...

#include <appender.h>

Inheritance diagram for log4cxx::Appender:

Public Member Functions
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

Detailed Description

Implement this interface for your own strategies for outputting log statements.

Constructor & Destructor Documentation

~Appender()

virtual log4cxx::Appender::~Appender ( )

inlinevirtual

Member Function Documentation

addFilter()

virtual void log4cxx::Appender::addFilter ( const spi::FilterPtr  newFilter )

pure virtual

Add a filter to the end of the filter list.

Implemented in log4cxx::AppenderSkeleton.

clearFilters()

virtual void log4cxx::Appender::clearFilters ( )

pure virtual

Clear the list of filters by removing all the filters in it.

Implemented in log4cxx::AppenderSkeleton.

close()

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

Implemented in log4cxx::AsyncAppender, log4cxx::db::DBAppender, log4cxx::db::ODBCAppender, log4cxx::net::SMTPAppender, log4cxx::net::SocketAppenderSkeleton, log4cxx::net::SyslogAppender, log4cxx::net::TelnetAppender, log4cxx::nt::NTEventLogAppender, log4cxx::nt::OutputDebugStringAppender, log4cxx::rolling::MultiprocessRollingFileAppender, log4cxx::rolling::RollingFileAppender, and log4cxx::WriterAppender.

doAppend()

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

pure virtual

Log in Appender specific way.

When appropriate, Loggers will call the doAppend method of appender implementations in order to log.

Implemented in log4cxx::AppenderSkeleton, and log4cxx::AsyncAppender.

getFilter()

virtual spi::FilterPtr log4cxx::Appender::getFilter ( ) const

pure virtual

Returns the head Filter.

The Filters are organized in a linked list and so all Filters on this Appender are available through the result.

Returns

the head Filter or null, if no Filters are present

Implemented in log4cxx::AppenderSkeleton.

getLayout()

virtual LayoutPtr log4cxx::Appender::getLayout ( ) const

pure virtual

Returns this appenders layout.

Implemented in log4cxx::AppenderSkeleton.

getName()

virtual LogString log4cxx::Appender::getName ( ) const

pure virtual

Get the name of this appender.

The name uniquely identifies the appender.

Implemented in log4cxx::AppenderSkeleton.

requiresLayout()

virtual bool log4cxx::Appender::requiresLayout ( ) const

pure virtual

Configurators call this method to determine if the appender requires a layout.

If this method returns true, meaning that layout is required, then the configurator will configure an layout using the configuration information at its disposal. If this method returns false, meaning that a layout is not required, then layout configuration will be skipped even if there is available layout configuration information at the disposal of the configurator..

In the rather exceptional case, where the appender implementation admits a layout but can also work without it, then the appender should return true.

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

setLayout()

virtual void log4cxx::Appender::setLayout ( const LayoutPtr  layout )

pure virtual

Set the Layout for this appender.

Implemented in log4cxx::AppenderSkeleton.

setName()

virtual void log4cxx::Appender::setName ( const LogString &  name )

pure virtual

Set the name of this appender.

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

Implemented in log4cxx::AppenderSkeleton.

---

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

• appender.h