log4cxx::ConsoleAppender Class Reference

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 ()
	A stdout log event appender.
	ConsoleAppender (const LayoutPtr &layout)
	A stdout log event appender formatted using layout.
	ConsoleAppender (const LayoutPtr &layout, const LogString &target)
	A target log event appender formatted using layout.
	~ConsoleAppender ()
void	setTarget (const LogString &newValue)
	Use newValue for the target property.
LogString	getTarget () const
void	activateOptions (helpers::Pool &p) override
	Derived appenders should override this method if option structure requires it.
void	setOption (const LogString &option, const LogString &value) override
	Set option to value.
Public Member Functions inherited from log4cxx::WriterAppender
	WriterAppender ()
	This default constructor does nothing.
	~WriterAppender ()
void	activateOptions (helpers::Pool &pool) override
	Derived appenders should override this method if option structure requires it.
void	setImmediateFlush (bool value)
	If the ImmediateFlush option is set to true, the appender will flush at the end of each write.
bool	getImmediateFlush () const
	Returns value of the ImmediateFlush option.
void	append (const spi::LoggingEventPtr &event, helpers::Pool &p) override
	This method is called by the AppenderSkeleton::doAppend method.
void	close () override
	Close this appender instance.
LogString	getEncoding () const
	The current encoding value.
void	setEncoding (const LogString &value)
	Set the encoding to value.
void	setOption (const LogString &option, const LogString &value) override
	Set option to value.
void	setWriter (const log4cxx::helpers::WriterPtr &writer)
const log4cxx::helpers::WriterPtr	getWriter () const
bool	requiresLayout () const override
	Configurators call this method to determine if the appender requires a layout.
Public Member Functions inherited from log4cxx::AppenderSkeleton
	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

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)
	WriterAppender (std::unique_ptr< WriterAppenderPriv > priv)
virtual bool	checkEntryConditions () const
	This method determines if there is a sense in attempting to append.
void	closeWriter ()
	Close the underlying log4cxx::helpers::Writer.
virtual helpers::WriterPtr	createWriter (helpers::OutputStreamPtr &os)
	Returns an OutputStreamWriter when passed an OutputStream.
virtual void	subAppend (const spi::LoggingEventPtr &event, log4cxx::helpers::Pool &p)
	Actual writing occurs here.
virtual void	writeFooter (log4cxx::helpers::Pool &p)
	Write a footer as produced by the embedded layout's Layout::appendFooter method.
virtual void	writeHeader (log4cxx::helpers::Pool &p)
	Write a header as produced by the embedded layout's Layout::appendHeader method.
void	setWriterInternal (const log4cxx::helpers::WriterPtr &writer)
	Set the writer.
Protected Member Functions inherited from log4cxx::AppenderSkeleton
	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

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

The default target is stdout.

You can use fwide(stdout, 1) in your configuration code or use the cmake directive LOG4CXX_FORCE_WIDE_CONSOLE=ON when building Log4cxx to force Log4cxx to use fputws. If doing this ensure the cmake directive LOG4CXX_WCHAR_T is also enabled.

Constructor & Destructor Documentation

ConsoleAppender() [1/3]

log4cxx::ConsoleAppender::ConsoleAppender

(

)

A stdout log event appender.

See also setLayout and setTarget.

ConsoleAppender() [2/3]

log4cxx::ConsoleAppender::ConsoleAppender

(

const LayoutPtr &

layout

)

A stdout log event appender formatted using layout.

Parameters

layout

formats a log event

ConsoleAppender() [3/3]

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

A target log event appender formatted using layout.

Parameters

layout	formats a log event
target	the value provided by getSystemOut or getSystemErr

~ConsoleAppender()

log4cxx::ConsoleAppender::~ConsoleAppender

(

)

Member Function Documentation

activateOptions()

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

overridevirtual

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

No action is performed in this implementation.

Reimplemented from log4cxx::AppenderSkeleton.

getSystemErr()

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

static

Returns

the name recognised as stderr.

getSystemOut()

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

static

Returns

the name recognised as stdout.

getTarget()

LogString log4cxx::ConsoleAppender::getTarget

(

)

const

Returns

the current value of the target property.

setOption()

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

overridevirtual

Set option to value.

Supported options	Supported values	Default value
Target	System.err,System.out	System.out

See also

WriterAppender::setOption()

Reimplemented from log4cxx::AppenderSkeleton.

setTarget()

void log4cxx::ConsoleAppender::setTarget

(

const LogString &

newValue

)

Use newValue for the target property.

Parameters

newValue

the value provided by getSystemOut or getSystemErr

---

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

• consoleappender.h