<!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.5"/> <title>log4shib: NDC.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.5 --> <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">NDC.hh</div> </div> </div><!--header--> <div class="contents"> <a href="NDC_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"> * NDC.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_NDC_HH</span></div> <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor"></span><span class="preprocessor">#define _LOG4SHIB_NDC_HH</span></div> <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor"></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 <vector></span></div> <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div> <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="keyword">namespace </span>log4shib {</div> <div class="line"><a name="l00069"></a><span class="lineno"><a class="line" href="classlog4shib_1_1NDC.html"> 69</a></span>  <span class="keyword">class </span><a class="code" href="Export_8hh.html#aa6b9f4ade013cd7ea2ec951901330156">LOG4SHIB_EXPORT</a> <a class="code" href="classlog4shib_1_1NDC.html">NDC</a> {</div> <div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keyword">public</span>:</div> <div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div> <div class="line"><a name="l00072"></a><span class="lineno"><a class="line" href="structlog4shib_1_1NDC_1_1DiagnosticContext.html"> 72</a></span>  <span class="keyword">struct </span><a class="code" href="structlog4shib_1_1NDC_1_1DiagnosticContext.html">DiagnosticContext</a> {</div> <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <a class="code" href="structlog4shib_1_1NDC_1_1DiagnosticContext.html">DiagnosticContext</a>(<span class="keyword">const</span> std::string& message);</div> <div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <a class="code" href="structlog4shib_1_1NDC_1_1DiagnosticContext.html">DiagnosticContext</a>(<span class="keyword">const</span> std::string& message, </div> <div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keyword">const</span> <a class="code" href="structlog4shib_1_1NDC_1_1DiagnosticContext.html">DiagnosticContext</a>& parent);</div> <div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div> <div class="line"><a name="l00077"></a><span class="lineno"><a class="line" href="structlog4shib_1_1NDC_1_1DiagnosticContext.html#a3e4505a0f5821ff1b240520ec51914e8"> 77</a></span>  std::string <a class="code" href="structlog4shib_1_1NDC_1_1DiagnosticContext.html#a3e4505a0f5821ff1b240520ec51914e8">message</a>;</div> <div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="structlog4shib_1_1NDC_1_1DiagnosticContext.html#a37d761a51ac822f815ead936713675f0"> 78</a></span>  std::string <a class="code" href="structlog4shib_1_1NDC_1_1DiagnosticContext.html#a37d761a51ac822f815ead936713675f0">fullMessage</a>;</div> <div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  };</div> <div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div> <div class="line"><a name="l00081"></a><span class="lineno"><a class="line" href="classlog4shib_1_1NDC.html#a507bd425de69a35595f9a79a00fd89dd"> 81</a></span>  <span class="keyword">typedef</span> std::vector<DiagnosticContext> <a class="code" href="classlog4shib_1_1NDC.html#a507bd425de69a35595f9a79a00fd89dd">ContextStack</a>;</div> <div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div> <div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> clear();</div> <div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div> <div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <span class="keyword">static</span> <a class="code" href="classlog4shib_1_1NDC.html#a507bd425de69a35595f9a79a00fd89dd">ContextStack</a>* cloneStack();</div> <div class="line"><a name="l00107"></a><span class="lineno"> 107</span> </div> <div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <span class="keyword">static</span> <span class="keyword">const</span> std::string& <span class="keyword">get</span>();</div> <div class="line"><a name="l00113"></a><span class="lineno"> 113</span> </div> <div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <span class="keyword">static</span> <span class="keywordtype">int</span> getDepth();</div> <div class="line"><a name="l00119"></a><span class="lineno"> 119</span> </div> <div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> inherit(<a class="code" href="classlog4shib_1_1NDC.html#a507bd425de69a35595f9a79a00fd89dd">ContextStack</a>* stack);</div> <div class="line"><a name="l00121"></a><span class="lineno"> 121</span> </div> <div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  <span class="keyword">static</span> std::string pop();</div> <div class="line"><a name="l00133"></a><span class="lineno"> 133</span> </div> <div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> push(<span class="keyword">const</span> std::string& message);</div> <div class="line"><a name="l00143"></a><span class="lineno"> 143</span> </div> <div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> setMaxDepth(<span class="keywordtype">int</span> maxDepth);</div> <div class="line"><a name="l00151"></a><span class="lineno"> 151</span> </div> <div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  <span class="keyword">static</span> <a class="code" href="classlog4shib_1_1NDC.html">NDC</a>& getNDC();</div> <div class="line"><a name="l00157"></a><span class="lineno"> 157</span> </div> <div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  <a class="code" href="classlog4shib_1_1NDC.html">NDC</a>();</div> <div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  <span class="keyword">virtual</span> ~<a class="code" href="classlog4shib_1_1NDC.html">NDC</a>();</div> <div class="line"><a name="l00160"></a><span class="lineno"> 160</span> </div> <div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  <span class="keyword">public</span>:</div> <div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> _clear();</div> <div class="line"><a name="l00163"></a><span class="lineno"> 163</span>  <span class="keyword">virtual</span> <a class="code" href="classlog4shib_1_1NDC.html#a507bd425de69a35595f9a79a00fd89dd">ContextStack</a>* _cloneStack();</div> <div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  <span class="keyword">virtual</span> <span class="keyword">const</span> std::string& _get() <span class="keyword">const</span>;</div> <div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  <span class="keyword">virtual</span> <span class="keywordtype">int</span> _getDepth() <span class="keyword">const</span>;</div> <div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> _inherit(<a class="code" href="classlog4shib_1_1NDC.html#a507bd425de69a35595f9a79a00fd89dd">ContextStack</a>* stack);</div> <div class="line"><a name="l00167"></a><span class="lineno"> 167</span>  <span class="keyword">virtual</span> std::string _pop();</div> <div class="line"><a name="l00168"></a><span class="lineno"> 168</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> _push(<span class="keyword">const</span> std::string& message);</div> <div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> _setMaxDepth(<span class="keywordtype">int</span> maxDepth);</div> <div class="line"><a name="l00170"></a><span class="lineno"> 170</span> </div> <div class="line"><a name="l00171"></a><span class="lineno"><a class="line" href="classlog4shib_1_1NDC.html#af7bb5c2940ef1fd2e437ed4316b3e0e1"> 171</a></span>  <a class="code" href="classlog4shib_1_1NDC.html#a507bd425de69a35595f9a79a00fd89dd">ContextStack</a> <a class="code" href="classlog4shib_1_1NDC.html#af7bb5c2940ef1fd2e437ed4316b3e0e1">_stack</a>;</div> <div class="line"><a name="l00172"></a><span class="lineno"> 172</span>  }; </div> <div class="line"><a name="l00173"></a><span class="lineno"> 173</span> }</div> <div class="line"><a name="l00174"></a><span class="lineno"> 174</span> </div> <div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <span class="preprocessor">#endif // _LOG4SHIB_NDC_HH</span></div> <div class="ttc" id="structlog4shib_1_1NDC_1_1DiagnosticContext_html_a3e4505a0f5821ff1b240520ec51914e8"><div class="ttname"><a href="structlog4shib_1_1NDC_1_1DiagnosticContext.html#a3e4505a0f5821ff1b240520ec51914e8">log4shib::NDC::DiagnosticContext::message</a></div><div class="ttdeci">std::string message</div><div class="ttdef"><b>Definition:</b> NDC.hh:77</div></div> <div class="ttc" id="structlog4shib_1_1NDC_1_1DiagnosticContext_html_a37d761a51ac822f815ead936713675f0"><div class="ttname"><a href="structlog4shib_1_1NDC_1_1DiagnosticContext.html#a37d761a51ac822f815ead936713675f0">log4shib::NDC::DiagnosticContext::fullMessage</a></div><div class="ttdeci">std::string fullMessage</div><div class="ttdef"><b>Definition:</b> NDC.hh:78</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="structlog4shib_1_1NDC_1_1DiagnosticContext_html"><div class="ttname"><a href="structlog4shib_1_1NDC_1_1DiagnosticContext.html">log4shib::NDC::DiagnosticContext</a></div><div class="ttdef"><b>Definition:</b> NDC.hh:72</div></div> <div class="ttc" id="classlog4shib_1_1NDC_html_af7bb5c2940ef1fd2e437ed4316b3e0e1"><div class="ttname"><a href="classlog4shib_1_1NDC.html#af7bb5c2940ef1fd2e437ed4316b3e0e1">log4shib::NDC::_stack</a></div><div class="ttdeci">ContextStack _stack</div><div class="ttdef"><b>Definition:</b> NDC.hh:171</div></div> <div class="ttc" id="classlog4shib_1_1NDC_html"><div class="ttname"><a href="classlog4shib_1_1NDC.html">log4shib::NDC</a></div><div class="ttdoc">The NDC class implements nested diagnostic contexts as defined by Neil Harrison in the article &quot;Patte...</div><div class="ttdef"><b>Definition:</b> NDC.hh:69</div></div> <div class="ttc" id="classlog4shib_1_1NDC_html_a507bd425de69a35595f9a79a00fd89dd"><div class="ttname"><a href="classlog4shib_1_1NDC.html#a507bd425de69a35595f9a79a00fd89dd">log4shib::NDC::ContextStack</a></div><div class="ttdeci">std::vector< DiagnosticContext > ContextStack</div><div class="ttdef"><b>Definition:</b> NDC.hh:81</div></div> </div><!-- fragment --></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Sat Oct 19 2013 07:04:31 for log4shib by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.5 </small></address> </body> </html>