Apache Log4cxx  Version 1.3.1
fixedwindowrollingpolicy.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_FIXED_WINDOW_ROLLING_POLICY_H)
19 #define _LOG4CXX_ROLLING_FIXED_WINDOW_ROLLING_POLICY_H
20 
22 
23 
24 
25 
26 namespace LOG4CXX_NS
27 {
28 
29 namespace helpers
30 {
31 class Pool;
32 }
33 
34 namespace rolling
35 {
36 
37 
71 class LOG4CXX_EXPORT FixedWindowRollingPolicy : public RollingPolicyBase
72 {
78 
79  struct FixedWindowRollingPolicyPrivate;
80 
84  enum { MAX_WINDOW_SIZE = 12 };
85 
86  bool purge(int purgeStart, int maxIndex, LOG4CXX_NS::helpers::Pool& p) const;
87 
88  public:
89 
92 
100  void activateOptions(helpers::Pool& p) override;
101 
113  void setOption(const LogString& option, const LogString& value) override;
114 
115  void rollover();
116 
117  int getMaxIndex() const;
118 
119  int getMinIndex() const;
120 
121  void setMaxIndex(int newVal);
122  void setMinIndex(int newVal);
123 
127  RolloverDescriptionPtr initialize(
128  const LogString& currentActiveFile,
129  const bool append,
130  helpers::Pool& pool) override;
131 
135  RolloverDescriptionPtr rollover(
136  const LogString& currentActiveFile,
137  const bool append,
138  helpers::Pool& pool) override;
139 
140  protected:
147 
148 };
149 
151 
152 }
153 }
154 
155 #endif
Definition: pool.h:33
When rolling over, FixedWindowRollingPolicy renames files according to a fixed window algorithm as de...
Definition: fixedwindowrollingpolicy.h:72
RolloverDescriptionPtr initialize(const LogString &currentActiveFile, const bool append, helpers::Pool &pool) override
Initialize the policy and return any initial actions for rolling file appender.current value of Rolli...
log4cxx::pattern::PatternMap getFormatSpecifiers() const override
A map from "i" and "index" to a integer conversion formatter.
RolloverDescriptionPtr rollover(const LogString &currentActiveFile, const bool append, helpers::Pool &pool) override
Prepare for a rollover.This method is called prior to closing the active log file,...
void activateOptions(helpers::Pool &p) override
Activate the options that were previously set with calls to option setters.
void setOption(const LogString &option, const LogString &value) override
Set option to value.
Implements methods common to most, it not all, rolling policies.
Definition: rollingpolicybase.h:46
std::map< LogString, PatternConstructor > PatternMap
Definition: patternparser.h:35
LOG4CXX_PTR_DEF(FixedWindowRollingPolicy)
std::basic_string< logchar > LogString
Definition: logstring.h:60
#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