Apache Log4cxx  Version 1.2.0
Loading...
Searching...
No Matches
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
23#include <log4cxx/appender.h>
25
26namespace LOG4CXX_NS
27{
28namespace spi
29{
31{
32 public:
33 enum
34 {
35 GENERIC_FAILURE = 0,
36 WRITE_FAILURE = 1,
37 FLUSH_FAILURE = 2,
38 CLOSE_FAILURE = 3,
39 FILE_OPEN_FAILURE = 4,
40 MISSING_LAYOUT = 5,
41 ADDRESS_PARSE_FAILURE = 6
42 };
43};
44
45
58class LOG4CXX_EXPORT ErrorHandler : public virtual OptionHandler
59{
60 public:
66
67 virtual ~ErrorHandler() {}
68
77 virtual void setLogger(const LoggerPtr& logger) = 0;
78
79
85 virtual void error(const LogString& message, const std::exception& e,
86 int errorCode) const = 0;
87
92 virtual void error(const LogString& message) const = 0;
93
103 virtual void error(const LogString& message, const std::exception& e,
104 int errorCode, const LoggingEventPtr& event) const = 0;
105
110 virtual void setAppender(const AppenderPtr& appender) = 0;
111
115 virtual void setBackupAppender(const AppenderPtr& appender) = 0;
116};
117
119} //namespace spi
120} //namespace log4cxx
121
122#endif //_LOG4CXX_SPI_ERROR_HANDLER_H
Definition: errorhandler.h:31
Appenders may delegate their error handling to ErrorHandlers.
Definition: errorhandler.h:59
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
std::shared_ptr< LoggingEvent > LoggingEventPtr
Definition: appender.h:32
std::basic_string< logchar > LogString
Definition: logstring.h:60
LOG4CXX_PTR_DEF(Appender)
std::shared_ptr< Appender > AppenderPtr
Definition: basicconfigurator.h:29
std::shared_ptr< Logger > LoggerPtr
Definition: defaultloggerfactory.h:27
#define LOG4CXX_CAST_ENTRY(Interface)
Definition: object.h:158
#define DECLARE_ABSTRACT_LOG4CXX_OBJECT(object)
Definition: object.h:39
#define END_LOG4CXX_CAST_MAP()
Definition: object.h:152
#define BEGIN_LOG4CXX_CAST_MAP()
Definition: object.h:146