Apache log4cxx  Version 0.12.0
log4cxx::spi::ErrorHandler Class Referenceabstract

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

#include <errorhandler.h>

Inheritance diagram for log4cxx::spi::ErrorHandler:
log4cxx::spi::OptionHandler log4cxx::helpers::Object log4cxx::helpers::OnlyOnceErrorHandler log4cxx::varia::FallbackErrorHandler

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. More...
 
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. More...
 
virtual void error (const LogString &message) const =0
 This method is normally used to just print the error message passed as a parameter. More...
 
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. More...
 
virtual void setAppender (const AppenderPtr &appender)=0
 Set the appender for which errors are handled. More...
 
virtual void setBackupAppender (const AppenderPtr &appender)=0
 Set the appender to fallback upon in case of failure. 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
 

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 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() [2/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() [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
messageThe message assoicated with the error.
eThe Exption that was thrown when the error occured.
errorCodeThe error code associated with the error.
eventThe 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::varia::FallbackErrorHandler, and log4cxx::helpers::OnlyOnceErrorHandler.

◆ 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::varia::FallbackErrorHandler, and log4cxx::helpers::OnlyOnceErrorHandler.

◆ 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
loggerOne 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: