Apache Log4cxx  Version 1.2.0
Loading...
Searching...
No Matches
filterbasedtriggeringpolicy.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#if !defined(_LOG4CXX_ROLLING_FILTER_BASED_TRIGGERING_POLICY_H)
19#define _LOG4CXX_ROLLING_FILTER_BASED_TRIGGERING_POLICY_H
20
22#include <log4cxx/spi/filter.h>
23
24// Instantiate template pointer types passed as parameters
25LOG4CXX_INSTANTIATE_EXPORTED_PTR(LOG4CXX_NS::spi::Filter);
26
27namespace LOG4CXX_NS
28{
29
30class File;
31
32namespace helpers
33{
34class Pool;
35}
36
37
38namespace rolling
39{
40
50class LOG4CXX_EXPORT FilterBasedTriggeringPolicy : public TriggeringPolicy
51{
52
58
59 LOG4CXX_DECLARE_PRIVATE_MEMBER_PTR(FilterBasedTriggeringPolicyPrivate, m_priv)
60
61 public:
67
80 Appender* appender,
81 const spi::LoggingEventPtr& event,
82 const LogString& filename,
83 size_t fileLength) override;
84
89 void addFilter(const spi::FilterPtr& newFilter);
90
96
102
109
117 void setOption(const LogString& option, const LogString& value) override;
118};
119
121
122}
123}
124
125#endif
Implement this interface for your own strategies for outputting log statements.
Definition: appender.h:51
Definition: pool.h:33
FilterBasedTriggeringPolicy determines if rolling should be triggered by evaluating the current messa...
Definition: filterbasedtriggeringpolicy.h:51
spi::FilterPtr & getFilter()
Returns the head Filter.
void clearFilters()
Clear the filters chain.
bool isTriggeringEvent(Appender *appender, const spi::LoggingEventPtr &event, const LogString &filename, size_t fileLength) override
Determines if a rollover may be appropriate at this time.
void setOption(const LogString &option, const LogString &value) override
Set option to value.
FilterBasedTriggeringPolicy()
Creates a new FilterBasedTriggeringPolicy.
void addFilter(const spi::FilterPtr &newFilter)
Add a filter to end of the filter list.
void activateOptions(helpers::Pool &) override
Activate the options that were previously set with calls to option setters.
A TriggeringPolicy controls the conditions under which rollover occurs.
Definition: triggeringpolicy.h:47
LOG4CXX_INSTANTIATE_EXPORTED_PTR(log4cxx::spi::Filter)
std::shared_ptr< Filter > FilterPtr
Definition: appender.h:35
std::shared_ptr< LoggingEvent > LoggingEventPtr
Definition: appender.h:32
std::basic_string< logchar > LogString
Definition: logstring.h:60
LOG4CXX_PTR_DEF(Appender)
#define LOG4CXX_CAST_ENTRY(Interface)
Definition: object.h:158
#define END_LOG4CXX_CAST_MAP()
Definition: object.h:152
#define DECLARE_LOG4CXX_OBJECT(object)
Definition: object.h:43
#define LOG4CXX_CAST_ENTRY_CHAIN(Interface)
Definition: object.h:164
#define BEGIN_LOG4CXX_CAST_MAP()
Definition: object.h:146