| <!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.13"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>Apache log4cxx: filter.h Source File</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); |
| </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 style="height: 56px;"> |
| <td id="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname">Apache log4cxx |
|  <span id="projectnumber">Version 0.13.0</span> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.13 --> |
| <script type="text/javascript"> |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| </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"> |
| $(document).ready(function(){initNavTree('filter_8h_source.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="headertitle"> |
| <div class="title">filter.h</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="filter_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * contributor license agreements. See the NOTICE file distributed with</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * this work for additional information regarding copyright ownership.</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * (the "License"); you may not use this file except in compliance with</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * the License. You may obtain a copy of the License at</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> *</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> *</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * See the License for the specific language governing permissions and</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * limitations under the License.</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> */</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#ifndef _LOG4CXX_SPI_FILTER_H</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#define _LOG4CXX_SPI_FILTER_H</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include <<a class="code" href="object_8h.html">log4cxx/helpers/object.h</a>></span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include <<a class="code" href="optionhandler_8h.html">log4cxx/spi/optionhandler.h</a>></span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <<a class="code" href="loggingevent_8h.html">log4cxx/spi/loggingevent.h</a>></span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="keyword">namespace </span><a class="code" href="namespacelog4cxx.html">log4cxx</a></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> {</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">namespace </span>spi</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> {</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">class </span>Filter;</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <a class="code" href="namespacelog4cxx_1_1spi.html#a499039308bf624c907892022691032f7">LOG4CXX_PTR_DEF</a>(Filter);</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div><div class="line"><a name="l00068"></a><span class="lineno"><a class="line" href="classlog4cxx_1_1spi_1_1Filter.html"> 68</a></span> <span class="keyword">class </span>LOG4CXX_EXPORT <a class="code" href="classlog4cxx_1_1spi_1_1Filter.html">Filter</a> : <span class="keyword">public</span> <span class="keyword">virtual</span> <a class="code" href="classlog4cxx_1_1spi_1_1OptionHandler.html">OptionHandler</a>,</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keyword">public</span> <span class="keyword">virtual</span> <a class="code" href="classlog4cxx_1_1helpers_1_1Object.html">helpers::Object</a></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> {</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <a class="code" href="namespacelog4cxx_1_1spi.html#a98940dd5338fd77ed3018e8ad9d5ac97">FilterPtr</a> next;</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <a class="code" href="classlog4cxx_1_1spi_1_1Filter.html">Filter</a>();</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <a class="code" href="object_8h.html#a7a13485fd2b3040ee5cae53c2bc00f13">DECLARE_ABSTRACT_LOG4CXX_OBJECT</a>(<a class="code" href="classlog4cxx_1_1spi_1_1Filter.html">Filter</a>)</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <a class="code" href="object_8h.html#ac8ff8f70159e03fe7d8c4aa743cc9cda">BEGIN_LOG4CXX_CAST_MAP</a>()</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <a class="code" href="object_8h.html#a642180530328ec0378468edda5bc94e2">LOG4CXX_CAST_ENTRY</a>(<a class="code" href="classlog4cxx_1_1spi_1_1Filter.html">Filter</a>)</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <a class="code" href="object_8h.html#a642180530328ec0378468edda5bc94e2">LOG4CXX_CAST_ENTRY</a>(<a class="code" href="classlog4cxx_1_1spi_1_1OptionHandler.html">spi::OptionHandler</a>)</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <a class="code" href="object_8h.html#a917a7d053853b1ffdf45a3d91aeca4f1">END_LOG4CXX_CAST_MAP</a>()</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> </div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <a class="code" href="namespacelog4cxx_1_1spi.html#a98940dd5338fd77ed3018e8ad9d5ac97">log4cxx::spi::FilterPtr</a> getNext() <span class="keyword">const</span>;</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keywordtype">void</span> setNext(<span class="keyword">const</span> <a class="code" href="namespacelog4cxx_1_1spi.html#a98940dd5338fd77ed3018e8ad9d5ac97">log4cxx::spi::FilterPtr</a>& newNext);</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div><div class="line"><a name="l00087"></a><span class="lineno"><a class="line" href="classlog4cxx_1_1spi_1_1Filter.html#aa59a54ffa01e4cc1635734a251afd5ee"> 87</a></span>  <span class="keyword">enum</span> <a class="code" href="classlog4cxx_1_1spi_1_1Filter.html#aa59a54ffa01e4cc1635734a251afd5ee">FilterDecision</a></div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  {</div><div class="line"><a name="l00092"></a><span class="lineno"><a class="line" href="classlog4cxx_1_1spi_1_1Filter.html#aa59a54ffa01e4cc1635734a251afd5eeabb642c7f3bd94cb2505c0ee8f6644eb2"> 92</a></span>  DENY = -1,</div><div class="line"><a name="l00097"></a><span class="lineno"><a class="line" href="classlog4cxx_1_1spi_1_1Filter.html#aa59a54ffa01e4cc1635734a251afd5eeaae63501a780312e27cdaf212f65c7fc3"> 97</a></span>  NEUTRAL = 0,</div><div class="line"><a name="l00102"></a><span class="lineno"><a class="line" href="classlog4cxx_1_1spi_1_1Filter.html#aa59a54ffa01e4cc1635734a251afd5eea1c13584493a60ac7c8a36c64972522f2"> 102</a></span>  ACCEPT = 1</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> </div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  };</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> </div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> </div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <span class="keywordtype">void</span> activateOptions(<a class="code" href="classlog4cxx_1_1helpers_1_1Pool.html">log4cxx::helpers::Pool</a>& p);</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <span class="keywordtype">void</span> setOption(<span class="keyword">const</span> <a class="code" href="namespacelog4cxx.html#aa2308ed05fef2a1366066cb38b177e94">LogString</a>& option, <span class="keyword">const</span> <a class="code" href="namespacelog4cxx.html#aa2308ed05fef2a1366066cb38b177e94">LogString</a>& value);</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> </div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  <span class="keyword">virtual</span> <a class="code" href="classlog4cxx_1_1spi_1_1Filter.html#aa59a54ffa01e4cc1635734a251afd5ee">FilterDecision</a> decide(<span class="keyword">const</span> <a class="code" href="namespacelog4cxx_1_1spi.html#aae6992e1b33222c26bdc1173b6aedc6c">LoggingEventPtr</a>& event) <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> };</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> }</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> }</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> </div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="preprocessor">#endif //_LOG4CXX_SPI_FILTER_H</span></div><div class="ttc" id="object_8h_html_a7a13485fd2b3040ee5cae53c2bc00f13"><div class="ttname"><a href="object_8h.html#a7a13485fd2b3040ee5cae53c2bc00f13">DECLARE_ABSTRACT_LOG4CXX_OBJECT</a></div><div class="ttdeci">#define DECLARE_ABSTRACT_LOG4CXX_OBJECT(object)</div><div class="ttdef"><b>Definition:</b> object.h:26</div></div> |
| <div class="ttc" id="object_8h_html_a642180530328ec0378468edda5bc94e2"><div class="ttname"><a href="object_8h.html#a642180530328ec0378468edda5bc94e2">LOG4CXX_CAST_ENTRY</a></div><div class="ttdeci">#define LOG4CXX_CAST_ENTRY(Interface)</div><div class="ttdef"><b>Definition:</b> object.h:153</div></div> |
| <div class="ttc" id="object_8h_html_a917a7d053853b1ffdf45a3d91aeca4f1"><div class="ttname"><a href="object_8h.html#a917a7d053853b1ffdf45a3d91aeca4f1">END_LOG4CXX_CAST_MAP</a></div><div class="ttdeci">#define END_LOG4CXX_CAST_MAP()</div><div class="ttdef"><b>Definition:</b> object.h:147</div></div> |
| <div class="ttc" id="namespacelog4cxx_1_1spi_html_aae6992e1b33222c26bdc1173b6aedc6c"><div class="ttname"><a href="namespacelog4cxx_1_1spi.html#aae6992e1b33222c26bdc1173b6aedc6c">log4cxx::spi::LoggingEventPtr</a></div><div class="ttdeci">std::shared_ptr< LoggingEvent > LoggingEventPtr</div><div class="ttdef"><b>Definition:</b> appender.h:37</div></div> |
| <div class="ttc" id="object_8h_html_ac8ff8f70159e03fe7d8c4aa743cc9cda"><div class="ttname"><a href="object_8h.html#ac8ff8f70159e03fe7d8c4aa743cc9cda">BEGIN_LOG4CXX_CAST_MAP</a></div><div class="ttdeci">#define BEGIN_LOG4CXX_CAST_MAP()</div><div class="ttdef"><b>Definition:</b> object.h:141</div></div> |
| <div class="ttc" id="classlog4cxx_1_1spi_1_1Filter_html_aa59a54ffa01e4cc1635734a251afd5ee"><div class="ttname"><a href="classlog4cxx_1_1spi_1_1Filter.html#aa59a54ffa01e4cc1635734a251afd5ee">log4cxx::spi::Filter::FilterDecision</a></div><div class="ttdeci">FilterDecision</div><div class="ttdef"><b>Definition:</b> filter.h:87</div></div> |
| <div class="ttc" id="optionhandler_8h_html"><div class="ttname"><a href="optionhandler_8h.html">optionhandler.h</a></div></div> |
| <div class="ttc" id="classlog4cxx_1_1helpers_1_1Object_html"><div class="ttname"><a href="classlog4cxx_1_1helpers_1_1Object.html">log4cxx::helpers::Object</a></div><div class="ttdoc">base class for java-like objects. </div><div class="ttdef"><b>Definition:</b> object.h:101</div></div> |
| <div class="ttc" id="classlog4cxx_1_1helpers_1_1Pool_html"><div class="ttname"><a href="classlog4cxx_1_1helpers_1_1Pool.html">log4cxx::helpers::Pool</a></div><div class="ttdef"><b>Definition:</b> pool.h:32</div></div> |
| <div class="ttc" id="object_8h_html"><div class="ttname"><a href="object_8h.html">object.h</a></div></div> |
| <div class="ttc" id="namespacelog4cxx_1_1spi_html_a98940dd5338fd77ed3018e8ad9d5ac97"><div class="ttname"><a href="namespacelog4cxx_1_1spi.html#a98940dd5338fd77ed3018e8ad9d5ac97">log4cxx::spi::FilterPtr</a></div><div class="ttdeci">std::shared_ptr< Filter > FilterPtr</div><div class="ttdef"><b>Definition:</b> appender.h:40</div></div> |
| <div class="ttc" id="classlog4cxx_1_1spi_1_1OptionHandler_html"><div class="ttname"><a href="classlog4cxx_1_1spi_1_1OptionHandler.html">log4cxx::spi::OptionHandler</a></div><div class="ttdoc">A string based interface to configure package components. </div><div class="ttdef"><b>Definition:</b> optionhandler.h:34</div></div> |
| <div class="ttc" id="namespacelog4cxx_1_1spi_html_a499039308bf624c907892022691032f7"><div class="ttname"><a href="namespacelog4cxx_1_1spi.html#a499039308bf624c907892022691032f7">log4cxx::spi::LOG4CXX_PTR_DEF</a></div><div class="ttdeci">LOG4CXX_PTR_DEF(LoggerRepository)</div></div> |
| <div class="ttc" id="loggingevent_8h_html"><div class="ttname"><a href="loggingevent_8h.html">loggingevent.h</a></div></div> |
| <div class="ttc" id="namespacelog4cxx_html"><div class="ttname"><a href="namespacelog4cxx.html">log4cxx</a></div><div class="ttdef"><b>Definition:</b> appender.h:32</div></div> |
| <div class="ttc" id="namespacelog4cxx_html_aa2308ed05fef2a1366066cb38b177e94"><div class="ttname"><a href="namespacelog4cxx.html#aa2308ed05fef2a1366066cb38b177e94">log4cxx::LogString</a></div><div class="ttdeci">std::basic_string< logchar > LogString</div><div class="ttdef"><b>Definition:</b> logstring.h:66</div></div> |
| <div class="ttc" id="classlog4cxx_1_1spi_1_1Filter_html"><div class="ttname"><a href="classlog4cxx_1_1spi_1_1Filter.html">log4cxx::spi::Filter</a></div><div class="ttdoc">Users should extend this class to implement customized logging event filtering. </div><div class="ttdef"><b>Definition:</b> filter.h:68</div></div> |
| </div><!-- fragment --></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="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_5eb159725f84c66aafd839904a4acdd0.html">main</a></li><li class="navelem"><a class="el" href="dir_df3bee86fdbfb464c3a94507855b0bdc.html">include</a></li><li class="navelem"><a class="el" href="dir_7be30a74690c85c659aa4940da9d1914.html">log4cxx</a></li><li class="navelem"><a class="el" href="dir_73284ebf47da3fb887ab0e324de6081f.html">spi</a></li><li class="navelem"><a class="el" href="filter_8h.html">filter.h</a></li> |
| <li class="footer">Generated by |
| <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li> |
| <li class="center"> |
| Copyright © 2003-2022 <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> |
