Apache Log4cxx  Version 1.8.0
rollingpolicy.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_ROLLING_POLICY_H)
19 #define _LOG4CXX_ROLLING_ROLLING_POLICY_H
20 
23 #include <log4cxx/file.h>
24 
25 namespace LOG4CXX_NS
26 {
27 namespace rolling
28 {
29 
30 
41 class LOG4CXX_EXPORT RollingPolicy :
42  public virtual spi::OptionHandler
43 {
45 
46  public:
47  virtual ~RollingPolicy() {}
48 
57 #if LOG4CXX_ABI_VERSION <= 15
58  RolloverDescriptionPtr initialize(const LogString& currentActiveFile, bool append);
63  virtual RolloverDescriptionPtr initialize(
64  const LogString& currentActiveFile,
65  const bool append,
66  LOG4CXX_NS::helpers::Pool& pool) = 0;
67 #define LOG4CXX_ROLLING_POLICY_INITIALIZE_FORMAL_PARAMETERS const LogString& currentActiveFile, bool append, helpers::Pool& p
68 #else
69  virtual RolloverDescriptionPtr initialize(const LogString& currentActiveFile, bool append) = 0;
70 #define LOG4CXX_ROLLING_POLICY_INITIALIZE_FORMAL_PARAMETERS const LogString& currentActiveFile, bool append
74  [[deprecated("Use initialize() without a Pool parameter instead")]]
75  RolloverDescriptionPtr initialize(const LogString& currentActiveFile, bool append, helpers::Pool& pool);
76 #endif
77 
89 #if LOG4CXX_ABI_VERSION <= 15
90  RolloverDescriptionPtr rollover(const LogString& currentActiveFile, bool append);
95  virtual RolloverDescriptionPtr rollover(
96  const LogString& currentActiveFile,
97  const bool append,
98  LOG4CXX_NS::helpers::Pool& pool) = 0;
99 #define LOG4CXX_ROLLING_POLICY_ROLLOVER_FORMAL_PARAMETERS const LogString& currentActiveFile, bool append, helpers::Pool& p
100 #else
101  virtual RolloverDescriptionPtr rollover(const LogString& currentActiveFile, bool append) = 0;
102 #define LOG4CXX_ROLLING_POLICY_ROLLOVER_FORMAL_PARAMETERS const LogString& currentActiveFile, bool append
106  [[deprecated("Use rollover() without a Pool parameter instead")]]
107  RolloverDescriptionPtr rollover(const LogString& currentActiveFile, bool append, helpers::Pool& pool);
108 #endif
109 };
110 
112 
113 }
114 }
115 #endif
116 
A RollingPolicy is responsible for performing the rolling over of the active log file.
Definition: rollingpolicy.h:43
virtual RolloverDescriptionPtr initialize(const LogString &currentActiveFile, const bool append, log4cxx::helpers::Pool &pool)=0
virtual ~RollingPolicy()
Definition: rollingpolicy.h:47
RolloverDescriptionPtr rollover(const LogString &currentActiveFile, bool append)
Prepare for a rollover.
virtual RolloverDescriptionPtr rollover(const LogString &currentActiveFile, const bool append, log4cxx::helpers::Pool &pool)=0
RolloverDescriptionPtr initialize(const LogString &currentActiveFile, bool append)
Initialize the policy and return any initial actions for rolling file appender.
A string based interface to configure package components.
Definition: optionhandler.h:35
LOG4CXX_PTR_DEF(RollingPolicy)
std::basic_string< logchar > LogString
Definition: logstring.h:60
#define DECLARE_ABSTRACT_LOG4CXX_OBJECT(object)
Definition: object.h:37