Apache log4cxx  Version 0.12.1
errorhandler.h
Go to the documentation of this file.
1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one or more
3  * contributor license agreements. See the NOTICE file distributed with
4  * this work for additional information regarding copyright ownership.
5  * The ASF licenses this file to You under the Apache License, Version 2.0
6  * (the "License"); you may not use this file except in compliance with
7  * the License. You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17 
18 #ifndef _LOG4CXX_SPI_ERROR_HANDLER_H
19 #define _LOG4CXX_SPI_ERROR_HANDLER_H
20 
21 #if defined(_MSC_VER)
22  #pragma warning ( push )
23  #pragma warning ( disable: 4231 4251 4275 4786 )
24 #endif
25 
26 
29 #include <log4cxx/appender.h>
31 
32 namespace log4cxx
33 {
34 namespace spi
35 {
36 class ErrorCode
37 {
38  public:
39  enum
40  {
48  };
49 };
50 
51 
64 class LOG4CXX_EXPORT ErrorHandler : public virtual OptionHandler
65 {
66  public:
72 
73  virtual ~ErrorHandler() {}
74 
83  virtual void setLogger(const LoggerPtr& logger) = 0;
84 
85 
91  virtual void error(const LogString& message, const std::exception& e,
92  int errorCode) const = 0;
93 
98  virtual void error(const LogString& message) const = 0;
99 
109  virtual void error(const LogString& message, const std::exception& e,
110  int errorCode, const LoggingEventPtr& event) const = 0;
111 
116  virtual void setAppender(const AppenderPtr& appender) = 0;
117 
121  virtual void setBackupAppender(const AppenderPtr& appender) = 0;
122 };
123 
125 } //namespace spi
126 } //namespace log4cxx
127 
128 #if defined(_MSC_VER)
129  #pragma warning ( pop )
130 #endif
131 
132 #endif //_LOG4CXX_SPI_ERROR_HANDLER_H
Definition: errorhandler.h:37
@ GENERIC_FAILURE
Definition: errorhandler.h:41
@ FLUSH_FAILURE
Definition: errorhandler.h:43
@ MISSING_LAYOUT
Definition: errorhandler.h:46
@ CLOSE_FAILURE
Definition: errorhandler.h:44
@ WRITE_FAILURE
Definition: errorhandler.h:42
@ FILE_OPEN_FAILURE
Definition: errorhandler.h:45
@ ADDRESS_PARSE_FAILURE
Definition: errorhandler.h:47
Appenders may delegate their error handling to ErrorHandlers.
Definition: errorhandler.h:65
virtual void setBackupAppender(const AppenderPtr &appender)=0
Set the appender to fallback upon in case of failure.
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 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 eve...
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 =0
This method is normally used to just print the error message passed as a parameter.
virtual void setAppender(const AppenderPtr &appender)=0
Set the appender for which errors are handled.
A string based interface to configure package components.
Definition: optionhandler.h:35
LOG4CXX_PTR_DEF(LoggerRepository)
std::shared_ptr< LoggingEvent > LoggingEventPtr
Definition: appender.h:37
Definition: appender.h:33
std::basic_string< logchar > LogString
Definition: logstring.h:66
std::shared_ptr< Appender > AppenderPtr
Definition: basicconfigurator.h:28
std::shared_ptr< Logger > LoggerPtr
Definition: defaultloggerfactory.h:26
#define LOG4CXX_CAST_ENTRY(Interface)
Definition: object.h:148
#define DECLARE_ABSTRACT_LOG4CXX_OBJECT(object)
Definition: object.h:26
#define END_LOG4CXX_CAST_MAP()
Definition: object.h:142
#define BEGIN_LOG4CXX_CAST_MAP()
Definition: object.h:136