<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Apache log4cxx: RollingPolicy Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Apache log4cxx <span id="projectnumber">Version 0.10.0</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('classlog4cxx_1_1rolling_1_1_rolling_policy.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<h1>RollingPolicy Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="log4cxx::rolling::RollingPolicy" --><!-- doxytag: inherits="log4cxx::spi::OptionHandler" -->
<p>A <code><a class="el" href="classlog4cxx_1_1rolling_1_1_rolling_policy.html" title="A RollingPolicy is responsible for performing the rolling over of the active log file.">RollingPolicy</a></code> is responsible for performing the rolling over of the active log file.
<a href="#_details">More...</a></p>
<p>Inherits <a class="el" href="classlog4cxx_1_1spi_1_1_option_handler.html">log4cxx::spi::OptionHandler</a>.</p>
<p>Inherited by <a class="el" href="classlog4cxx_1_1rolling_1_1_rolling_policy_base.html">RollingPolicyBase</a><code> [virtual]</code>.</p>
<p><a href="classlog4cxx_1_1rolling_1_1_rolling_policy-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1rolling_1_1_rolling_policy.html#acb9e68fc547611326b9eed13793b4263">~RollingPolicy</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual RolloverDescriptionPtr </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1rolling_1_1_rolling_policy.html#a4634e26c0c4a14ee56944460d31f973c">initialize</a> (const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &file, const bool append, <a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> &p)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the policy and return any initial actions for rolling file appender. <a href="#a4634e26c0c4a14ee56944460d31f973c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual RolloverDescriptionPtr </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1rolling_1_1_rolling_policy.html#a2d1f466b08f4b4fe3f30ef00be9e0fbf">rollover</a> (const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &activeFile, <a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> &p)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Prepare for a rollover. <a href="#a2d1f466b08f4b4fe3f30ef00be9e0fbf"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A <code><a class="el" href="classlog4cxx_1_1rolling_1_1_rolling_policy.html" title="A RollingPolicy is responsible for performing the rolling over of the active log file.">RollingPolicy</a></code> is responsible for performing the rolling over of the active log file. </p>
<p>The <code><a class="el" href="classlog4cxx_1_1rolling_1_1_rolling_policy.html" title="A RollingPolicy is responsible for performing the rolling over of the active log file.">RollingPolicy</a></code> is also responsible for providing the <em>active log file</em>, that is the live file where logging output will be directed. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="acb9e68fc547611326b9eed13793b4263"></a><!-- doxytag: member="log4cxx::rolling::RollingPolicy::~RollingPolicy" ref="acb9e68fc547611326b9eed13793b4263" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ~<a class="el" href="classlog4cxx_1_1rolling_1_1_rolling_policy.html">RollingPolicy</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a4634e26c0c4a14ee56944460d31f973c"></a><!-- doxytag: member="log4cxx::rolling::RollingPolicy::initialize" ref="a4634e26c0c4a14ee56944460d31f973c" args="(const LogString &file, const bool append, log4cxx::helpers::Pool &p)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual RolloverDescriptionPtr initialize </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>file</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const bool </td>
<td class="paramname"><em>append</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> & </td>
<td class="paramname"><em>p</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Initialize the policy and return any initial actions for rolling file appender. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">file</td><td>current value of <a class="el" href="classlog4cxx_1_1_file_appender.html#afdf1897af9ae5c70308224d3a7d8f339" title="Returns the value of the File option.">RollingFileAppender.getFile()</a>. </td></tr>
<tr><td class="paramname">append</td><td>current value of <a class="el" href="classlog4cxx_1_1_file_appender.html#af8cb171146140874fb651ca95e142805" title="Returns the value of the Append option.">RollingFileAppender.getAppend()</a>. </td></tr>
<tr><td class="paramname">p</td><td>pool for memory allocations during call. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Description of the initialization, may be null to indicate no initialization needed. </dd></dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname">SecurityException</td><td>if denied access to log files. </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classlog4cxx_1_1rolling_1_1_fixed_window_rolling_policy.html#a890d58242c6f1cea8d42ad5f5534fde4">FixedWindowRollingPolicy</a>, and <a class="el" href="classlog4cxx_1_1rolling_1_1_time_based_rolling_policy.html#ad4ac5703c681be358b76451b43be061b">TimeBasedRollingPolicy</a>.</p>
</div>
</div>
<a class="anchor" id="a2d1f466b08f4b4fe3f30ef00be9e0fbf"></a><!-- doxytag: member="log4cxx::rolling::RollingPolicy::rollover" ref="a2d1f466b08f4b4fe3f30ef00be9e0fbf" args="(const LogString &activeFile, log4cxx::helpers::Pool &p)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual RolloverDescriptionPtr rollover </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>activeFile</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> & </td>
<td class="paramname"><em>p</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Prepare for a rollover. </p>
<p>This method is called prior to closing the active log file, performs any necessary preliminary actions and describes actions needed after close of current log file.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">activeFile</td><td>file name for current active log file. </td></tr>
<tr><td class="paramname">p</td><td>pool for memory allocations during call. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Description of pending rollover, may be null to indicate no rollover at this time. </dd></dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname">SecurityException</td><td>if denied access to log files. </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classlog4cxx_1_1rolling_1_1_fixed_window_rolling_policy.html#a0f4f5dd5276500e278b94ea68554d600">FixedWindowRollingPolicy</a>, and <a class="el" href="classlog4cxx_1_1rolling_1_1_time_based_rolling_policy.html#a5bb7ddc8d690804f8865f2c780e82706">TimeBasedRollingPolicy</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="rollingpolicy_8h.html">rollingpolicy.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacelog4cxx.html">log4cxx</a> </li>
<li class="navelem"><a class="el" href="namespacelog4cxx_1_1rolling.html">rolling</a> </li>
<li class="navelem"><a class="el" href="classlog4cxx_1_1rolling_1_1_rolling_policy.html">RollingPolicy</a> </li>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
</BODY>
</HTML>
