Apache Log4cxx  Version 1.1.0
timebasedrollingpolicy.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 
19 #if !defined(_LOG4CXX_ROLLING_TIME_BASED_ROLLING_POLICY_H)
20 #define _LOG4CXX_ROLLING_TIME_BASED_ROLLING_POLICY_H
21 
24 #include <log4cxx/writerappender.h>
26 #include <functional>
27 
28 namespace log4cxx
29 {
30 
31 namespace rolling
32 {
33 
34 
35 
140 class LOG4CXX_EXPORT TimeBasedRollingPolicy : public virtual RollingPolicyBase,
141  public virtual TriggeringPolicy
142 {
149 
150  private:
151  LOG4CXX_DECLARE_PRIVATE_MEMBER_PTR(TimeBasedRollingPolicyPrivate, m_priv)
152 
153  public:
156  void activateOptions(helpers::Pool& ) override;
157 
158  void setMultiprocess(bool multiprocess);
159 
163  RolloverDescriptionPtr initialize(
164  const LogString& currentActiveFile,
165  const bool append,
166  helpers::Pool& pool) override;
167 
171  RolloverDescriptionPtr rollover(
172  const LogString& currentActiveFile,
173  const bool append,
174  helpers::Pool& pool) override;
175 
188  Appender* appender,
189  const spi::LoggingEventPtr& event,
190  const LogString& filename,
191  size_t fileLength) override;
192 
193  void setOption(const LogString& option, const LogString& value) override;
194 
195  protected:
197 
198  private:
199 
203  int createMMapFile(const std::string& lastfilename, log4cxx::helpers::Pool& pool);
204 
208  bool isMapFileEmpty(log4cxx::helpers::Pool& pool);
209 
213  void initMMapFile(const LogString& lastFileName, log4cxx::helpers::Pool& pool);
214 
218  int lockMMapFile(int type);
219 
223  int unLockMMapFile();
224 
228  const std::string createFile(const std::string& filename, const std::string& suffix, log4cxx::helpers::Pool& pool);
229 
230 };
231 
233 
234 }
235 }
236 
237 #endif
238 
Implement this interface for your own strategies for outputting log statements.
Definition: appender.h:51
Definition: pool.h:33
Implements methods common to most, it not all, rolling policies.
Definition: rollingpolicybase.h:46
TimeBasedRollingPolicy is both easy to configure and quite powerful.
Definition: timebasedrollingpolicy.h:142
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 activateOptions(helpers::Pool &) override
Activate the options that were previously set with calls to option setters.
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,...
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...
void setOption(const LogString &option, const LogString &value) override
Set option to value.
log4cxx::pattern::PatternMap getFormatSpecifiers() const override
void setMultiprocess(bool multiprocess)
A TriggeringPolicy controls the conditions under which rollover occurs.
Definition: triggeringpolicy.h:47
std::map< LogString, PatternConstructor > PatternMap
Definition: patternparser.h:35
LOG4CXX_PTR_DEF(Action)
std::shared_ptr< LoggingEvent > LoggingEventPtr
Definition: appender.h:31
Definition: appender.h:27
std::basic_string< logchar > LogString
Definition: logstring.h:60
#define LOG4CXX_CAST_ENTRY(Interface)
Definition: object.h:157
#define END_LOG4CXX_CAST_MAP()
Definition: object.h:151
#define DECLARE_LOG4CXX_OBJECT(object)
Definition: object.h:42
#define LOG4CXX_CAST_ENTRY_CHAIN(Interface)
Definition: object.h:163
#define BEGIN_LOG4CXX_CAST_MAP()
Definition: object.h:145