[89] | 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_HELPERS_ONLY_ONCE_ERROR_HANDLER_H
|
---|
| 19 | #define _LOG4CXX_HELPERS_ONLY_ONCE_ERROR_HANDLER_H
|
---|
| 20 |
|
---|
| 21 | #include <log4cxx/spi/errorhandler.h>
|
---|
| 22 | #include <log4cxx/helpers/objectimpl.h>
|
---|
| 23 |
|
---|
| 24 | namespace log4cxx
|
---|
| 25 | {
|
---|
| 26 | namespace helpers
|
---|
| 27 | {
|
---|
| 28 | /**
|
---|
| 29 | The <code>OnlyOnceErrorHandler</code> implements log4cxx's default
|
---|
| 30 | error handling policy which consists of emitting a message for the
|
---|
| 31 | first error in an appender and ignoring all following errors.
|
---|
| 32 |
|
---|
| 33 | <p>The error message is printed on <code>System.err</code>.
|
---|
| 34 |
|
---|
| 35 | <p>This policy aims at protecting an otherwise working application
|
---|
| 36 | from being flooded with error messages when logging fails
|
---|
| 37 | */
|
---|
| 38 | class LOG4CXX_EXPORT OnlyOnceErrorHandler :
|
---|
| 39 | public virtual spi::ErrorHandler,
|
---|
| 40 | public virtual ObjectImpl
|
---|
| 41 | {
|
---|
| 42 | private:
|
---|
| 43 | LogString WARN_PREFIX;
|
---|
| 44 | LogString ERROR_PREFIX;
|
---|
| 45 | mutable bool firstTime;
|
---|
| 46 |
|
---|
| 47 | public:
|
---|
| 48 | DECLARE_LOG4CXX_OBJECT(OnlyOnceErrorHandler)
|
---|
| 49 | BEGIN_LOG4CXX_CAST_MAP()
|
---|
| 50 | LOG4CXX_CAST_ENTRY(spi::OptionHandler)
|
---|
| 51 | LOG4CXX_CAST_ENTRY(spi::ErrorHandler)
|
---|
| 52 | END_LOG4CXX_CAST_MAP()
|
---|
| 53 |
|
---|
| 54 | OnlyOnceErrorHandler();
|
---|
| 55 | void addRef() const;
|
---|
| 56 | void releaseRef() const;
|
---|
| 57 |
|
---|
| 58 | /**
|
---|
| 59 | Does not do anything.
|
---|
| 60 | */
|
---|
| 61 | void setLogger(const LoggerPtr& logger);
|
---|
| 62 |
|
---|
| 63 |
|
---|
| 64 | /**
|
---|
| 65 | No options to activate.
|
---|
| 66 | */
|
---|
| 67 | void activateOptions(log4cxx::helpers::Pool& p);
|
---|
| 68 | void setOption(const LogString& option, const LogString& value);
|
---|
| 69 |
|
---|
| 70 |
|
---|
| 71 | /**
|
---|
| 72 | Prints the message and the stack trace of the exception on
|
---|
| 73 | <code>System.err</code>. */
|
---|
| 74 | void error(const LogString& message, const std::exception& e,
|
---|
| 75 | int errorCode) const;
|
---|
| 76 | /**
|
---|
| 77 | Prints the message and the stack trace of the exception on
|
---|
| 78 | <code>System.err</code>.
|
---|
| 79 | */
|
---|
| 80 | void error(const LogString& message, const std::exception& e,
|
---|
| 81 | int errorCode, const spi::LoggingEventPtr& event) const;
|
---|
| 82 |
|
---|
| 83 | /**
|
---|
| 84 | Print a the error message passed as parameter on
|
---|
| 85 | <code>System.err</code>.
|
---|
| 86 | */
|
---|
| 87 | void error(const LogString& message) const;
|
---|
| 88 |
|
---|
| 89 | /**
|
---|
| 90 | Does not do anything.
|
---|
| 91 | */
|
---|
| 92 | void setAppender(const AppenderPtr& appender);
|
---|
| 93 |
|
---|
| 94 | /**
|
---|
| 95 | Does not do anything.
|
---|
| 96 | */
|
---|
| 97 | void setBackupAppender(const AppenderPtr& appender);
|
---|
| 98 | };
|
---|
| 99 | } // namespace helpers
|
---|
| 100 | } // namespace log4cxx
|
---|
| 101 |
|
---|
| 102 | #endif //_LOG4CXX_HELPERS_ONLY_ONCE_ERROR_HANDLER_H
|
---|
| 103 |
|
---|