<!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: TimeBasedRollingPolicy 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_time_based_rolling_policy.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> </div>
<div class="headertitle">
<h1>TimeBasedRollingPolicy Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="log4cxx::rolling::TimeBasedRollingPolicy" --><!-- doxytag: inherits="log4cxx::rolling::RollingPolicyBase,log4cxx::rolling::TriggeringPolicy" -->
<p><code><a class="el" href="classlog4cxx_1_1rolling_1_1_time_based_rolling_policy.html" title="TimeBasedRollingPolicy is both easy to configure and quite powerful.">TimeBasedRollingPolicy</a></code> is both easy to configure and quite powerful.
<a href="#_details">More...</a></p>
<p>Inherits <a class="el" href="classlog4cxx_1_1rolling_1_1_rolling_policy_base.html">log4cxx::rolling::RollingPolicyBase</a>, and <a class="el" href="classlog4cxx_1_1rolling_1_1_triggering_policy.html">log4cxx::rolling::TriggeringPolicy</a>.</p>
<p><a href="classlog4cxx_1_1rolling_1_1_time_based_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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1rolling_1_1_time_based_rolling_policy.html#a68ca594f6401c4dc56917002a2156967">TimeBasedRollingPolicy</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1rolling_1_1_time_based_rolling_policy.html#a0198815940c2715c84b0e04828cf8dfa">addRef</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1rolling_1_1_time_based_rolling_policy.html#a55c31efee1904916b999395fa4d46a24">releaseRef</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1rolling_1_1_time_based_rolling_policy.html#a580abdcb8fd42d07eaf679166f77bc34">activateOptions</a> (<a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> &)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Activate the options that were previously set with calls to option setters. <a href="#a580abdcb8fd42d07eaf679166f77bc34"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">RolloverDescriptionPtr </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1rolling_1_1_time_based_rolling_policy.html#ad4ac5703c681be358b76451b43be061b">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> &pool)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the policy and return any initial actions for rolling file appender. <a href="#ad4ac5703c681be358b76451b43be061b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">RolloverDescriptionPtr </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1rolling_1_1_time_based_rolling_policy.html#a5bb7ddc8d690804f8865f2c780e82706">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> &pool)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Prepare for a rollover. <a href="#a5bb7ddc8d690804f8865f2c780e82706"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1rolling_1_1_time_based_rolling_policy.html#ad1465d1456055bf68fc9c3a7416bb862">isTriggeringEvent</a> (<a class="el" href="classlog4cxx_1_1_appender.html">Appender</a> *appender, const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">log4cxx::spi::LoggingEventPtr</a> &event, const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &filename, size_t fileLength)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Determines if a rollover may be appropriate at this time. <a href="#ad1465d1456055bf68fc9c3a7416bb862"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacelog4cxx_1_1pattern.html#af3e2bcdd3fe2edd7071727492a4efa7d">log4cxx::pattern::PatternMap</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1rolling_1_1_time_based_rolling_policy.html#a3a480a46e679ec1f28872451b34d5727">getFormatSpecifiers</a> () const </td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p><code><a class="el" href="classlog4cxx_1_1rolling_1_1_time_based_rolling_policy.html" title="TimeBasedRollingPolicy is both easy to configure and quite powerful.">TimeBasedRollingPolicy</a></code> is both easy to configure and quite powerful. </p>
<p>In order to use <code><a class="el" href="classlog4cxx_1_1rolling_1_1_time_based_rolling_policy.html" title="TimeBasedRollingPolicy is both easy to configure and quite powerful.">TimeBasedRollingPolicy</a></code>, the <b>FileNamePattern</b> option must be set. It basically specifies the name of the rolled log files. The value <code>FileNamePattern</code> should consist of the name of the file, plus a suitably placed <code>d</code> conversion specifier. The <code>d</code> conversion specifier may contain a date and time pattern as specified by the <a class="el" href="classlog4cxx_1_1helpers_1_1_simple_date_format.html">log4cxx::helpers::SimpleDateFormat</a> class. If the date and time pattern is ommitted, then the default pattern of "yyyy-MM-dd" is assumed. The following examples should clarify the point.</p>
<table cellspacing="5px" border="1">
<tr>
<th><code>FileNamePattern</code> value </th><th>Rollover schedule </th><th>Example </th></tr>
<tr>
<td nowrap="true"><code>/wombat/folder/foo.d</code> </td><td>Daily rollover (at midnight). Due to the omission of the optional time and date pattern for the d token specifier, the default pattern of "yyyy-MM-dd" is assumed, which corresponds to daily rollover. </td><td>During November 23rd, 2004, logging output will go to the file <code>/wombat/foo.2004-11-23</code>. At midnight and for the rest of the 24th, logging output will be directed to <code>/wombat/foo.2004-11-24</code>. </td></tr>
<tr>
<td nowrap="true"><code>/wombat/foo.d{yyyy-MM}.log</code> </td><td>Rollover at the beginning of each month. </td><td>During the month of October 2004, logging output will go to <code>/wombat/foo.2004-10.log</code>. After midnight of October 31st and for the rest of November, logging output will be directed to <code>/wombat/foo.2004-11.log</code>. </td></tr>
</table>
<h2>Automatic file compression</h2>
<p><code><a class="el" href="classlog4cxx_1_1rolling_1_1_time_based_rolling_policy.html" title="TimeBasedRollingPolicy is both easy to configure and quite powerful.">TimeBasedRollingPolicy</a></code> supports automatic file compression. This feature is enabled if the value of the <b>FileNamePattern</b> option ends with <code>.gz</code> or <code>.zip</code>. </p>
<table cellspacing="5px" border="1">
<tr>
<th><code>FileNamePattern</code> value </th><th>Rollover schedule </th><th>Example </th></tr>
<tr>
<td nowrap="true"><code>/wombat/foo.d.gz</code> </td><td>Daily rollover (at midnight) with automatic GZIP compression of the arcived files. </td><td>During November 23rd, 2004, logging output will go to the file <code>/wombat/foo.2004-11-23</code>. However, at midnight that file will be compressed to become <code>/wombat/foo.2004-11-23.gz</code>. For the 24th of November, logging output will be directed to <code>/wombat/folder/foo.2004-11-24</code> until its rolled over at the beginning of the next day. </td></tr>
</table>
<h2>Decoupling the location of the active log file and the archived log files</h2>
<p>The <em>active file</em> is defined as the log file for the current period whereas <em>archived files</em> are thos files which have been rolled over in previous periods.</p>
<p>By setting the <b>ActiveFileName</b> option you can decouple the location of the active log file and the location of the archived log files. </p>
<table cellspacing="5px" border="1">
<tr>
<th><code>FileNamePattern</code> value </th><th>ActiveFileName </th><th>Rollover schedule </th><th>Example </th></tr>
<tr>
<td nowrap="true"><code>/wombat/foo.log.d</code> </td><td nowrap="true"><code>/wombat/foo.log</code> </td><td><p class="starttd">Daily rollover.</p>
<p class="endtd"></p>
</td><td>During November 23rd, 2004, logging output will go to the file <code>/wombat/foo.log</code>. However, at midnight that file will archived as <code>/wombat/foo.log.2004-11-23</code>. For the 24th of November, logging output will be directed to <code>/wombat/folder/foo.log</code> until its archived as <code>/wombat/foo.log.2004-11-24</code> at the beginning of the next day. </td></tr>
</table>
<p>If configuring programatically, do not forget to call <a class="el" href="classlog4cxx_1_1rolling_1_1_time_based_rolling_policy.html#a580abdcb8fd42d07eaf679166f77bc34">activateOptions</a> method before using this policy. Moreover, <a class="el" href="classlog4cxx_1_1rolling_1_1_time_based_rolling_policy.html#a580abdcb8fd42d07eaf679166f77bc34">activateOptions</a> of <code> <a class="el" href="classlog4cxx_1_1rolling_1_1_time_based_rolling_policy.html" title="TimeBasedRollingPolicy is both easy to configure and quite powerful.">TimeBasedRollingPolicy</a></code> must be called <em>before</em> calling the <a class="el" href="classlog4cxx_1_1rolling_1_1_time_based_rolling_policy.html#a580abdcb8fd42d07eaf679166f77bc34">activateOptions</a> method of the owning <code><a class="el" href="classlog4cxx_1_1rolling_1_1_rolling_file_appender.html" title="RollingFileAppender extends log4cxx::FileAppender to backup the log files depending on RollingPolicy ...">RollingFileAppender</a></code>. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a68ca594f6401c4dc56917002a2156967"></a><!-- doxytag: member="log4cxx::rolling::TimeBasedRollingPolicy::TimeBasedRollingPolicy" ref="a68ca594f6401c4dc56917002a2156967" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlog4cxx_1_1rolling_1_1_time_based_rolling_policy.html">TimeBasedRollingPolicy</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a580abdcb8fd42d07eaf679166f77bc34"></a><!-- doxytag: member="log4cxx::rolling::TimeBasedRollingPolicy::activateOptions" ref="a580abdcb8fd42d07eaf679166f77bc34" args="(log4cxx::helpers::Pool &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void activateOptions </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><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Activate the options that were previously set with calls to option setters. </p>
<p>This allows to defer activiation of the options until all options have been set. This is required for components which have related options that remain ambigous until all are set.</p>
<p>For example, the <a class="el" href="classlog4cxx_1_1_file_appender.html" title="FileAppender appends log events to a file.">FileAppender</a> has the <a class="el" href="classlog4cxx_1_1_file_appender.html#a6a6c98222ccf2072dad5a434f9336930">File</a> and <a class="el" href="classlog4cxx_1_1_file_appender.html#a78ebca211ceb3a0b2960a48092089906">Append</a> options both of which are ambigous until the other is also set. </p>
<p>Implements <a class="el" href="classlog4cxx_1_1rolling_1_1_rolling_policy_base.html#af04d4bfbd66b46083b1aa042fdafbb06">RollingPolicyBase</a>.</p>
</div>
</div>
<a class="anchor" id="a0198815940c2715c84b0e04828cf8dfa"></a><!-- doxytag: member="log4cxx::rolling::TimeBasedRollingPolicy::addRef" ref="a0198815940c2715c84b0e04828cf8dfa" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void addRef </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented from <a class="el" href="classlog4cxx_1_1rolling_1_1_rolling_policy_base.html#a0198815940c2715c84b0e04828cf8dfa">RollingPolicyBase</a>.</p>
</div>
</div>
<a class="anchor" id="a3a480a46e679ec1f28872451b34d5727"></a><!-- doxytag: member="log4cxx::rolling::TimeBasedRollingPolicy::getFormatSpecifiers" ref="a3a480a46e679ec1f28872451b34d5727" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacelog4cxx_1_1pattern.html#af3e2bcdd3fe2edd7071727492a4efa7d">log4cxx::pattern::PatternMap</a> getFormatSpecifiers </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Implements <a class="el" href="classlog4cxx_1_1rolling_1_1_rolling_policy_base.html#abbd1d9f66dd437e9e0c7afa027577373">RollingPolicyBase</a>.</p>
</div>
</div>
<a class="anchor" id="ad4ac5703c681be358b76451b43be061b"></a><!-- doxytag: member="log4cxx::rolling::TimeBasedRollingPolicy::initialize" ref="ad4ac5703c681be358b76451b43be061b" args="(const LogString &file, const bool append, log4cxx::helpers::Pool &pool)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">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>pool</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [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">pool</td><td>pool for any required allocations. </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>Implements <a class="el" href="classlog4cxx_1_1rolling_1_1_rolling_policy.html#a4634e26c0c4a14ee56944460d31f973c">RollingPolicy</a>.</p>
</div>
</div>
<a class="anchor" id="ad1465d1456055bf68fc9c3a7416bb862"></a><!-- doxytag: member="log4cxx::rolling::TimeBasedRollingPolicy::isTriggeringEvent" ref="ad1465d1456055bf68fc9c3a7416bb862" args="(Appender *appender, const log4cxx::spi::LoggingEventPtr &event, const LogString &filename, size_t fileLength)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool isTriggeringEvent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classlog4cxx_1_1_appender.html">Appender</a> * </td>
<td class="paramname"><em>appender</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">log4cxx::spi::LoggingEventPtr</a> & </td>
<td class="paramname"><em>event</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>fileLength</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Determines if a rollover may be appropriate at this time. </p>
<p>If true is returned, RolloverPolicy.rollover will be called but it can determine that a rollover is not warranted.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">appender</td><td>A reference to the appender. </td></tr>
<tr><td class="paramname">event</td><td>A reference to the currently event. </td></tr>
<tr><td class="paramname">filename</td><td>The filename for the currently active log file. </td></tr>
<tr><td class="paramname">fileLength</td><td>Length of the file in bytes. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if a rollover should occur. </dd></dl>
<p>Implements <a class="el" href="classlog4cxx_1_1rolling_1_1_triggering_policy.html#aa5300801d20e51d71952b221872458ec">TriggeringPolicy</a>.</p>
</div>
</div>
<a class="anchor" id="a55c31efee1904916b999395fa4d46a24"></a><!-- doxytag: member="log4cxx::rolling::TimeBasedRollingPolicy::releaseRef" ref="a55c31efee1904916b999395fa4d46a24" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void releaseRef </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented from <a class="el" href="classlog4cxx_1_1rolling_1_1_rolling_policy_base.html#a55c31efee1904916b999395fa4d46a24">RollingPolicyBase</a>.</p>
</div>
</div>
<a class="anchor" id="a5bb7ddc8d690804f8865f2c780e82706"></a><!-- doxytag: member="log4cxx::rolling::TimeBasedRollingPolicy::rollover" ref="a5bb7ddc8d690804f8865f2c780e82706" args="(const LogString &activeFile, log4cxx::helpers::Pool &pool)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">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>pool</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [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">pool</td><td>pool for any required allocations. </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>Implements <a class="el" href="classlog4cxx_1_1rolling_1_1_rolling_policy.html#a2d1f466b08f4b4fe3f30ef00be9e0fbf">RollingPolicy</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="timebasedrollingpolicy_8h.html">timebasedrollingpolicy.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_time_based_rolling_policy.html">TimeBasedRollingPolicy</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>
