log4cxx::spi::ErrorHandler Class Reference

Appenders may delegate their error handling to ErrorHandlers. More...

#include <errorhandler.h>

Inheritance diagram for log4cxx::spi::ErrorHandler:

Public Member Functions
virtual	~ErrorHandler ()
virtual void	setLogger (const LoggerPtr &logger)=0
	Add a reference to a logger to which the failing appender might be attached to.
virtual void	error (const LogString &message, const std::exception &e, int errorCode) const =0
	Equivalent to the error(const String&, helpers::Exception&, int, spi::LoggingEvent&) with the the event parameteter set to null.
virtual void	error (const LogString &message) const =0
	This method is normally used to just print the error message passed as a parameter.
virtual void	error (const LogString &message, const std::exception &e, int errorCode, const LoggingEventPtr &event) const =0
	This method is invoked to handle the error.
virtual void	setAppender (const AppenderPtr &appender)=0
	Set the appender for which errors are handled.
virtual void	setBackupAppender (const AppenderPtr &appender)=0
	Set the appender to fallback upon in case of failure.
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

Appenders may delegate their error handling to ErrorHandlers.

Error handling is a particularly tedious to get right because by definition errors are hard to predict and to reproduce.

Please take the time to contact the author in case you discover that errors are not properly handled. You are most welcome to suggest new error handling policies or criticize existing policies.

Constructor & Destructor Documentation

~ErrorHandler()

virtual log4cxx::spi::ErrorHandler::~ErrorHandler ( )

inlinevirtual

Member Function Documentation

error() [1/3]

virtual void log4cxx::spi::ErrorHandler::error ( const LogString &  message ) const

pure virtual

This method is normally used to just print the error message passed as a parameter.

Implemented in log4cxx::varia::FallbackErrorHandler, and log4cxx::helpers::OnlyOnceErrorHandler.

error() [2/3]

virtual void log4cxx::spi::ErrorHandler::error ( const LogString &  message, const std::exception &  e, int  errorCode  ) const

pure virtual

Equivalent to the error(const String&, helpers::Exception&, int, spi::LoggingEvent&) with the the event parameteter set to null.

Implemented in log4cxx::helpers::OnlyOnceErrorHandler, and log4cxx::varia::FallbackErrorHandler.

error() [3/3]

virtual void log4cxx::spi::ErrorHandler::error ( const LogString &  message, const std::exception &  e, int  errorCode, const LoggingEventPtr &  event  ) const

pure virtual

This method is invoked to handle the error.

Parameters

message	The message assoicated with the error.
e	The Exption that was thrown when the error occured.
errorCode	The error code associated with the error.
event	The logging event that the failing appender is asked to log.

Implemented in log4cxx::helpers::OnlyOnceErrorHandler, and log4cxx::varia::FallbackErrorHandler.

setAppender()

virtual void log4cxx::spi::ErrorHandler::setAppender ( const AppenderPtr &  appender )

pure virtual

Set the appender for which errors are handled.

This method is usually called when the error handler is configured.

Implemented in log4cxx::helpers::OnlyOnceErrorHandler, and log4cxx::varia::FallbackErrorHandler.

setBackupAppender()

virtual void log4cxx::spi::ErrorHandler::setBackupAppender ( const AppenderPtr &  appender )

pure virtual

Set the appender to fallback upon in case of failure.

Implemented in log4cxx::helpers::OnlyOnceErrorHandler, and log4cxx::varia::FallbackErrorHandler.

setLogger()

virtual void log4cxx::spi::ErrorHandler::setLogger ( const LoggerPtr &  logger )

pure virtual

Add a reference to a logger to which the failing appender might be attached to.

The failing appender will be searched and replaced only in the loggers you add through this method.

Parameters

logger

One of the loggers that will be searched for the failing appender in view of replacement.

Implemented in log4cxx::helpers::OnlyOnceErrorHandler, and log4cxx::varia::FallbackErrorHandler.

---

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

• errorhandler.h