Apache log4cxx Version 0.13.0
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
27{
28
29namespace helpers
30{
31class Pool;
32}
33
34namespace rolling
35{
36
37
71class LOG4CXX_EXPORT FixedWindowRollingPolicy : public RollingPolicyBase
72{
78
79 int minIndex;
80 int maxIndex;
81 bool explicitActiveFile;
82
86 enum { MAX_WINDOW_SIZE = 12 };
87
88 bool purge(int purgeStart, int maxIndex, log4cxx::helpers::Pool& p) const;
89
90 public:
91
93
95 void setOption(const LogString& option,
96 const LogString& value);
97
98 void rollover();
99
100 int getMaxIndex() const;
101
102 int getMinIndex() const;
103
104 void setMaxIndex(int newVal);
105 void setMinIndex(int newVal);
106
110 RolloverDescriptionPtr initialize(
111 const LogString& currentActiveFile,
112 const bool append,
114
118 RolloverDescriptionPtr rollover(
119 const LogString& currentActiveFile,
120 const bool append,
122
123 protected:
125
126};
127
129
130}
131}
132
133#endif
Definition: pool.h:33
When rolling over, FixedWindowRollingPolicy renames files according to a fixed window algorithm as de...
Definition: fixedwindowrollingpolicy.h:72
void setOption(const LogString &option, const LogString &value)
Set option to value.
RolloverDescriptionPtr rollover(const LogString &currentActiveFile, const bool append, log4cxx::helpers::Pool &pool)
Prepare for a rollover.This method is called prior to closing the active log file,...
RolloverDescriptionPtr initialize(const LogString &currentActiveFile, const bool append, log4cxx::helpers::Pool &pool)
Initialize the policy and return any initial actions for rolling file appender.Description of the ini...
void activateOptions(log4cxx::helpers::Pool &p)
Activate the options that were previously set with calls to option setters.
log4cxx::pattern::PatternMap getFormatSpecifiers() const
Implements methods common to most, it not all, rolling policies.
Definition: rollingpolicybase.h:52
std::map< LogString, PatternConstructor > PatternMap
Definition: patternparser.h:41
LOG4CXX_PTR_DEF(Action)
Definition: messagehandler.h:23
std::basic_string< logchar > LogString
Definition: logstring.h:66
#define LOG4CXX_CAST_ENTRY(Interface)
Definition: object.h:153
#define END_LOG4CXX_CAST_MAP()
Definition: object.h:147
#define DECLARE_LOG4CXX_OBJECT(object)
Definition: object.h:39
#define LOG4CXX_CAST_ENTRY_CHAIN(Interface)
Definition: object.h:159
#define BEGIN_LOG4CXX_CAST_MAP()
Definition: object.h:141