<!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.8"/> <title>log4shib: Appender.hh 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="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/search.js"></script> <script type="text/javascript"> $(document).ready(function() { searchBox.OnSelectItem(0); }); </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 style="padding-left: 0.5em;"> <div id="projectname">log4shib  <span id="projectnumber">1.0.8</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.8 --> <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="pages.html"><span>Related Pages</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li><a href="annotated.html"><span>Classes</span></a></li> <li class="current"><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="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>File Members</span></a></li> </ul> </div> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark"> </span>Pages</a></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 id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_1eb1cafafd84a09ddbe9fda5c5189f10.html">log4shib</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">Appender.hh</div> </div> </div><!--header--> <div class="contents"> <a href="Appender_8hh.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"> * Appender.hh</span></div> <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> *</span></div> <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * Copyright 2000, LifeLine Networks BV (www.lifeline.nl). All rights reserved.</span></div> <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * Copyright 2000, Bastiaan Bakker. All rights reserved.</span></div> <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> *</span></div> <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * See the COPYING file for the terms of usage and distribution.</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> </div> <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#ifndef _LOG4SHIB_APPENDER_HH</span></div> <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#define _LOG4SHIB_APPENDER_HH</span></div> <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div> <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include <<a class="code" href="Portability_8hh.html">log4shib/Portability.hh</a>></span></div> <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include <string></span></div> <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include <map></span></div> <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include <set></span></div> <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include <stdarg.h></span></div> <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include <sys/types.h></span></div> <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include <sys/stat.h></span></div> <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include <fcntl.h></span></div> <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include <<a class="code" href="Priority_8hh.html">log4shib/Priority.hh</a>></span></div> <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include <<a class="code" href="Layout_8hh.html">log4shib/Layout.hh</a>></span></div> <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <<a class="code" href="LoggingEvent_8hh.html">log4shib/LoggingEvent.hh</a>></span></div> <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <<a class="code" href="Threading_8hh.html">log4shib/threading/Threading.hh</a>></span></div> <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div> <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="keyword">namespace </span><a class="code" href="namespacelog4shib.html">log4shib</a> {</div> <div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="namespacelog4shib.html#a347166d6ae6094eeae96b37444b1d63d"> 27</a></span>  <span class="keyword">class </span><a class="code" href="Export_8hh.html#aa6b9f4ade013cd7ea2ec951901330156">LOG4SHIB_EXPORT</a> <a class="code" href="classlog4shib_1_1Filter.html">Filter</a>;</div> <div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  </div> <div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="classlog4shib_1_1Appender.html"> 33</a></span>  <span class="keyword">class </span><a class="code" href="Export_8hh.html#aa6b9f4ade013cd7ea2ec951901330156">LOG4SHIB_EXPORT</a> <a class="code" href="classlog4shib_1_1Appender.html">Appender</a> {</div> <div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="keyword">public</span>:</div> <div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  </div> <div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keyword">static</span> <a class="code" href="classlog4shib_1_1Appender.html">Appender</a>* getAppender(<span class="keyword">const</span> std::string& name);</div> <div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  </div> <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keyword">static</span> <span class="keywordtype">bool</span> reopenAll();</div> <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  </div> <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> closeAll();</div> <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  </div> <div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keyword">protected</span>:</div> <div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <a class="code" href="classlog4shib_1_1Appender.html">Appender</a>(<span class="keyword">const</span> std::string& name);</div> <div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  </div> <div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keyword">public</span>:</div> <div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keyword">virtual</span> ~<a class="code" href="classlog4shib_1_1Appender.html">Appender</a>();</div> <div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  </div> <div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> doAppend(<span class="keyword">const</span> <a class="code" href="structlog4shib_1_1LoggingEvent.html">LoggingEvent</a>& event) = 0;</div> <div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  </div> <div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> reopen() = 0;</div> <div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  </div> <div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> close() = 0;</div> <div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  </div> <div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> requiresLayout() <span class="keyword">const</span> = 0;</div> <div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  </div> <div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> setLayout(<a class="code" href="classlog4shib_1_1Layout.html">Layout</a>* layout) = 0;</div> <div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  </div> <div class="line"><a name="l00106"></a><span class="lineno"><a class="line" href="classlog4shib_1_1Appender.html#acacc56f74847a7ab89961fb02eb00511"> 106</a></span>  <span class="keyword">inline</span> <span class="keyword">const</span> std::string& <a class="code" href="classlog4shib_1_1Appender.html#acacc56f74847a7ab89961fb02eb00511">getName</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _name; };</div> <div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  </div> <div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> setThreshold(<a class="code" href="classlog4shib_1_1Priority.html#a52f9e246405983136cbb07512ba67f21">Priority::Value</a> priority) = 0;</div> <div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  </div> <div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  <span class="keyword">virtual</span> <a class="code" href="classlog4shib_1_1Priority.html#a52f9e246405983136cbb07512ba67f21">Priority::Value</a> getThreshold() = 0;</div> <div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  </div> <div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> setFilter(<a class="code" href="classlog4shib_1_1Filter.html">Filter</a>* filter) = 0;</div> <div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  </div> <div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  <span class="keyword">virtual</span> <a class="code" href="classlog4shib_1_1Filter.html">Filter</a>* getFilter() = 0;</div> <div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  </div> <div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  <span class="keyword">private</span>:</div> <div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  <span class="keyword">typedef</span> std::map<std::string, Appender*> AppenderMap;</div> <div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  </div> <div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  <span class="keyword">static</span> AppenderMap* _allAppenders;</div> <div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  <span class="keyword">static</span> <a class="code" href="classlog4shib_1_1threading_1_1Mutex.html">threading::Mutex</a> _appenderMapMutex;</div> <div class="line"><a name="l00138"></a><span class="lineno"> 138</span> </div> <div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  <span class="keyword">static</span> AppenderMap& _getAllAppenders();</div> <div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> _deleteAllAppenders();</div> <div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> _addAppender(<a class="code" href="classlog4shib_1_1Appender.html">Appender</a>* appender);</div> <div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> _removeAppender(<a class="code" href="classlog4shib_1_1Appender.html">Appender</a>* appender);</div> <div class="line"><a name="l00143"></a><span class="lineno"> 143</span> </div> <div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  <span class="keyword">const</span> std::string _name;</div> <div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  };</div> <div class="line"><a name="l00146"></a><span class="lineno"> 146</span> </div> <div class="line"><a name="l00147"></a><span class="lineno"><a class="line" href="namespacelog4shib.html#a7d9c5201525c50e48caea20a9b1709c6"> 147</a></span>  <span class="keyword">typedef</span> std::set<Appender *> <a class="code" href="namespacelog4shib.html#a7d9c5201525c50e48caea20a9b1709c6">AppenderSet</a>;</div> <div class="line"><a name="l00148"></a><span class="lineno"> 148</span> }</div> <div class="line"><a name="l00149"></a><span class="lineno"> 149</span> </div> <div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="preprocessor">#endif // _LOG4SHIB_APPENDER_HH</span></div> <div class="ttc" id="namespacelog4shib_html_a7d9c5201525c50e48caea20a9b1709c6"><div class="ttname"><a href="namespacelog4shib.html#a7d9c5201525c50e48caea20a9b1709c6">log4shib::AppenderSet</a></div><div class="ttdeci">std::set< Appender * > AppenderSet</div><div class="ttdef"><b>Definition:</b> Appender.hh:147</div></div> <div class="ttc" id="LoggingEvent_8hh_html"><div class="ttname"><a href="LoggingEvent_8hh.html">LoggingEvent.hh</a></div></div> <div class="ttc" id="structlog4shib_1_1LoggingEvent_html"><div class="ttname"><a href="structlog4shib_1_1LoggingEvent.html">log4shib::LoggingEvent</a></div><div class="ttdoc">The internal representation of logging events. </div><div class="ttdef"><b>Definition:</b> LoggingEvent.hh:32</div></div> <div class="ttc" id="Layout_8hh_html"><div class="ttname"><a href="Layout_8hh.html">Layout.hh</a></div></div> <div class="ttc" id="classlog4shib_1_1Appender_html_acacc56f74847a7ab89961fb02eb00511"><div class="ttname"><a href="classlog4shib_1_1Appender.html#acacc56f74847a7ab89961fb02eb00511">log4shib::Appender::getName</a></div><div class="ttdeci">const std::string & getName() const </div><div class="ttdoc">Get the name of this appender. </div><div class="ttdef"><b>Definition:</b> Appender.hh:106</div></div> <div class="ttc" id="classlog4shib_1_1Appender_html"><div class="ttname"><a href="classlog4shib_1_1Appender.html">log4shib::Appender</a></div><div class="ttdoc">Implement this interface for your own strategies for printing log statements. </div><div class="ttdef"><b>Definition:</b> Appender.hh:33</div></div> <div class="ttc" id="Portability_8hh_html"><div class="ttname"><a href="Portability_8hh.html">Portability.hh</a></div></div> <div class="ttc" id="Export_8hh_html_aa6b9f4ade013cd7ea2ec951901330156"><div class="ttname"><a href="Export_8hh.html#aa6b9f4ade013cd7ea2ec951901330156">LOG4SHIB_EXPORT</a></div><div class="ttdeci">#define LOG4SHIB_EXPORT</div><div class="ttdef"><b>Definition:</b> Export.hh:11</div></div> <div class="ttc" id="classlog4shib_1_1Filter_html"><div class="ttname"><a href="classlog4shib_1_1Filter.html">log4shib::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.hh:49</div></div> <div class="ttc" id="classlog4shib_1_1Priority_html_a52f9e246405983136cbb07512ba67f21"><div class="ttname"><a href="classlog4shib_1_1Priority.html#a52f9e246405983136cbb07512ba67f21">log4shib::Priority::Value</a></div><div class="ttdeci">int Value</div><div class="ttdoc">The type of Priority Values. </div><div class="ttdef"><b>Definition:</b> Priority.hh:84</div></div> <div class="ttc" id="namespacelog4shib_html"><div class="ttname"><a href="namespacelog4shib.html">log4shib</a></div><div class="ttdoc">The top level namespace for all 'Log for C++' types and classes. </div><div class="ttdef"><b>Definition:</b> AbortAppender.hh:16</div></div> <div class="ttc" id="classlog4shib_1_1Layout_html"><div class="ttname"><a href="classlog4shib_1_1Layout.html">log4shib::Layout</a></div><div class="ttdoc">Extend this abstract class to create your own log layout format. </div><div class="ttdef"><b>Definition:</b> Layout.hh:22</div></div> <div class="ttc" id="classlog4shib_1_1threading_1_1Mutex_html"><div class="ttname"><a href="classlog4shib_1_1threading_1_1Mutex.html">log4shib::threading::Mutex</a></div><div class="ttdef"><b>Definition:</b> PThreads.hh:29</div></div> <div class="ttc" id="Threading_8hh_html"><div class="ttname"><a href="Threading_8hh.html">Threading.hh</a></div></div> <div class="ttc" id="Priority_8hh_html"><div class="ttname"><a href="Priority_8hh.html">Priority.hh</a></div></div> </div><!-- fragment --></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Thu Oct 16 2014 02:10:55 for log4shib by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.8 </small></address> </body> </html>