blob: 0301099f554bac748b80c16e0a2327feb25d1d37 [file] [log] [blame]
<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>Apache log4cxx: TimeBasedRollingPolicy Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname"><a href="http://logging.apache.org/log4cxx">Apache log4cxx</a>
&#160;<span id="projectnumber">Version 0.10.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;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>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classlog4cxx_1_1rolling_1_1_time_based_rolling_policy.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="classlog4cxx_1_1rolling_1_1_time_based_rolling_policy-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">TimeBasedRollingPolicy Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<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="classlog4cxx_1_1rolling_1_1_time_based_rolling_policy.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for TimeBasedRollingPolicy:</div>
<div class="dyncontent">
<div class="center">
<img src="classlog4cxx_1_1rolling_1_1_time_based_rolling_policy.png" usemap="#TimeBasedRollingPolicy_map" alt=""/>
<map id="TimeBasedRollingPolicy_map" name="TimeBasedRollingPolicy_map">
<area href="classlog4cxx_1_1rolling_1_1_rolling_policy_base.html" title="Implements methods common to most, it not all, rolling policies. " alt="RollingPolicyBase" shape="rect" coords="78,168,224,192"/>
<area href="classlog4cxx_1_1rolling_1_1_triggering_policy.html" title="A TriggeringPolicy controls the conditions under which rollover occurs. " alt="TriggeringPolicy" shape="rect" coords="390,168,536,192"/>
<area href="classlog4cxx_1_1rolling_1_1_rolling_policy.html" title="A RollingPolicy is responsible for performing the rolling over of the active log file. " alt="RollingPolicy" shape="rect" coords="0,112,146,136"/>
<area href="classlog4cxx_1_1helpers_1_1_object_impl.html" title="Implementation class for Object. " alt="ObjectImpl" shape="rect" coords="156,112,302,136"/>
<area href="classlog4cxx_1_1spi_1_1_option_handler.html" title="A string based interface to configure package components. " alt="OptionHandler" shape="rect" coords="312,112,458,136"/>
<area href="classlog4cxx_1_1helpers_1_1_object_impl.html" title="Implementation class for Object. " alt="ObjectImpl" shape="rect" coords="468,112,614,136"/>
<area href="classlog4cxx_1_1spi_1_1_option_handler.html" title="A string based interface to configure package components. " alt="OptionHandler" shape="rect" coords="0,56,146,80"/>
<area href="classlog4cxx_1_1helpers_1_1_object.html" title="base class for java-like objects. " alt="Object" shape="rect" coords="156,56,302,80"/>
<area href="classlog4cxx_1_1helpers_1_1_object.html" title="base class for java-like objects. " alt="Object" shape="rect" coords="312,56,458,80"/>
<area href="classlog4cxx_1_1helpers_1_1_object.html" title="base class for java-like objects. " alt="Object" shape="rect" coords="468,56,614,80"/>
<area href="classlog4cxx_1_1helpers_1_1_object.html" title="base class for java-like objects. " alt="Object" shape="rect" coords="0,0,146,24"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a68ca594f6401c4dc56917002a2156967"><td class="memItemLeft" align="right" valign="top">&#160;</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 class="separator:a68ca594f6401c4dc56917002a2156967"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0198815940c2715c84b0e04828cf8dfa"><td class="memItemLeft" align="right" valign="top">void&#160;</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 class="separator:a0198815940c2715c84b0e04828cf8dfa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a55c31efee1904916b999395fa4d46a24"><td class="memItemLeft" align="right" valign="top">void&#160;</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 class="separator:a55c31efee1904916b999395fa4d46a24"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a580abdcb8fd42d07eaf679166f77bc34"><td class="memItemLeft" align="right" valign="top">void&#160;</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> &amp;)</td></tr>
<tr class="memdesc:a580abdcb8fd42d07eaf679166f77bc34"><td class="mdescLeft">&#160;</td><td class="mdescRight">Activate the options that were previously set with calls to option setters. <a href="#a580abdcb8fd42d07eaf679166f77bc34">More...</a><br /></td></tr>
<tr class="separator:a580abdcb8fd42d07eaf679166f77bc34"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad4ac5703c681be358b76451b43be061b"><td class="memItemLeft" align="right" valign="top">RolloverDescriptionPtr&#160;</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> &amp;file, const bool append, <a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> &amp;pool)</td></tr>
<tr class="memdesc:ad4ac5703c681be358b76451b43be061b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the policy and return any initial actions for rolling file appender. <a href="#ad4ac5703c681be358b76451b43be061b">More...</a><br /></td></tr>
<tr class="separator:ad4ac5703c681be358b76451b43be061b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5bb7ddc8d690804f8865f2c780e82706"><td class="memItemLeft" align="right" valign="top">RolloverDescriptionPtr&#160;</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> &amp;activeFile, <a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> &amp;pool)</td></tr>
<tr class="memdesc:a5bb7ddc8d690804f8865f2c780e82706"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prepare for a rollover. <a href="#a5bb7ddc8d690804f8865f2c780e82706">More...</a><br /></td></tr>
<tr class="separator:a5bb7ddc8d690804f8865f2c780e82706"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad1465d1456055bf68fc9c3a7416bb862"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</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="namespacelog4cxx_1_1spi.html#ab5abd68f0fb303c6d5f5f7d1ff49b3a6">log4cxx::spi::LoggingEventPtr</a> &amp;event, const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &amp;filename, size_t fileLength)</td></tr>
<tr class="memdesc:ad1465d1456055bf68fc9c3a7416bb862"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determines if a rollover may be appropriate at this time. <a href="#ad1465d1456055bf68fc9c3a7416bb862">More...</a><br /></td></tr>
<tr class="separator:ad1465d1456055bf68fc9c3a7416bb862"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classlog4cxx_1_1rolling_1_1_rolling_policy_base"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classlog4cxx_1_1rolling_1_1_rolling_policy_base')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classlog4cxx_1_1rolling_1_1_rolling_policy_base.html">RollingPolicyBase</a></td></tr>
<tr class="memitem:ad8c6cf0dca966d322d6ea3da2d435680 inherit pub_methods_classlog4cxx_1_1rolling_1_1_rolling_policy_base"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1rolling_1_1_rolling_policy_base.html#ad8c6cf0dca966d322d6ea3da2d435680">RollingPolicyBase</a> ()</td></tr>
<tr class="separator:ad8c6cf0dca966d322d6ea3da2d435680 inherit pub_methods_classlog4cxx_1_1rolling_1_1_rolling_policy_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8baf39c09c013e97dafd816887cb7c02 inherit pub_methods_classlog4cxx_1_1rolling_1_1_rolling_policy_base"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1rolling_1_1_rolling_policy_base.html#a8baf39c09c013e97dafd816887cb7c02">~RollingPolicyBase</a> ()</td></tr>
<tr class="separator:a8baf39c09c013e97dafd816887cb7c02 inherit pub_methods_classlog4cxx_1_1rolling_1_1_rolling_policy_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aee5023c29cca9dc68164b22a01cb7c6e inherit pub_methods_classlog4cxx_1_1rolling_1_1_rolling_policy_base"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1rolling_1_1_rolling_policy_base.html#aee5023c29cca9dc68164b22a01cb7c6e">setOption</a> (const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &amp;option, const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &amp;value)</td></tr>
<tr class="memdesc:aee5023c29cca9dc68164b22a01cb7c6e inherit pub_methods_classlog4cxx_1_1rolling_1_1_rolling_policy_base"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set <code>option</code> to <code>value</code>. <a href="#aee5023c29cca9dc68164b22a01cb7c6e">More...</a><br /></td></tr>
<tr class="separator:aee5023c29cca9dc68164b22a01cb7c6e inherit pub_methods_classlog4cxx_1_1rolling_1_1_rolling_policy_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:affe8d437262494f823891f9b8294bd24 inherit pub_methods_classlog4cxx_1_1rolling_1_1_rolling_policy_base"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1rolling_1_1_rolling_policy_base.html#affe8d437262494f823891f9b8294bd24">setFileNamePattern</a> (const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &amp;fnp)</td></tr>
<tr class="memdesc:affe8d437262494f823891f9b8294bd24 inherit pub_methods_classlog4cxx_1_1rolling_1_1_rolling_policy_base"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set file name pattern. <a href="#affe8d437262494f823891f9b8294bd24">More...</a><br /></td></tr>
<tr class="separator:affe8d437262494f823891f9b8294bd24 inherit pub_methods_classlog4cxx_1_1rolling_1_1_rolling_policy_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a60a10357260cb911783da4b3f3e80555 inherit pub_methods_classlog4cxx_1_1rolling_1_1_rolling_policy_base"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1rolling_1_1_rolling_policy_base.html#a60a10357260cb911783da4b3f3e80555">getFileNamePattern</a> () const </td></tr>
<tr class="memdesc:a60a10357260cb911783da4b3f3e80555 inherit pub_methods_classlog4cxx_1_1rolling_1_1_rolling_policy_base"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get file name pattern. <a href="#a60a10357260cb911783da4b3f3e80555">More...</a><br /></td></tr>
<tr class="separator:a60a10357260cb911783da4b3f3e80555 inherit pub_methods_classlog4cxx_1_1rolling_1_1_rolling_policy_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classlog4cxx_1_1rolling_1_1_rolling_policy"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classlog4cxx_1_1rolling_1_1_rolling_policy')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classlog4cxx_1_1rolling_1_1_rolling_policy.html">RollingPolicy</a></td></tr>
<tr class="memitem:acb9e68fc547611326b9eed13793b4263 inherit pub_methods_classlog4cxx_1_1rolling_1_1_rolling_policy"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1rolling_1_1_rolling_policy.html#acb9e68fc547611326b9eed13793b4263">~RollingPolicy</a> ()</td></tr>
<tr class="separator:acb9e68fc547611326b9eed13793b4263 inherit pub_methods_classlog4cxx_1_1rolling_1_1_rolling_policy"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classlog4cxx_1_1spi_1_1_option_handler"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classlog4cxx_1_1spi_1_1_option_handler')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classlog4cxx_1_1spi_1_1_option_handler.html">OptionHandler</a></td></tr>
<tr class="memitem:ad773ac49843844af53fe553912ed63e5 inherit pub_methods_classlog4cxx_1_1spi_1_1_option_handler"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1spi_1_1_option_handler.html#ad773ac49843844af53fe553912ed63e5">~OptionHandler</a> ()</td></tr>
<tr class="separator:ad773ac49843844af53fe553912ed63e5 inherit pub_methods_classlog4cxx_1_1spi_1_1_option_handler"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classlog4cxx_1_1helpers_1_1_object"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classlog4cxx_1_1helpers_1_1_object')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classlog4cxx_1_1helpers_1_1_object.html">Object</a></td></tr>
<tr class="memitem:ae7b62e37794f297c0cede40ed0e84fcd inherit pub_methods_classlog4cxx_1_1helpers_1_1_object"><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="classlog4cxx_1_1helpers_1_1_class.html">helpers::Class</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_object.html#ae7b62e37794f297c0cede40ed0e84fcd">getClass</a> () const </td></tr>
<tr class="separator:ae7b62e37794f297c0cede40ed0e84fcd inherit pub_methods_classlog4cxx_1_1helpers_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab5cc4f9ba1ea5c2f25bc4b1f0dac5dc5 inherit pub_methods_classlog4cxx_1_1helpers_1_1_object"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_object.html#ab5cc4f9ba1ea5c2f25bc4b1f0dac5dc5">~Object</a> ()</td></tr>
<tr class="separator:ab5cc4f9ba1ea5c2f25bc4b1f0dac5dc5 inherit pub_methods_classlog4cxx_1_1helpers_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0ab1bb19059c1de23f8a35cdbc0b6a5c inherit pub_methods_classlog4cxx_1_1helpers_1_1_object"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_object.html#a0ab1bb19059c1de23f8a35cdbc0b6a5c">instanceof</a> (const <a class="el" href="classlog4cxx_1_1helpers_1_1_class.html">Class</a> &amp;clazz) const =0</td></tr>
<tr class="separator:a0ab1bb19059c1de23f8a35cdbc0b6a5c inherit pub_methods_classlog4cxx_1_1helpers_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a04b3422e17b0a882538bbc99833ab9df inherit pub_methods_classlog4cxx_1_1helpers_1_1_object"><td class="memItemLeft" align="right" valign="top">virtual const void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_object.html#a04b3422e17b0a882538bbc99833ab9df">cast</a> (const <a class="el" href="classlog4cxx_1_1helpers_1_1_class.html">Class</a> &amp;clazz) const =0</td></tr>
<tr class="separator:a04b3422e17b0a882538bbc99833ab9df inherit pub_methods_classlog4cxx_1_1helpers_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classlog4cxx_1_1helpers_1_1_object_impl"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classlog4cxx_1_1helpers_1_1_object_impl')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classlog4cxx_1_1helpers_1_1_object_impl.html">ObjectImpl</a></td></tr>
<tr class="memitem:a5e6e9fc30dc1f098fee72d516ea0bad0 inherit pub_methods_classlog4cxx_1_1helpers_1_1_object_impl"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_object_impl.html#a5e6e9fc30dc1f098fee72d516ea0bad0">ObjectImpl</a> ()</td></tr>
<tr class="separator:a5e6e9fc30dc1f098fee72d516ea0bad0 inherit pub_methods_classlog4cxx_1_1helpers_1_1_object_impl"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abb974728bb3cb991285140c1aa57eed7 inherit pub_methods_classlog4cxx_1_1helpers_1_1_object_impl"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_object_impl.html#abb974728bb3cb991285140c1aa57eed7">~ObjectImpl</a> ()</td></tr>
<tr class="separator:abb974728bb3cb991285140c1aa57eed7 inherit pub_methods_classlog4cxx_1_1helpers_1_1_object_impl"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classlog4cxx_1_1rolling_1_1_triggering_policy"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classlog4cxx_1_1rolling_1_1_triggering_policy')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classlog4cxx_1_1rolling_1_1_triggering_policy.html">TriggeringPolicy</a></td></tr>
<tr class="memitem:a2a10a93bd44a9b87f3d7356c1d3aea68 inherit pub_methods_classlog4cxx_1_1rolling_1_1_triggering_policy"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1rolling_1_1_triggering_policy.html#a2a10a93bd44a9b87f3d7356c1d3aea68">~TriggeringPolicy</a> ()</td></tr>
<tr class="separator:a2a10a93bd44a9b87f3d7356c1d3aea68 inherit pub_methods_classlog4cxx_1_1rolling_1_1_triggering_policy"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0198815940c2715c84b0e04828cf8dfa inherit pub_methods_classlog4cxx_1_1rolling_1_1_triggering_policy"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1rolling_1_1_triggering_policy.html#a0198815940c2715c84b0e04828cf8dfa">addRef</a> () const </td></tr>
<tr class="separator:a0198815940c2715c84b0e04828cf8dfa inherit pub_methods_classlog4cxx_1_1rolling_1_1_triggering_policy"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a55c31efee1904916b999395fa4d46a24 inherit pub_methods_classlog4cxx_1_1rolling_1_1_triggering_policy"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1rolling_1_1_triggering_policy.html#a55c31efee1904916b999395fa4d46a24">releaseRef</a> () const </td></tr>
<tr class="separator:a55c31efee1904916b999395fa4d46a24 inherit pub_methods_classlog4cxx_1_1rolling_1_1_triggering_policy"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a3a480a46e679ec1f28872451b34d5727"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacelog4cxx_1_1pattern.html#af3e2bcdd3fe2edd7071727492a4efa7d">log4cxx::pattern::PatternMap</a>&#160;</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>
<tr class="separator:a3a480a46e679ec1f28872451b34d5727"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_methods_classlog4cxx_1_1rolling_1_1_rolling_policy_base"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classlog4cxx_1_1rolling_1_1_rolling_policy_base')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classlog4cxx_1_1rolling_1_1_rolling_policy_base.html">RollingPolicyBase</a></td></tr>
<tr class="memitem:a9f299b192cd28319c3e5650c8a1ba43b inherit pro_methods_classlog4cxx_1_1rolling_1_1_rolling_policy_base"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1rolling_1_1_rolling_policy_base.html#a9f299b192cd28319c3e5650c8a1ba43b">parseFileNamePattern</a> ()</td></tr>
<tr class="memdesc:a9f299b192cd28319c3e5650c8a1ba43b inherit pro_methods_classlog4cxx_1_1rolling_1_1_rolling_policy_base"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parse file name pattern. <a href="#a9f299b192cd28319c3e5650c8a1ba43b">More...</a><br /></td></tr>
<tr class="separator:a9f299b192cd28319c3e5650c8a1ba43b inherit pro_methods_classlog4cxx_1_1rolling_1_1_rolling_policy_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af91dd666c03237cc3f78e671490708ac inherit pro_methods_classlog4cxx_1_1rolling_1_1_rolling_policy_base"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1rolling_1_1_rolling_policy_base.html#af91dd666c03237cc3f78e671490708ac">formatFileName</a> (<a class="el" href="namespacelog4cxx_1_1helpers.html#aa808d0071a7cbb3a7e9214ee261c844a">log4cxx::helpers::ObjectPtr</a> &amp;obj, <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &amp;buf, <a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> &amp;p) const </td></tr>
<tr class="memdesc:af91dd666c03237cc3f78e671490708ac inherit pro_methods_classlog4cxx_1_1rolling_1_1_rolling_policy_base"><td class="mdescLeft">&#160;</td><td class="mdescRight">Format file name. <a href="#af91dd666c03237cc3f78e671490708ac">More...</a><br /></td></tr>
<tr class="separator:af91dd666c03237cc3f78e671490708ac inherit pro_methods_classlog4cxx_1_1rolling_1_1_rolling_policy_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af1b7cc9714ddee3a9f347c96b9df11b8 inherit pro_methods_classlog4cxx_1_1rolling_1_1_rolling_policy_base"><td class="memItemLeft" align="right" valign="top">log4cxx::pattern::PatternConverterPtr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1rolling_1_1_rolling_policy_base.html#af1b7cc9714ddee3a9f347c96b9df11b8">getIntegerPatternConverter</a> () const </td></tr>
<tr class="separator:af1b7cc9714ddee3a9f347c96b9df11b8 inherit pro_methods_classlog4cxx_1_1rolling_1_1_rolling_policy_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae6228e209002566500dbf3c3d9dde5cb inherit pro_methods_classlog4cxx_1_1rolling_1_1_rolling_policy_base"><td class="memItemLeft" align="right" valign="top">log4cxx::pattern::PatternConverterPtr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1rolling_1_1_rolling_policy_base.html#ae6228e209002566500dbf3c3d9dde5cb">getDatePatternConverter</a> () const </td></tr>
<tr class="separator:ae6228e209002566500dbf3c3d9dde5cb inherit pro_methods_classlog4cxx_1_1rolling_1_1_rolling_policy_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_static_methods_classlog4cxx_1_1helpers_1_1_object"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_classlog4cxx_1_1helpers_1_1_object')"><img src="closed.png" alt="-"/>&#160;Static Public Member Functions inherited from <a class="el" href="classlog4cxx_1_1helpers_1_1_object.html">Object</a></td></tr>
<tr class="memitem:a0bdbda4effe8938c1aca6d4397e5a39d inherit pub_static_methods_classlog4cxx_1_1helpers_1_1_object"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classlog4cxx_1_1helpers_1_1_class.html">helpers::Class</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_object.html#a0bdbda4effe8938c1aca6d4397e5a39d">getStaticClass</a> ()</td></tr>
<tr class="separator:a0bdbda4effe8938c1aca6d4397e5a39d inherit pub_static_methods_classlog4cxx_1_1helpers_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a50ec9288d0b7e3140dee8e24ee74a212 inherit pub_static_methods_classlog4cxx_1_1helpers_1_1_object"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classlog4cxx_1_1helpers_1_1_class_registration.html">log4cxx::helpers::ClassRegistration</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_object.html#a50ec9288d0b7e3140dee8e24ee74a212">registerClass</a> ()</td></tr>
<tr class="separator:a50ec9288d0b7e3140dee8e24ee74a212 inherit pub_static_methods_classlog4cxx_1_1helpers_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_attribs_classlog4cxx_1_1helpers_1_1_object_impl"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classlog4cxx_1_1helpers_1_1_object_impl')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="classlog4cxx_1_1helpers_1_1_object_impl.html">ObjectImpl</a></td></tr>
<tr class="memitem:a88f2ae00c84f3f309965e6588ed158d4 inherit pro_attribs_classlog4cxx_1_1helpers_1_1_object_impl"><td class="memItemLeft" align="right" valign="top">unsigned int volatile&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_object_impl.html#a88f2ae00c84f3f309965e6588ed158d4">ref</a></td></tr>
<tr class="separator:a88f2ae00c84f3f309965e6588ed158d4 inherit pro_attribs_classlog4cxx_1_1helpers_1_1_object_impl"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">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><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a68ca594f6401c4dc56917002a2156967"></a>
<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>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a580abdcb8fd42d07eaf679166f77bc34"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<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> &amp;&#160;</td>
<td class="paramname"><em>p</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </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>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void addRef </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </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>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<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</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="classlog4cxx_1_1rolling_1_1_rolling_policy_base.html#a5100603a2fbc03b25b73bdeea532c45b">RollingPolicyBase</a>.</p>
</div>
</div>
<a class="anchor" id="ad4ac5703c681be358b76451b43be061b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<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> &amp;&#160;</td>
<td class="paramname"><em>file</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const bool&#160;</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> &amp;&#160;</td>
<td class="paramname"><em>pool</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize the policy and return any initial actions for rolling file appender. </p>
<dl class="params"><dt>Parameters</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="section return"><dt>Returns</dt><dd>Description of the initialization, may be null to indicate no initialization needed. </dd></dl>
<dl class="exception"><dt>Exceptions</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>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<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> *&#160;</td>
<td class="paramname"><em>appender</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx_1_1spi.html#ab5abd68f0fb303c6d5f5f7d1ff49b3a6">log4cxx::spi::LoggingEventPtr</a> &amp;&#160;</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> &amp;&#160;</td>
<td class="paramname"><em>filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>fileLength</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </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 class="params"><dt>Parameters</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="section return"><dt>Returns</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>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void releaseRef </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </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>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<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> &amp;&#160;</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> &amp;&#160;</td>
<td class="paramname"><em>pool</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </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 class="params"><dt>Parameters</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="section return"><dt>Returns</dt><dd>Description of pending rollover, may be null to indicate no rollover at this time. </dd></dl>
<dl class="exception"><dt>Exceptions</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><!-- contents -->
</div><!-- doc-content -->
<!--
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>