| <!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: FixedWindowRollingPolicy 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> |
|  <span id="projectnumber">Version 0.11.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 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 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><!-- 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_fixed_window_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> | |
| <a href="#pro-methods">Protected Member Functions</a> | |
| <a href="classlog4cxx_1_1rolling_1_1_fixed_window_rolling_policy-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">FixedWindowRollingPolicy Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>When rolling over, <code><a class="el" href="classlog4cxx_1_1rolling_1_1_fixed_window_rolling_policy.html" title="When rolling over, FixedWindowRollingPolicy renames files according to a fixed window algorithm as de...">FixedWindowRollingPolicy</a></code> renames files according to a fixed window algorithm as described below. |
| <a href="classlog4cxx_1_1rolling_1_1_fixed_window_rolling_policy.html#details">More...</a></p> |
| <div class="dynheader"> |
| Inheritance diagram for FixedWindowRollingPolicy:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classlog4cxx_1_1rolling_1_1_fixed_window_rolling_policy.png" usemap="#FixedWindowRollingPolicy_map" alt=""/> |
| <map id="FixedWindowRollingPolicy_map" name="FixedWindowRollingPolicy_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="85,168,245,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,160,136"/> |
| <area href="classlog4cxx_1_1helpers_1_1_object_impl.html" title="Implementation class for Object. " alt="ObjectImpl" shape="rect" coords="170,112,330,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,160,80"/> |
| <area href="classlog4cxx_1_1helpers_1_1_object.html" title="base class for java-like objects. " alt="Object" shape="rect" coords="170,56,330,80"/> |
| <area href="classlog4cxx_1_1helpers_1_1_object.html" title="base class for java-like objects. " alt="Object" shape="rect" coords="0,0,160,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:ad3ac316e124d762b9ab0e1b0f25de79d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1rolling_1_1_fixed_window_rolling_policy.html#ad3ac316e124d762b9ab0e1b0f25de79d">FixedWindowRollingPolicy</a> ()</td></tr> |
| <tr class="separator:ad3ac316e124d762b9ab0e1b0f25de79d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa3df68f8aae152299471992071e202f5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1rolling_1_1_fixed_window_rolling_policy.html#aa3df68f8aae152299471992071e202f5">activateOptions</a> (<a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> &p)</td></tr> |
| <tr class="memdesc:aa3df68f8aae152299471992071e202f5"><td class="mdescLeft"> </td><td class="mdescRight">Activate the options that were previously set with calls to option setters. <a href="#aa3df68f8aae152299471992071e202f5">More...</a><br /></td></tr> |
| <tr class="separator:aa3df68f8aae152299471992071e202f5"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac1d269357907e0809687a2bec962e1c8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1rolling_1_1_fixed_window_rolling_policy.html#ac1d269357907e0809687a2bec962e1c8">setOption</a> (const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &option, const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &value)</td></tr> |
| <tr class="memdesc:ac1d269357907e0809687a2bec962e1c8"><td class="mdescLeft"> </td><td class="mdescRight">Set <code>option</code> to <code>value</code>. <a href="#ac1d269357907e0809687a2bec962e1c8">More...</a><br /></td></tr> |
| <tr class="separator:ac1d269357907e0809687a2bec962e1c8"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1445193a5ee913dfadf174b47a49f1d2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1rolling_1_1_fixed_window_rolling_policy.html#a1445193a5ee913dfadf174b47a49f1d2">rollover</a> ()</td></tr> |
| <tr class="separator:a1445193a5ee913dfadf174b47a49f1d2"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:acc87ab06481503558435ce178a680fdc"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1rolling_1_1_fixed_window_rolling_policy.html#acc87ab06481503558435ce178a680fdc">getMaxIndex</a> () const </td></tr> |
| <tr class="separator:acc87ab06481503558435ce178a680fdc"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a546690bd9f6a54d4854b06818bf3a408"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1rolling_1_1_fixed_window_rolling_policy.html#a546690bd9f6a54d4854b06818bf3a408">getMinIndex</a> () const </td></tr> |
| <tr class="separator:a546690bd9f6a54d4854b06818bf3a408"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a033819da2ecbedd2c382f75b53212131"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1rolling_1_1_fixed_window_rolling_policy.html#a033819da2ecbedd2c382f75b53212131">setMaxIndex</a> (int newVal)</td></tr> |
| <tr class="separator:a033819da2ecbedd2c382f75b53212131"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a48f199391368ed1654cd286972bb3158"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1rolling_1_1_fixed_window_rolling_policy.html#a48f199391368ed1654cd286972bb3158">setMinIndex</a> (int newVal)</td></tr> |
| <tr class="separator:a48f199391368ed1654cd286972bb3158"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6891e6664cbec059e25fbe6f3429eaa4"><td class="memItemLeft" align="right" valign="top">RolloverDescriptionPtr </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1rolling_1_1_fixed_window_rolling_policy.html#a6891e6664cbec059e25fbe6f3429eaa4">initialize</a> (const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &currentActiveFile, const bool append, <a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> &pool)</td></tr> |
| <tr class="memdesc:a6891e6664cbec059e25fbe6f3429eaa4"><td class="mdescLeft"> </td><td class="mdescRight">Initialize the policy and return any initial actions for rolling file appender.<dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">currentActiveFile</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 memory allocations during call. </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> |
| <a href="#a6891e6664cbec059e25fbe6f3429eaa4">More...</a><br /></td></tr> |
| <tr class="separator:a6891e6664cbec059e25fbe6f3429eaa4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2982fd8eb8a51cf04c998e4079fe1394"><td class="memItemLeft" align="right" valign="top">RolloverDescriptionPtr </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1rolling_1_1_fixed_window_rolling_policy.html#a2982fd8eb8a51cf04c998e4079fe1394">rollover</a> (const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &currentActiveFile, const bool append, <a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> &pool)</td></tr> |
| <tr class="memdesc:a2982fd8eb8a51cf04c998e4079fe1394"><td class="mdescLeft"> </td><td class="mdescRight">Prepare for a rollover.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.<dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">currentActiveFile</td><td>file name for current active log file. </td></tr> |
| <tr><td class="paramname">append</td><td>current value of the parent <a class="el" href="classlog4cxx_1_1_file_appender.html#af8cb171146140874fb651ca95e142805" title="Returns the value of the Append option. ">FileAppender.getAppend()</a>. </td></tr> |
| <tr><td class="paramname">pool</td><td>pool for memory allocations during call. </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> |
| <a href="#a2982fd8eb8a51cf04c998e4079fe1394">More...</a><br /></td></tr> |
| <tr class="separator:a2982fd8eb8a51cf04c998e4079fe1394"><td class="memSeparator" colspan="2"> </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="-"/> 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"> </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"> </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 </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"> </td></tr> |
| <tr class="memitem:a0198815940c2715c84b0e04828cf8dfa inherit pub_methods_classlog4cxx_1_1rolling_1_1_rolling_policy_base"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1rolling_1_1_rolling_policy_base.html#a0198815940c2715c84b0e04828cf8dfa">addRef</a> () const </td></tr> |
| <tr class="separator:a0198815940c2715c84b0e04828cf8dfa inherit pub_methods_classlog4cxx_1_1rolling_1_1_rolling_policy_base"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a55c31efee1904916b999395fa4d46a24 inherit pub_methods_classlog4cxx_1_1rolling_1_1_rolling_policy_base"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1rolling_1_1_rolling_policy_base.html#a55c31efee1904916b999395fa4d46a24">releaseRef</a> () const </td></tr> |
| <tr class="separator:a55c31efee1904916b999395fa4d46a24 inherit pub_methods_classlog4cxx_1_1rolling_1_1_rolling_policy_base"><td class="memSeparator" colspan="2"> </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 </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> &fnp)</td></tr> |
| <tr class="memdesc:affe8d437262494f823891f9b8294bd24 inherit pub_methods_classlog4cxx_1_1rolling_1_1_rolling_policy_base"><td class="mdescLeft"> </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"> </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> </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"> </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"> </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="-"/> 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 </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"> </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="-"/> 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 </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"> </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="-"/> 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> & </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"> </td></tr> |
| <tr class="memitem:ab5cc4f9ba1ea5c2f25bc4b1f0dac5dc5 inherit pub_methods_classlog4cxx_1_1helpers_1_1_object"><td class="memItemLeft" align="right" valign="top">virtual </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"> </td></tr> |
| <tr class="memitem:a3604a5fb08f7048d41b51a3943740b96 inherit pub_methods_classlog4cxx_1_1helpers_1_1_object"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_object.html#a3604a5fb08f7048d41b51a3943740b96">instanceof</a> (const <a class="el" href="classlog4cxx_1_1helpers_1_1_class.html">Class</a> &clazz) const =0</td></tr> |
| <tr class="separator:a3604a5fb08f7048d41b51a3943740b96 inherit pub_methods_classlog4cxx_1_1helpers_1_1_object"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5a7744a4efdb699356cef215613903c3 inherit pub_methods_classlog4cxx_1_1helpers_1_1_object"><td class="memItemLeft" align="right" valign="top">virtual const void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_object.html#a5a7744a4efdb699356cef215613903c3">cast</a> (const <a class="el" href="classlog4cxx_1_1helpers_1_1_class.html">Class</a> &clazz) const =0</td></tr> |
| <tr class="separator:a5a7744a4efdb699356cef215613903c3 inherit pub_methods_classlog4cxx_1_1helpers_1_1_object"><td class="memSeparator" colspan="2"> </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="-"/> 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"> </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"> </td></tr> |
| <tr class="memitem:abb974728bb3cb991285140c1aa57eed7 inherit pub_methods_classlog4cxx_1_1helpers_1_1_object_impl"><td class="memItemLeft" align="right" valign="top">virtual </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"> </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> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1rolling_1_1_fixed_window_rolling_policy.html#a3a480a46e679ec1f28872451b34d5727">getFormatSpecifiers</a> () const </td></tr> |
| <tr class="separator:a3a480a46e679ec1f28872451b34d5727"><td class="memSeparator" colspan="2"> </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="-"/> 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 </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"> </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"> </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 </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="classlog4cxx_1_1helpers_1_1_object_ptr.html">log4cxx::helpers::ObjectPtr</a> &obj, <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &buf, <a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> &p) const </td></tr> |
| <tr class="memdesc:af91dd666c03237cc3f78e671490708ac inherit pro_methods_classlog4cxx_1_1rolling_1_1_rolling_policy_base"><td class="mdescLeft"> </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"> </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 </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"> </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 </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"> </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="-"/> 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> & </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"> </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> & </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"> </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="-"/> 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 </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"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>When rolling over, <code><a class="el" href="classlog4cxx_1_1rolling_1_1_fixed_window_rolling_policy.html" title="When rolling over, FixedWindowRollingPolicy renames files according to a fixed window algorithm as de...">FixedWindowRollingPolicy</a></code> renames files according to a fixed window algorithm as described below. </p> |
| <p>The <b>ActiveFileName</b> property, which is required, represents the name of the file where current logging output will be written. The <b>FileNamePattern</b> option represents the file name pattern for the archived (rolled over) log files. If present, the <b>FileNamePattern</b> option must include an integer token, that is the string "%i" somwhere within the pattern.</p> |
| <p>Let <em>max</em> and <em>min</em> represent the values of respectively the <b>MaxIndex</b> and <b>MinIndex</b> options. Let "foo.log" be the value of the <b>ActiveFile</b> option and "foo.%i.log" the value of <b>FileNamePattern</b>. Then, when rolling over, the file <code>foo.<em>max</em>.log</code> will be deleted, the file <code>foo.<em>max-1</em>.log</code> will be renamed as <code>foo.<em>max</em>.log</code>, the file <code>foo.<em>max-2</em>.log</code> renamed as <code>foo.<em>max-1</em>.log</code>, and so on, the file <code>foo.<em>min+1</em>.log</code> renamed as <code>foo.<em>min+2</em>.log</code>. Lastly, the active file <code>foo.log</code> will be renamed as <code>foo.<em>min</em>.log</code> and a new active file name <code>foo.log</code> will be created.</p> |
| <p>Given that this rollover algorithm requires as many file renaming operations as the window size, large window sizes are discouraged. The current implementation will automatically reduce the window size to 12 when larger values are specified by the user. </p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a class="anchor" id="ad3ac316e124d762b9ab0e1b0f25de79d"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classlog4cxx_1_1rolling_1_1_fixed_window_rolling_policy.html">FixedWindowRollingPolicy</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="aa3df68f8aae152299471992071e202f5"></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> & </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="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#abbd1d9f66dd437e9e0c7afa027577373">RollingPolicyBase</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="acc87ab06481503558435ce178a680fdc"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int getMaxIndex </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a546690bd9f6a54d4854b06818bf3a408"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int getMinIndex </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a6891e6664cbec059e25fbe6f3429eaa4"></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> & </td> |
| <td class="paramname"><em>currentActiveFile</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></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.<dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">currentActiveFile</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 memory allocations during call. </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> |
| |
| <p>Implements <a class="el" href="classlog4cxx_1_1rolling_1_1_rolling_policy.html#a016fd6f2c51ea3de60980fab32b33577">RollingPolicy</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a1445193a5ee913dfadf174b47a49f1d2"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void rollover </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a2982fd8eb8a51cf04c998e4079fe1394"></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> & </td> |
| <td class="paramname"><em>currentActiveFile</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></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.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.<dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">currentActiveFile</td><td>file name for current active log file. </td></tr> |
| <tr><td class="paramname">append</td><td>current value of the parent <a class="el" href="classlog4cxx_1_1_file_appender.html#af8cb171146140874fb651ca95e142805" title="Returns the value of the Append option. ">FileAppender.getAppend()</a>. </td></tr> |
| <tr><td class="paramname">pool</td><td>pool for memory allocations during call. </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> |
| |
| <p>Implements <a class="el" href="classlog4cxx_1_1rolling_1_1_rolling_policy.html#a7251f29bb637a85615c47cb082ef9cca">RollingPolicy</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a033819da2ecbedd2c382f75b53212131"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void setMaxIndex </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>newVal</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a48f199391368ed1654cd286972bb3158"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void setMinIndex </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>newVal</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ac1d269357907e0809687a2bec962e1c8"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void setOption </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td> |
| <td class="paramname"><em>option</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>value</em> </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>Set <code>option</code> to <code>value</code>. </p> |
| <p>The handling of each option depends on the OptionHandler instance. Some options may become active immediately whereas other may be activated only when <a class="el" href="classlog4cxx_1_1rolling_1_1_fixed_window_rolling_policy.html#aa3df68f8aae152299471992071e202f5" title="Activate the options that were previously set with calls to option setters. ">activateOptions</a> is called. </p> |
| |
| <p>Reimplemented from <a class="el" href="classlog4cxx_1_1rolling_1_1_rolling_policy_base.html#aee5023c29cca9dc68164b22a01cb7c6e">RollingPolicyBase</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li><a class="el" href="fixedwindowrollingpolicy_8h.html">fixedwindowrollingpolicy.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> |
