Apache Log4cxx  Version 1.1.0
appenderskeleton.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_APPENDER_SKELETON_H
19 #define _LOG4CXX_APPENDER_SKELETON_H
20 
21 #include <log4cxx/appender.h>
22 #include <log4cxx/layout.h>
24 #include <log4cxx/spi/filter.h>
25 #include <log4cxx/helpers/object.h>
26 #include <log4cxx/helpers/pool.h>
27 #include <log4cxx/level.h>
28 
29 namespace log4cxx
30 {
31 
38 class LOG4CXX_EXPORT AppenderSkeleton :
39  public virtual Appender,
40  public virtual helpers::Object
41 {
42  protected:
43  LOG4CXX_DECLARE_PRIVATE_MEMBER_PTR(AppenderSkeletonPrivate, m_priv)
44  AppenderSkeleton(LOG4CXX_PRIVATE_PTR(AppenderSkeletonPrivate) priv);
45 
51  virtual void append(const spi::LoggingEventPtr& event, log4cxx::helpers::Pool& p) = 0;
52 
53  void doAppendImpl(const spi::LoggingEventPtr& event, log4cxx::helpers::Pool& pool);
54 
55  public:
60  LOG4CXX_CAST_ENTRY(spi::OptionHandler)
62 
64  AppenderSkeleton(const LayoutPtr& layout);
65  virtual ~AppenderSkeleton();
66 
71  void finalize();
72 
77  void activateOptions(helpers::Pool& /* pool */) override {}
78  void setOption(const LogString& option, const LogString& value) override;
79 
83  void addFilter(const spi::FilterPtr newFilter) override;
84 
85  public:
89  void clearFilters() override;
90 
96 
100  spi::FilterPtr getFilter() const override;
101 
108 
112  LayoutPtr getLayout() const override;
113 
114 
118  LogString getName() const override;
119 
124  const LevelPtr getThreshold() const;
125 
131  bool isAsSevereAsThreshold(const LevelPtr& level) const;
132 
133 
139  void doAppend(const spi::LoggingEventPtr& event, helpers::Pool& pool) override;
140 
145 
150  void setLayout(const LayoutPtr layout1) override;
151 
155  void setName(const LogString& name1) override;
156 
157 
166  void setThreshold(const LevelPtr& threshold);
167 
168 }; // class AppenderSkeleton
169 } // namespace log4cxx
170 
171 #endif //_LOG4CXX_APPENDER_SKELETON_H
Implementation base class for all appenders.
Definition: appenderskeleton.h:41
LogString getName() const override
Returns the name of this Appender.
void setErrorHandler(const spi::ErrorHandlerPtr eh)
Set the ErrorHandler for this Appender.
spi::FilterPtr getFilter() const override
Returns the head Filter.
void doAppend(const spi::LoggingEventPtr &event, helpers::Pool &pool) override
This method performs threshold checks and invokes filters before delegating actual logging to the sub...
const spi::FilterPtr getFirstFilter() const
Return the first filter in the filter chain for this Appender.
LayoutPtr getLayout() const override
Returns the layout of this appender.
void setOption(const LogString &option, const LogString &value) override
Set option to value.
const LevelPtr getThreshold() const
Returns this appenders threshold level.
void setName(const LogString &name1) override
Set the name of this Appender.
void setLayout(const LayoutPtr layout1) override
Set the layout for this appender.
void setThreshold(const LevelPtr &threshold)
Set the threshold level.
void addFilter(const spi::FilterPtr newFilter) override
Add a filter to end of the filter list.
bool isAsSevereAsThreshold(const LevelPtr &level) const
Check whether the message level is below the appender's threshold.
void clearFilters() override
Clear the filters chain.
const spi::ErrorHandlerPtr getErrorHandler() const
Return the currently set spi::ErrorHandler for this Appender.
Implement this interface for your own strategies for outputting log statements.
Definition: appender.h:51
base class for java-like objects.
Definition: object.h:105
Definition: pool.h:33
std::shared_ptr< ErrorHandler > ErrorHandlerPtr
Definition: appender.h:37
std::shared_ptr< Filter > FilterPtr
Definition: appender.h:34
std::shared_ptr< LoggingEvent > LoggingEventPtr
Definition: appender.h:31
Definition: appender.h:27
std::basic_string< logchar > LogString
Definition: logstring.h:60
std::shared_ptr< Level > LevelPtr
Definition: optionconverter.h:27
std::shared_ptr< Layout > LayoutPtr
Definition: appender.h:41
#define LOG4CXX_CAST_ENTRY(Interface)
Definition: object.h:157
#define DECLARE_ABSTRACT_LOG4CXX_OBJECT(object)
Definition: object.h:38
#define END_LOG4CXX_CAST_MAP()
Definition: object.h:151
#define BEGIN_LOG4CXX_CAST_MAP()
Definition: object.h:145