ConsoleAppender appends log events to stdout or stderr using a layout specified by the user. More...

#include <consoleappender.h>

Inheritance diagram for log4cxx::ConsoleAppender:

Public Member Functions
	ConsoleAppender ()

	ConsoleAppender (const LayoutPtr &layout)

	ConsoleAppender (const LayoutPtr &layout, const LogString &target)

	~ConsoleAppender ()

void	setTarget (const LogString &value)
	Sets the value of the target property. More...

LogString	getTarget () const
	Returns the current value of the target property. More...

void	activateOptions (log4cxx::helpers::Pool &p)
	Derived appenders should override this method if option structure requires it. More...

void	setOption (const LogString &option, const LogString &value)
	Set `option` to `value`. More...

Public Member Functions inherited from log4cxx::WriterAppender
	WriterAppender ()
	This default constructor does nothing. More...

	~WriterAppender ()

virtual void	activateOptions (log4cxx::helpers::Pool &pool)
	Derived appenders should override this method if option structure requires it. More...

void	setImmediateFlush (bool value)
	If the ImmediateFlush option is set to `true`, the appender will flush at the end of each write. More...

bool	getImmediateFlush () const
	Returns value of the ImmediateFlush option. More...

virtual void	append (const spi::LoggingEventPtr &event, log4cxx::helpers::Pool &p)
	This method is called by the AppenderSkeleton::doAppend method. More...

virtual void	close ()
	Close this appender instance. More...

LogString	getEncoding () const

void	setEncoding (const LogString &value)

void	setOption (const LogString &option, const LogString &value)
	Set `option` to `value`. More...

void	setWriter (const log4cxx::helpers::WriterPtr &writer)

virtual bool	requiresLayout () const
	Configurators call this method to determine if the appender requires a layout. More...

Public Member Functions inherited from log4cxx::AppenderSkeleton
	AppenderSkeleton ()

	AppenderSkeleton (const LayoutPtr &layout)

void	finalize ()
	Finalize this appender by calling the derived class' `close` method. More...

virtual void	activateOptions (log4cxx::helpers::Pool &)
	Derived appenders should override this method if option structure requires it. More...

virtual void	setOption (const LogString &option, const LogString &value)
	Set `option` to `value`. More...

void	addFilter (const spi::FilterPtr &newFilter)
	Add a filter to end of the filter list. More...

void	clearFilters ()
	Clear the filters chain. More...

const spi::ErrorHandlerPtr &	getErrorHandler () const
	Return the currently set spi::ErrorHandler for this Appender. More...

spi::FilterPtr	getFilter () const
	Returns the head Filter. More...

const spi::FilterPtr &	getFirstFilter () const
	Return the first filter in the filter chain for this Appender. More...

LayoutPtr	getLayout () const
	Returns the layout of this appender. More...

LogString	getName () const
	Returns the name of this Appender. More...

const LevelPtr &	getThreshold () const
	Returns this appenders threshold level. More...

bool	isAsSevereAsThreshold (const LevelPtr &level) const
	Check whether the message level is below the appender's threshold. More...

virtual void	doAppend (const spi::LoggingEventPtr &event, log4cxx::helpers::Pool &pool)
	This method performs threshold checks and invokes filters before delegating actual logging to the subclasses specific AppenderSkeleton::append method. More...

void	setErrorHandler (const spi::ErrorHandlerPtr eh)
	Set the `ErrorHandler` for this Appender. More...

void	setLayout (const LayoutPtr &layout1)
	Set the layout for this appender. More...

void	setName (const LogString &name1)
	Set the name of this Appender. More...

void	setThreshold (const LevelPtr &threshold)
	Set the threshold level. More...

Public Member Functions inherited from log4cxx::Appender
virtual	~Appender ()

void	asdf ()

virtual void	addFilter (const spi::FilterPtr &newFilter)=0
	Add a filter to the end of the filter list. More...

virtual spi::FilterPtr	getFilter () const =0
	Returns the head Filter. More...

virtual void	clearFilters ()=0
	Clear the list of filters by removing all the filters in it. More...

virtual void	close ()=0
	Release any resources allocated within the appender such as file handles, network connections, etc. More...

virtual void	doAppend (const spi::LoggingEventPtr &event, log4cxx::helpers::Pool &pool)=0
	Log in `Appender` specific way. More...

virtual LogString	getName () const =0
	Get the name of this appender. More...

virtual void	setLayout (const LayoutPtr &layout)=0
	Set the Layout for this appender. More...

virtual LayoutPtr	getLayout () const =0
	Returns this appenders layout. More...

virtual void	setName (const LogString &name)=0
	Set the name of this appender. More...

virtual bool	requiresLayout () const =0
	Configurators call this method to determine if the appender requires a layout. More...

Public Member Functions inherited from log4cxx::spi::OptionHandler
virtual	~OptionHandler ()

virtual void	activateOptions (log4cxx::helpers::Pool &p)=0
	Activate the options that were previously set with calls to option setters. More...

virtual void	setOption (const LogString &option, const LogString &value)=0
	Set `option` to `value`. More...

Public Member Functions inherited from log4cxx::helpers::Object
virtual	~Object ()

virtual bool	instanceof (const Class &clazz) const =0

virtual const void *	cast (const Class &clazz) const =0

Static Public Member Functions
static const LogString &	getSystemOut ()

static const LogString &	getSystemErr ()

Additional Inherited Members
Protected Member Functions inherited from log4cxx::WriterAppender
	WriterAppender (const LayoutPtr &layout, log4cxx::helpers::WriterPtr &writer)

	WriterAppender (const LayoutPtr &layout)

virtual bool	checkEntryConditions () const
	This method determines if there is a sense in attempting to append. More...

void	closeWriter ()
	Close the underlying `log4cxx::helpers::Writer`. More...

virtual log4cxx::helpers::WriterPtr	createWriter (log4cxx::helpers::OutputStreamPtr &os)
	Returns an OutputStreamWriter when passed an OutputStream. More...

virtual void	subAppend (const spi::LoggingEventPtr &event, log4cxx::helpers::Pool &p)
	Actual writing occurs here. More...

virtual void	writeFooter (log4cxx::helpers::Pool &p)
	Write a footer as produced by the embedded layout's Layout::appendFooter method. More...

virtual void	writeHeader (log4cxx::helpers::Pool &p)
	Write a header as produced by the embedded layout's Layout::appendHeader method. More...

void	setWriterInternal (const log4cxx::helpers::WriterPtr &writer)
	Set the writer. More...

Protected Member Functions inherited from log4cxx::AppenderSkeleton
virtual void	append (const spi::LoggingEventPtr &event, log4cxx::helpers::Pool &p)=0
	Subclasses of `AppenderSkeleton` should implement this method to perform actual logging. More...

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

Protected Attributes inherited from log4cxx::AppenderSkeleton
LayoutPtr	layout
	The layout variable does not need to be set if the appender implementation has its own layout. More...

LogString	name
	Appenders are named. More...

LevelPtr	threshold
	There is no level threshold filtering by default. More...

spi::ErrorHandlerPtr	errorHandler
	It is assumed and enforced that errorHandler is never null. More...

spi::FilterPtr	headFilter
	The first filter in the filter chain. More...

spi::FilterPtr	tailFilter
	The last filter in the filter chain. More...

bool	closed
	Is this appender closed? More...

log4cxx::helpers::Pool	pool

std::recursive_mutex	mutex

Detailed Description

ConsoleAppender appends log events to stdout or stderr using a layout specified by the user.

The default target is stdout.

Constructor & Destructor Documentation

◆ ConsoleAppender() [1/3]

log4cxx::ConsoleAppender::ConsoleAppender ( )

◆ ConsoleAppender() [2/3]

log4cxx::ConsoleAppender::ConsoleAppender ( const LayoutPtr & layout )

◆ ConsoleAppender() [3/3]

log4cxx::ConsoleAppender::ConsoleAppender	(	const LayoutPtr &	layout,
		const LogString &	target
	)

◆ ~ConsoleAppender()

log4cxx::ConsoleAppender::~ConsoleAppender ( )

Member Function Documentation

◆ activateOptions()

void log4cxx::ConsoleAppender::activateOptions ( log4cxx::helpers::Pool & pool )

virtual

Derived appenders should override this method if option structure requires it.

Reimplemented from log4cxx::WriterAppender.

◆ getSystemErr()

static const LogString & log4cxx::ConsoleAppender::getSystemErr ( )

static

◆ getSystemOut()

static const LogString & log4cxx::ConsoleAppender::getSystemOut ( )

static

◆ getTarget()

LogString log4cxx::ConsoleAppender::getTarget ( ) const

Returns the current value of the target property.

The default value of the option is "System.out".

◆ setOption()

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

virtual

Set option to value.

The handling of each option depends on the OptionHandler instance. Some options may become active immediately whereas other may be activated only when activateOptions is called.

Reimplemented from log4cxx::AppenderSkeleton.

◆ setTarget()

void log4cxx::ConsoleAppender::setTarget ( const LogString & value )

Sets the value of the target property.

Recognized values are "System.out" and "System.err". Any other value will be ignored.

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

consoleappender.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members