| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=11"/> |
| <meta name="generator" content="Doxygen 1.9.6"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>Apache Log4cxx: log4cxx::rolling::FilterBasedTriggeringPolicy 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> |
| <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> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| <link href="customdoxygen.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 id="projectrow"> |
| <td id="projectalign"> |
| <div id="projectname">Apache Log4cxx<span id="projectnumber"> Version 1.1.0</span> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.9.6 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| var searchBox = new SearchBox("searchBox", "search/",'.html'); |
| /* @license-end */ |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */ |
| </script> |
| <div id="main-nav"></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"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| $(document).ready(function(){initNavTree('classlog4cxx_1_1rolling_1_1FilterBasedTriggeringPolicy.html',''); initResizable(); }); |
| /* @license-end */ |
| </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"> |
| <div id="MSearchResults"> |
| <div class="SRPage"> |
| <div id="SRIndex"> |
| <div id="SRResults"></div> |
| <div class="SRStatus" id="Loading">Loading...</div> |
| <div class="SRStatus" id="Searching">Searching...</div> |
| <div class="SRStatus" id="NoMatches">No Matches</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="classlog4cxx_1_1rolling_1_1FilterBasedTriggeringPolicy-members.html">List of all members</a> </div> |
| <div class="headertitle"><div class="title">log4cxx::rolling::FilterBasedTriggeringPolicy Class Reference</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p><a class="el" href="classlog4cxx_1_1rolling_1_1FilterBasedTriggeringPolicy.html" title="FilterBasedTriggeringPolicy determines if rolling should be triggered by evaluating the current messa...">FilterBasedTriggeringPolicy</a> determines if rolling should be triggered by evaluating the current message against a set of filters. |
| <a href="classlog4cxx_1_1rolling_1_1FilterBasedTriggeringPolicy.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="filterbasedtriggeringpolicy_8h_source.html">filterbasedtriggeringpolicy.h</a>></code></p> |
| <div class="dynheader"> |
| Inheritance diagram for log4cxx::rolling::FilterBasedTriggeringPolicy:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classlog4cxx_1_1rolling_1_1FilterBasedTriggeringPolicy.png" usemap="#log4cxx::rolling::FilterBasedTriggeringPolicy_map" alt=""/> |
| <map id="log4cxx::rolling::FilterBasedTriggeringPolicy_map" name="log4cxx::rolling::FilterBasedTriggeringPolicy_map"> |
| <area href="classlog4cxx_1_1rolling_1_1TriggeringPolicy.html" title="A TriggeringPolicy controls the conditions under which rollover occurs." alt="log4cxx::rolling::TriggeringPolicy" shape="rect" coords="134,112,393,136"/> |
| <area href="classlog4cxx_1_1spi_1_1OptionHandler.html" title="A string based interface to configure package components." alt="log4cxx::spi::OptionHandler" shape="rect" coords="0,56,259,80"/> |
| <area href="classlog4cxx_1_1helpers_1_1Object.html" title="base class for java-like objects." alt="log4cxx::helpers::Object" shape="rect" coords="269,56,528,80"/> |
| <area href="classlog4cxx_1_1helpers_1_1Object.html" title="base class for java-like objects." alt="log4cxx::helpers::Object" shape="rect" coords="0,0,259,24"/> |
| </map> |
| </div></div> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:a9fa8e27ea602866c49bcec8ee5d0a2d3"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1rolling_1_1FilterBasedTriggeringPolicy.html#a9fa8e27ea602866c49bcec8ee5d0a2d3">FilterBasedTriggeringPolicy</a> ()</td></tr> |
| <tr class="memdesc:a9fa8e27ea602866c49bcec8ee5d0a2d3"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new <a class="el" href="classlog4cxx_1_1rolling_1_1FilterBasedTriggeringPolicy.html" title="FilterBasedTriggeringPolicy determines if rolling should be triggered by evaluating the current messa...">FilterBasedTriggeringPolicy</a>. <br /></td></tr> |
| <tr class="separator:a9fa8e27ea602866c49bcec8ee5d0a2d3"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae3b1aa792b9877ecef62e197a60fd5e8"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1rolling_1_1FilterBasedTriggeringPolicy.html#ae3b1aa792b9877ecef62e197a60fd5e8">~FilterBasedTriggeringPolicy</a> ()</td></tr> |
| <tr class="separator:ae3b1aa792b9877ecef62e197a60fd5e8"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4eea386ac2c2c42c906d3b92a1a5015a"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1rolling_1_1FilterBasedTriggeringPolicy.html#a4eea386ac2c2c42c906d3b92a1a5015a">isTriggeringEvent</a> (<a class="el" href="classlog4cxx_1_1Appender.html">Appender</a> *appender, const <a class="el" href="namespacelog4cxx_1_1spi.html#aae6992e1b33222c26bdc1173b6aedc6c">spi::LoggingEventPtr</a> &event, const <a class="el" href="namespacelog4cxx.html#aa2308ed05fef2a1366066cb38b177e94">LogString</a> &filename, size_t fileLength) override</td></tr> |
| <tr class="memdesc:a4eea386ac2c2c42c906d3b92a1a5015a"><td class="mdescLeft"> </td><td class="mdescRight">Determines if a rollover may be appropriate at this time. <br /></td></tr> |
| <tr class="separator:a4eea386ac2c2c42c906d3b92a1a5015a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:abdb5fc06c4a42940d44fdd2acee37e06"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1rolling_1_1FilterBasedTriggeringPolicy.html#abdb5fc06c4a42940d44fdd2acee37e06">addFilter</a> (const <a class="el" href="namespacelog4cxx_1_1spi.html#a98940dd5338fd77ed3018e8ad9d5ac97">spi::FilterPtr</a> &newFilter)</td></tr> |
| <tr class="memdesc:abdb5fc06c4a42940d44fdd2acee37e06"><td class="mdescLeft"> </td><td class="mdescRight">Add a filter to end of the filter list. <br /></td></tr> |
| <tr class="separator:abdb5fc06c4a42940d44fdd2acee37e06"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a468e38a3ce08b4975e0e2e3ff29cd24f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1rolling_1_1FilterBasedTriggeringPolicy.html#a468e38a3ce08b4975e0e2e3ff29cd24f">clearFilters</a> ()</td></tr> |
| <tr class="memdesc:a468e38a3ce08b4975e0e2e3ff29cd24f"><td class="mdescLeft"> </td><td class="mdescRight">Clear the filters chain. <br /></td></tr> |
| <tr class="separator:a468e38a3ce08b4975e0e2e3ff29cd24f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a449816e34dc710f1d3322f9a9c4e85eb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacelog4cxx_1_1spi.html#a98940dd5338fd77ed3018e8ad9d5ac97">spi::FilterPtr</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1rolling_1_1FilterBasedTriggeringPolicy.html#a449816e34dc710f1d3322f9a9c4e85eb">getFilter</a> ()</td></tr> |
| <tr class="memdesc:a449816e34dc710f1d3322f9a9c4e85eb"><td class="mdescLeft"> </td><td class="mdescRight">Returns the head Filter. <br /></td></tr> |
| <tr class="separator:a449816e34dc710f1d3322f9a9c4e85eb"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae26bc0294d05b82515dd99075ee1624d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1rolling_1_1FilterBasedTriggeringPolicy.html#ae26bc0294d05b82515dd99075ee1624d">activateOptions</a> (<a class="el" href="classlog4cxx_1_1helpers_1_1Pool.html">helpers::Pool</a> &) override</td></tr> |
| <tr class="memdesc:ae26bc0294d05b82515dd99075ee1624d"><td class="mdescLeft"> </td><td class="mdescRight">Activate the options that were previously set with calls to option setters. <br /></td></tr> |
| <tr class="separator:ae26bc0294d05b82515dd99075ee1624d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a625b3b23c1fbdea640ec50c9e402ee2c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1rolling_1_1FilterBasedTriggeringPolicy.html#a625b3b23c1fbdea640ec50c9e402ee2c">setOption</a> (const <a class="el" href="namespacelog4cxx.html#aa2308ed05fef2a1366066cb38b177e94">LogString</a> &option, const <a class="el" href="namespacelog4cxx.html#aa2308ed05fef2a1366066cb38b177e94">LogString</a> &value) override</td></tr> |
| <tr class="memdesc:a625b3b23c1fbdea640ec50c9e402ee2c"><td class="mdescLeft"> </td><td class="mdescRight">Set <code>option</code> to <code>value</code>. <br /></td></tr> |
| <tr class="separator:a625b3b23c1fbdea640ec50c9e402ee2c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pub_methods_classlog4cxx_1_1rolling_1_1TriggeringPolicy"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classlog4cxx_1_1rolling_1_1TriggeringPolicy')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classlog4cxx_1_1rolling_1_1TriggeringPolicy.html">log4cxx::rolling::TriggeringPolicy</a></td></tr> |
| <tr class="memitem:a2cdb6e1eda91d6dfe8bfe9ab890ab62c inherit pub_methods_classlog4cxx_1_1rolling_1_1TriggeringPolicy"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1rolling_1_1TriggeringPolicy.html#a2cdb6e1eda91d6dfe8bfe9ab890ab62c">~TriggeringPolicy</a> ()</td></tr> |
| <tr class="separator:a2cdb6e1eda91d6dfe8bfe9ab890ab62c inherit pub_methods_classlog4cxx_1_1rolling_1_1TriggeringPolicy"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab41e056038143ec08fc76d431e1c894b inherit pub_methods_classlog4cxx_1_1rolling_1_1TriggeringPolicy"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1rolling_1_1TriggeringPolicy.html#ab41e056038143ec08fc76d431e1c894b">isTriggeringEvent</a> (<a class="el" href="classlog4cxx_1_1Appender.html">Appender</a> *appender, const <a class="el" href="namespacelog4cxx_1_1spi.html#aae6992e1b33222c26bdc1173b6aedc6c">spi::LoggingEventPtr</a> &event, const <a class="el" href="namespacelog4cxx.html#aa2308ed05fef2a1366066cb38b177e94">LogString</a> &filename, size_t fileLength)=0</td></tr> |
| <tr class="memdesc:ab41e056038143ec08fc76d431e1c894b inherit pub_methods_classlog4cxx_1_1rolling_1_1TriggeringPolicy"><td class="mdescLeft"> </td><td class="mdescRight">Determines if a rollover may be appropriate at this time. <br /></td></tr> |
| <tr class="separator:ab41e056038143ec08fc76d431e1c894b inherit pub_methods_classlog4cxx_1_1rolling_1_1TriggeringPolicy"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pub_methods_classlog4cxx_1_1spi_1_1OptionHandler"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classlog4cxx_1_1spi_1_1OptionHandler')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classlog4cxx_1_1spi_1_1OptionHandler.html">log4cxx::spi::OptionHandler</a></td></tr> |
| <tr class="memitem:a556b59c5ef41477c0bc3f50efadc859e inherit pub_methods_classlog4cxx_1_1spi_1_1OptionHandler"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1spi_1_1OptionHandler.html#a556b59c5ef41477c0bc3f50efadc859e">~OptionHandler</a> ()</td></tr> |
| <tr class="separator:a556b59c5ef41477c0bc3f50efadc859e inherit pub_methods_classlog4cxx_1_1spi_1_1OptionHandler"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad06d4f5c6d414fcb421bc2a35c9593fe inherit pub_methods_classlog4cxx_1_1spi_1_1OptionHandler"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1spi_1_1OptionHandler.html#ad06d4f5c6d414fcb421bc2a35c9593fe">activateOptions</a> (<a class="el" href="classlog4cxx_1_1helpers_1_1Pool.html">helpers::Pool</a> &p)=0</td></tr> |
| <tr class="memdesc:ad06d4f5c6d414fcb421bc2a35c9593fe inherit pub_methods_classlog4cxx_1_1spi_1_1OptionHandler"><td class="mdescLeft"> </td><td class="mdescRight">Activate the options that were previously set with calls to option setters. <br /></td></tr> |
| <tr class="separator:ad06d4f5c6d414fcb421bc2a35c9593fe inherit pub_methods_classlog4cxx_1_1spi_1_1OptionHandler"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a42037043a55afcaf6f824fcb950f18d2 inherit pub_methods_classlog4cxx_1_1spi_1_1OptionHandler"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1spi_1_1OptionHandler.html#a42037043a55afcaf6f824fcb950f18d2">setOption</a> (const <a class="el" href="namespacelog4cxx.html#aa2308ed05fef2a1366066cb38b177e94">LogString</a> &option, const <a class="el" href="namespacelog4cxx.html#aa2308ed05fef2a1366066cb38b177e94">LogString</a> &value)=0</td></tr> |
| <tr class="memdesc:a42037043a55afcaf6f824fcb950f18d2 inherit pub_methods_classlog4cxx_1_1spi_1_1OptionHandler"><td class="mdescLeft"> </td><td class="mdescRight">Set <code>option</code> to <code>value</code>. <br /></td></tr> |
| <tr class="separator:a42037043a55afcaf6f824fcb950f18d2 inherit pub_methods_classlog4cxx_1_1spi_1_1OptionHandler"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pub_methods_classlog4cxx_1_1helpers_1_1Object"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classlog4cxx_1_1helpers_1_1Object')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classlog4cxx_1_1helpers_1_1Object.html">log4cxx::helpers::Object</a></td></tr> |
| <tr class="memitem:a8ba23411233a652fac44a619e6356115 inherit pub_methods_classlog4cxx_1_1helpers_1_1Object"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1Object.html#a8ba23411233a652fac44a619e6356115">~Object</a> ()</td></tr> |
| <tr class="separator:a8ba23411233a652fac44a619e6356115 inherit pub_methods_classlog4cxx_1_1helpers_1_1Object"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a581992e532894891e83b9afd605ca492 inherit pub_methods_classlog4cxx_1_1helpers_1_1Object"><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="classlog4cxx_1_1helpers_1_1Class.html">helpers::Class</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1Object.html#a581992e532894891e83b9afd605ca492">getClass</a> () const =0</td></tr> |
| <tr class="separator:a581992e532894891e83b9afd605ca492 inherit pub_methods_classlog4cxx_1_1helpers_1_1Object"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9dac08272167c9af4c7d81e9e205a9de inherit pub_methods_classlog4cxx_1_1helpers_1_1Object"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1Object.html#a9dac08272167c9af4c7d81e9e205a9de">instanceof</a> (const <a class="el" href="classlog4cxx_1_1helpers_1_1Class.html">Class</a> &clazz) const =0</td></tr> |
| <tr class="separator:a9dac08272167c9af4c7d81e9e205a9de inherit pub_methods_classlog4cxx_1_1helpers_1_1Object"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a92a4c098274758a7b989be642b495d55 inherit pub_methods_classlog4cxx_1_1helpers_1_1Object"><td class="memItemLeft" align="right" valign="top">virtual const void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1Object.html#a92a4c098274758a7b989be642b495d55">cast</a> (const <a class="el" href="classlog4cxx_1_1helpers_1_1Class.html">Class</a> &clazz) const =0</td></tr> |
| <tr class="separator:a92a4c098274758a7b989be642b495d55 inherit pub_methods_classlog4cxx_1_1helpers_1_1Object"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p><a class="el" href="classlog4cxx_1_1rolling_1_1FilterBasedTriggeringPolicy.html" title="FilterBasedTriggeringPolicy determines if rolling should be triggered by evaluating the current messa...">FilterBasedTriggeringPolicy</a> determines if rolling should be triggered by evaluating the current message against a set of filters. </p> |
| <p>Unless a filter rejects a message, a rolling event will be triggered. </p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a9fa8e27ea602866c49bcec8ee5d0a2d3" name="a9fa8e27ea602866c49bcec8ee5d0a2d3"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a9fa8e27ea602866c49bcec8ee5d0a2d3">◆ </a></span>FilterBasedTriggeringPolicy()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">log4cxx::rolling::FilterBasedTriggeringPolicy::FilterBasedTriggeringPolicy </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Creates a new <a class="el" href="classlog4cxx_1_1rolling_1_1FilterBasedTriggeringPolicy.html" title="FilterBasedTriggeringPolicy determines if rolling should be triggered by evaluating the current messa...">FilterBasedTriggeringPolicy</a>. </p> |
| |
| </div> |
| </div> |
| <a id="ae3b1aa792b9877ecef62e197a60fd5e8" name="ae3b1aa792b9877ecef62e197a60fd5e8"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae3b1aa792b9877ecef62e197a60fd5e8">◆ </a></span>~FilterBasedTriggeringPolicy()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual log4cxx::rolling::FilterBasedTriggeringPolicy::~FilterBasedTriggeringPolicy </td> |
| <td>(</td> |
| <td class="paramname"></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"> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="ae26bc0294d05b82515dd99075ee1624d" name="ae26bc0294d05b82515dd99075ee1624d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae26bc0294d05b82515dd99075ee1624d">◆ </a></span>activateOptions()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void log4cxx::rolling::FilterBasedTriggeringPolicy::activateOptions </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classlog4cxx_1_1helpers_1_1Pool.html">helpers::Pool</a> & </td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">override</span><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>Activates all attached filters. </p> |
| |
| <p>Implements <a class="el" href="classlog4cxx_1_1spi_1_1OptionHandler.html#ad06d4f5c6d414fcb421bc2a35c9593fe">log4cxx::spi::OptionHandler</a>.</p> |
| |
| </div> |
| </div> |
| <a id="abdb5fc06c4a42940d44fdd2acee37e06" name="abdb5fc06c4a42940d44fdd2acee37e06"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#abdb5fc06c4a42940d44fdd2acee37e06">◆ </a></span>addFilter()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void log4cxx::rolling::FilterBasedTriggeringPolicy::addFilter </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="namespacelog4cxx_1_1spi.html#a98940dd5338fd77ed3018e8ad9d5ac97">spi::FilterPtr</a> & </td> |
| <td class="paramname"><em>newFilter</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Add a filter to end of the filter list. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">newFilter</td><td>filter to add to end of list. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a468e38a3ce08b4975e0e2e3ff29cd24f" name="a468e38a3ce08b4975e0e2e3ff29cd24f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a468e38a3ce08b4975e0e2e3ff29cd24f">◆ </a></span>clearFilters()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void log4cxx::rolling::FilterBasedTriggeringPolicy::clearFilters </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Clear the filters chain. </p> |
| |
| </div> |
| </div> |
| <a id="a449816e34dc710f1d3322f9a9c4e85eb" name="a449816e34dc710f1d3322f9a9c4e85eb"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a449816e34dc710f1d3322f9a9c4e85eb">◆ </a></span>getFilter()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="namespacelog4cxx_1_1spi.html#a98940dd5338fd77ed3018e8ad9d5ac97">spi::FilterPtr</a> & log4cxx::rolling::FilterBasedTriggeringPolicy::getFilter </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns the head Filter. </p> |
| |
| </div> |
| </div> |
| <a id="a4eea386ac2c2c42c906d3b92a1a5015a" name="a4eea386ac2c2c42c906d3b92a1a5015a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a4eea386ac2c2c42c906d3b92a1a5015a">◆ </a></span>isTriggeringEvent()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool log4cxx::rolling::FilterBasedTriggeringPolicy::isTriggeringEvent </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classlog4cxx_1_1Appender.html">Appender</a> * </td> |
| <td class="paramname"><em>appender</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const <a class="el" href="namespacelog4cxx_1_1spi.html#aae6992e1b33222c26bdc1173b6aedc6c">spi::LoggingEventPtr</a> & </td> |
| <td class="paramname"><em>event</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const <a class="el" href="namespacelog4cxx.html#aa2308ed05fef2a1366066cb38b177e94">LogString</a> & </td> |
| <td class="paramname"><em>filename</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">size_t </td> |
| <td class="paramname"><em>fileLength</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">override</span><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_1TriggeringPolicy.html#ab41e056038143ec08fc76d431e1c894b">log4cxx::rolling::TriggeringPolicy</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a625b3b23c1fbdea640ec50c9e402ee2c" name="a625b3b23c1fbdea640ec50c9e402ee2c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a625b3b23c1fbdea640ec50c9e402ee2c">◆ </a></span>setOption()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void log4cxx::rolling::FilterBasedTriggeringPolicy::setOption </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="namespacelog4cxx.html#aa2308ed05fef2a1366066cb38b177e94">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#aa2308ed05fef2a1366066cb38b177e94">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">override</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Set <code>option</code> to <code>value</code>. </p> |
| <table class="markdownTable"> |
| <tr class="markdownTableHead"> |
| <th class="markdownTableHeadNone">Supported options </th><th class="markdownTableHeadNone">Supported values </th><th class="markdownTableHeadNone">Default value </th></tr> |
| <tr class="markdownTableRowOdd"> |
| <td class="markdownTableBodyNone">- </td><td class="markdownTableBodyNone">- </td><td class="markdownTableBodyNone">- </td></tr> |
| </table> |
| |
| <p>Implements <a class="el" href="classlog4cxx_1_1spi_1_1OptionHandler.html#a42037043a55afcaf6f824fcb950f18d2">log4cxx::spi::OptionHandler</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li><a class="el" href="filterbasedtriggeringpolicy_8h_source.html">filterbasedtriggeringpolicy.h</a></li> |
| </ul> |
| </div><!-- contents --> |
| </div><!-- doc-content --> |
| <!-- HTML footer for doxygen 1.8.13--> |
| <!-- start footer part --> |
| <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> |
| <ul> |
| <li class="navelem"><a class="el" href="namespacelog4cxx.html">log4cxx</a></li><li class="navelem"><a class="el" href="namespacelog4cxx_1_1rolling.html">rolling</a></li><li class="navelem"><a class="el" href="classlog4cxx_1_1rolling_1_1FilterBasedTriggeringPolicy.html">FilterBasedTriggeringPolicy</a></li> |
| <li class="footer">Generated by |
| <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="https://www.doxygen.nl/images/doxygen.png" alt="Doxygen"/></a> 1.9.6 on Tue Jul 11 2023 </li> |
| <li class="center"> |
| Copyright © 2003-2023 <a href="https://www.apache.org/">Apache Software Foundation</a>. All Rights Reserved. <a href="https://privacy.apache.org/policies/privacy-policy-public.html">Privacy Policy</a><br/> |
| Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, and the Apache Logging project logo are trademarks of The Apache Software Foundation.<br/> |
| </li> |
| </ul> |
| </div> |
| </body> |
| </html> |
