Apache Log4cxx  Version 1.8.0
Loading...
Searching...
No Matches
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
26namespace LOG4CXX_NS
27{
28
29namespace helpers
30{
31class Pool;
32}
33
34namespace rolling
35{
36
37
71class 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) const;
87#if LOG4CXX_ABI_VERSION <= 15
88 bool purge(int lowIndex, int highIndex, helpers::Pool& pool) const;
89#endif
90 public:
91
94
104
116 void setOption(const LogString& option, const LogString& value) override;
117
118 void rollover();
119
120 int getMaxIndex() const;
121
122 int getMinIndex() const;
123
124 void setMaxIndex(int newVal);
125 void setMinIndex(int newVal);
126
132
138
139 protected:
145 LOG4CXX_NS::pattern::PatternMap getFormatSpecifiers() const override;
146
147};
148
150
151}
152}
153
154#endif
Definition pool.h:33
When rolling over, FixedWindowRollingPolicy renames files according to a fixed window algorithm as de...
Definition fixedwindowrollingpolicy.h:72
log4cxx::pattern::PatternMap getFormatSpecifiers() const override
A map from "i" and "index" to a integer conversion formatter.
RolloverDescriptionPtr rollover(const LogString &currentActiveFile, bool append, helpers::Pool &p) override
The pool parameter is not used and will be removed in a future version. Implement this method for now...
RolloverDescriptionPtr initialize(const LogString &currentActiveFile, bool append, helpers::Pool &p) override
The pool parameter is not used and will be removed in a future version. Implement this method for now...
void activateOptions(helpers::Pool &p) override
void setOption(const LogString &option, const LogString &value) override
Set option to value.
void activateOptions(helpers::Pool &p) override
RolloverDescriptionPtr rollover(const LogString &currentActiveFile, bool append)
Prepare for a rollover.
RolloverDescriptionPtr initialize(const LogString &currentActiveFile, bool append)
Initialize the policy and return any initial actions for rolling file appender.
LOG4CXX_PTR_DEF(Action)
std::basic_string< logchar > LogString
Definition logstring.h:60
#define LOG4CXX_CAST_ENTRY(Interface)
Definition object.h:154
#define END_LOG4CXX_CAST_MAP()
Definition object.h:148
#define DECLARE_LOG4CXX_OBJECT(object)
Definition object.h:41
#define LOG4CXX_CAST_ENTRY_CHAIN(Interface)
Definition object.h:160
#define BEGIN_LOG4CXX_CAST_MAP()
Definition object.h:142
#define LOG4CXX_ACTIVATE_OPTIONS_FORMAL_PARAMETERS
Activate the options that were previously set with calls to option setters.
Definition optionhandler.h:53
#define LOG4CXX_ROLLING_POLICY_INITIALIZE_FORMAL_PARAMETERS
Definition rollingpolicy.h:67
#define LOG4CXX_ROLLING_POLICY_ROLLOVER_FORMAL_PARAMETERS
Definition rollingpolicy.h:99