Apache Log4cxx: log4cxx::ConsoleAppender Class Reference (original) (raw)
ConsoleAppender appends log events to stdout or stderr using a layout specified by the user. More...
Public Member Functions
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.
void
setTarget (const LogString &newValue)
Use newValue for the target property.
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
This default constructor does nothing.
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.
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 helpers::WriterPtr &writer)
const 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 (const LayoutPtr &layout)
virtual
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.
getFilter () const override
Returns the head Filter.
const spi::FilterPtr
getFirstFilter () const
Return the first filter in the filter chain for this Appender.
getLayout () const override
Returns the layout of this appender.
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](classlog4cxx%5F1%5F1spi%5F1%5F1ErrorHandler.html) 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](classlog4cxx%5F1%5F1Appender.html "Implement this interface for your own strategies for outputting log statements.") 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
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
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.