Apache Log4cxx  Version 1.3.1
filter.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_FILTER_H
19 #define _LOG4CXX_SPI_FILTER_H
20 
21 #include <log4cxx/helpers/object.h>
24 
25 namespace LOG4CXX_NS
26 {
27 namespace spi
28 {
29 class Filter;
31 
32 
67 class LOG4CXX_EXPORT Filter : public virtual OptionHandler
68 {
69  protected:
70  LOG4CXX_DECLARE_PRIVATE_MEMBER_PTR(FilterPrivate, m_priv)
71 
72  public:
73  Filter();
74  Filter(std::unique_ptr<FilterPrivate> priv);
75  virtual ~Filter();
76 
82 
83  LOG4CXX_NS::spi::FilterPtr getNext() const;
84  void setNext(const LOG4CXX_NS::spi::FilterPtr& newNext);
85 
87  {
91  DENY = -1,
96  NEUTRAL = 0,
101  ACCEPT = 1
102 
103  };
104 
110  void activateOptions(helpers::Pool& p) override;
111 
119  void setOption(const LogString& option, const LogString& value) override;
120 
130  virtual FilterDecision decide(const LoggingEventPtr& event) const = 0;
131 };
132 }
133 }
134 
135 #endif //_LOG4CXX_SPI_FILTER_H
Definition: pool.h:33
Users should extend this class to implement customized logging event filtering.
Definition: filter.h:68
void activateOptions(helpers::Pool &p) override
Activate the options that were previously set with calls to option setters.
virtual FilterDecision decide(const LoggingEventPtr &event) const =0
void setOption(const LogString &option, const LogString &value) override
Set option to value.
FilterDecision
Definition: filter.h:87
Filter(std::unique_ptr< FilterPrivate > priv)
A string based interface to configure package components.
Definition: optionhandler.h:35
LOG4CXX_PTR_DEF(Filter)
std::shared_ptr< Filter > FilterPtr
Definition: appender.h:34
std::shared_ptr< LoggingEvent > LoggingEventPtr
Definition: appender.h:31
std::basic_string< logchar > LogString
Definition: logstring.h:60
#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