<!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: log4shib::NDC 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="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 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>
<!-- 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="namespacelog4shib.html">log4shib</a></li><li class="navelem"><a class="el" href="classlog4shib_1_1NDC.html">NDC</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pub-attribs">Public Attributes</a> |
<a href="classlog4shib_1_1NDC-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">log4shib::NDC Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>The <a class="el" href="classlog4shib_1_1NDC.html" title="The NDC class implements nested diagnostic contexts as defined by Neil Harrison in the article "Patte...">NDC</a> class implements <em>nested diagnostic contexts</em> as defined by Neil Harrison in the article "Patterns for Logging
Diagnostic Messages" part of the book "<i>Pattern Languages of
Program Design 3</i>" edited by Martin et al.
<a href="classlog4shib_1_1NDC.html#details">More...</a></p>
<p><code>#include <<a class="el" href="NDC_8hh_source.html">NDC.hh</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structlog4shib_1_1NDC_1_1DiagnosticContext.html">DiagnosticContext</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a507bd425de69a35595f9a79a00fd89dd"><td class="memItemLeft" align="right" valign="top">typedef std::vector<br class="typebreak"/>
< <a class="el" href="structlog4shib_1_1NDC_1_1DiagnosticContext.html">DiagnosticContext</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1NDC.html#a507bd425de69a35595f9a79a00fd89dd">ContextStack</a></td></tr>
<tr class="separator:a507bd425de69a35595f9a79a00fd89dd"><td class="memSeparator" colspan="2"> </td></tr>
</table><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:a9ede4a225fe2947851f2dfbd3a32ab88"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1NDC.html#a9ede4a225fe2947851f2dfbd3a32ab88">NDC</a> ()</td></tr>
<tr class="separator:a9ede4a225fe2947851f2dfbd3a32ab88"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac2eb9e1e8fa72d5902985d8ce8b67790"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1NDC.html#ac2eb9e1e8fa72d5902985d8ce8b67790">~NDC</a> ()</td></tr>
<tr class="separator:ac2eb9e1e8fa72d5902985d8ce8b67790"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af148073475eedee699785db59dbc2646"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1NDC.html#af148073475eedee699785db59dbc2646">_clear</a> ()</td></tr>
<tr class="separator:af148073475eedee699785db59dbc2646"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a04d2405984f71cc411be1bbe0f253b7c"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classlog4shib_1_1NDC.html#a507bd425de69a35595f9a79a00fd89dd">ContextStack</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1NDC.html#a04d2405984f71cc411be1bbe0f253b7c">_cloneStack</a> ()</td></tr>
<tr class="separator:a04d2405984f71cc411be1bbe0f253b7c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa5a9d5d06b6d74132a2f81034dbbcde6"><td class="memItemLeft" align="right" valign="top">virtual const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1NDC.html#aa5a9d5d06b6d74132a2f81034dbbcde6">_get</a> () const </td></tr>
<tr class="separator:aa5a9d5d06b6d74132a2f81034dbbcde6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af13bce8c4e548a4bec03d700e7141307"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1NDC.html#af13bce8c4e548a4bec03d700e7141307">_getDepth</a> () const </td></tr>
<tr class="separator:af13bce8c4e548a4bec03d700e7141307"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab5b155608270ea341a78a75ca8d94951"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1NDC.html#ab5b155608270ea341a78a75ca8d94951">_inherit</a> (<a class="el" href="classlog4shib_1_1NDC.html#a507bd425de69a35595f9a79a00fd89dd">ContextStack</a> *stack)</td></tr>
<tr class="separator:ab5b155608270ea341a78a75ca8d94951"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad546c30547b4ea23147dad49b3a24a9d"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1NDC.html#ad546c30547b4ea23147dad49b3a24a9d">_pop</a> ()</td></tr>
<tr class="separator:ad546c30547b4ea23147dad49b3a24a9d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae9a47afdb02c7d91f76a14f28ba99e34"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1NDC.html#ae9a47afdb02c7d91f76a14f28ba99e34">_push</a> (const std::string &message)</td></tr>
<tr class="separator:ae9a47afdb02c7d91f76a14f28ba99e34"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a433e6047c39b9aa1d55a0a7189f6752b"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1NDC.html#a433e6047c39b9aa1d55a0a7189f6752b">_setMaxDepth</a> (int maxDepth)</td></tr>
<tr class="separator:a433e6047c39b9aa1d55a0a7189f6752b"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a0145e86d42b70baf44911a7872d08efc"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1NDC.html#a0145e86d42b70baf44911a7872d08efc">clear</a> ()</td></tr>
<tr class="memdesc:a0145e86d42b70baf44911a7872d08efc"><td class="mdescLeft"> </td><td class="mdescRight">Clear any nested disgnostic information if any. <a href="#a0145e86d42b70baf44911a7872d08efc">More...</a><br/></td></tr>
<tr class="separator:a0145e86d42b70baf44911a7872d08efc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a63c2ff0dfa52d5d3378f1c1c2df82f16"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classlog4shib_1_1NDC.html#a507bd425de69a35595f9a79a00fd89dd">ContextStack</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1NDC.html#a63c2ff0dfa52d5d3378f1c1c2df82f16">cloneStack</a> ()</td></tr>
<tr class="memdesc:a63c2ff0dfa52d5d3378f1c1c2df82f16"><td class="mdescLeft"> </td><td class="mdescRight">Clone the diagnostic context for the current thread. <a href="#a63c2ff0dfa52d5d3378f1c1c2df82f16">More...</a><br/></td></tr>
<tr class="separator:a63c2ff0dfa52d5d3378f1c1c2df82f16"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3d4b310fdb74fb026dbc6c0c4866a0ec"><td class="memItemLeft" align="right" valign="top">static const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1NDC.html#a3d4b310fdb74fb026dbc6c0c4866a0ec">get</a> ()</td></tr>
<tr class="memdesc:a3d4b310fdb74fb026dbc6c0c4866a0ec"><td class="mdescLeft"> </td><td class="mdescRight">Get the current diagnostic context string. <a href="#a3d4b310fdb74fb026dbc6c0c4866a0ec">More...</a><br/></td></tr>
<tr class="separator:a3d4b310fdb74fb026dbc6c0c4866a0ec"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a73f4b454aca0e38be352d4c7358de89d"><td class="memItemLeft" align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1NDC.html#a73f4b454aca0e38be352d4c7358de89d">getDepth</a> ()</td></tr>
<tr class="memdesc:a73f4b454aca0e38be352d4c7358de89d"><td class="mdescLeft"> </td><td class="mdescRight">Get the current nesting depth of this diagnostic context. <a href="#a73f4b454aca0e38be352d4c7358de89d">More...</a><br/></td></tr>
<tr class="separator:a73f4b454aca0e38be352d4c7358de89d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afe91081394b595e427e82a1a70882012"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1NDC.html#afe91081394b595e427e82a1a70882012">inherit</a> (<a class="el" href="classlog4shib_1_1NDC.html#a507bd425de69a35595f9a79a00fd89dd">ContextStack</a> *stack)</td></tr>
<tr class="separator:afe91081394b595e427e82a1a70882012"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a941b4f6f76ee15984f6eeda7755fa386"><td class="memItemLeft" align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1NDC.html#a941b4f6f76ee15984f6eeda7755fa386">pop</a> ()</td></tr>
<tr class="memdesc:a941b4f6f76ee15984f6eeda7755fa386"><td class="mdescLeft"> </td><td class="mdescRight">Clients should call this method before leaving a diagnostic context. <a href="#a941b4f6f76ee15984f6eeda7755fa386">More...</a><br/></td></tr>
<tr class="separator:a941b4f6f76ee15984f6eeda7755fa386"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a52042120979c62c8f4e32a2700237db6"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1NDC.html#a52042120979c62c8f4e32a2700237db6">push</a> (const std::string &message)</td></tr>
<tr class="memdesc:a52042120979c62c8f4e32a2700237db6"><td class="mdescLeft"> </td><td class="mdescRight">Push new diagnostic context information for the current thread. <a href="#a52042120979c62c8f4e32a2700237db6">More...</a><br/></td></tr>
<tr class="separator:a52042120979c62c8f4e32a2700237db6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaef728dd678440f0ff5e6b693ddc9d46"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1NDC.html#aaef728dd678440f0ff5e6b693ddc9d46">setMaxDepth</a> (int maxDepth)</td></tr>
<tr class="memdesc:aaef728dd678440f0ff5e6b693ddc9d46"><td class="mdescLeft"> </td><td class="mdescRight">Set the maximum nesting depth for the current <a class="el" href="classlog4shib_1_1NDC.html" title="The NDC class implements nested diagnostic contexts as defined by Neil Harrison in the article "Patte...">NDC</a>. <a href="#aaef728dd678440f0ff5e6b693ddc9d46">More...</a><br/></td></tr>
<tr class="separator:aaef728dd678440f0ff5e6b693ddc9d46"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1c8aa7b0c8520840cfedfb0c46d20d1d"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classlog4shib_1_1NDC.html">NDC</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1NDC.html#a1c8aa7b0c8520840cfedfb0c46d20d1d">getNDC</a> ()</td></tr>
<tr class="memdesc:a1c8aa7b0c8520840cfedfb0c46d20d1d"><td class="mdescLeft"> </td><td class="mdescRight">Return the <a class="el" href="classlog4shib_1_1NDC.html" title="The NDC class implements nested diagnostic contexts as defined by Neil Harrison in the article "Patte...">NDC</a> for the current thread. <a href="#a1c8aa7b0c8520840cfedfb0c46d20d1d">More...</a><br/></td></tr>
<tr class="separator:a1c8aa7b0c8520840cfedfb0c46d20d1d"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:af7bb5c2940ef1fd2e437ed4316b3e0e1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classlog4shib_1_1NDC.html#a507bd425de69a35595f9a79a00fd89dd">ContextStack</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1NDC.html#af7bb5c2940ef1fd2e437ed4316b3e0e1">_stack</a></td></tr>
<tr class="separator:af7bb5c2940ef1fd2e437ed4316b3e0e1"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The <a class="el" href="classlog4shib_1_1NDC.html" title="The NDC class implements nested diagnostic contexts as defined by Neil Harrison in the article "Patte...">NDC</a> class implements <em>nested diagnostic contexts</em> as defined by Neil Harrison in the article "Patterns for Logging
Diagnostic Messages" part of the book "<i>Pattern Languages of
Program Design 3</i>" edited by Martin et al. </p>
<p>A Nested Diagnostic Context, or <a class="el" href="classlog4shib_1_1NDC.html" title="The NDC class implements nested diagnostic contexts as defined by Neil Harrison in the article "Patte...">NDC</a> in short, is an instrument to distinguish interleaved log output from different sources. Log output is typically interleaved when a server handles multiple clients near-simulatanously.</p>
<p>Interleaved log output can still be meaningful if each log entry from different contexts had a distinctive stamp. This is where NDCs come into play.</p>
<p><em><b>Note that NDCs are managed on a per thread basis</b></em>. <a class="el" href="classlog4shib_1_1NDC.html" title="The NDC class implements nested diagnostic contexts as defined by Neil Harrison in the article "Patte...">NDC</a> operations such as <code>push</code>, <code> pop</code>, <code>clear</code>, <code>getDepth</code> and <code> setMaxDepth</code> affect the <a class="el" href="classlog4shib_1_1NDC.html" title="The NDC class implements nested diagnostic contexts as defined by Neil Harrison in the article "Patte...">NDC</a> of the <em>current</em> thread only. NDCs of other threads remain unaffected.</p>
<p>To build an <a class="el" href="classlog4shib_1_1NDC.html" title="The NDC class implements nested diagnostic contexts as defined by Neil Harrison in the article "Patte...">NDC</a> one uses the <code>push</code> operation. Simply put,</p>
<ul>
<li>
<p class="startli">Contexts can be nested.</p>
<p></p>
<p class="endli"></p>
</li>
<li>
<p class="startli">When entering a context, call <code><a class="el" href="classlog4shib_1_1NDC.html#a52042120979c62c8f4e32a2700237db6" title="Push new diagnostic context information for the current thread. ">NDC.push</a></code>. As a side effect, if there is no nested diagnostic context for the current thread, this method will create it.</p>
<p></p>
<p class="endli"></p>
</li>
<li>
When leaving a context, call <code><a class="el" href="classlog4shib_1_1NDC.html#a941b4f6f76ee15984f6eeda7755fa386" title="Clients should call this method before leaving a diagnostic context. ">NDC.pop</a></code>. </li>
</ul>
<p>There is no penalty for forgetting to match each <code>push</code> operation with a corresponding <code>pop</code>, except the obvious mismatch between the real application context and the context set in the <a class="el" href="classlog4shib_1_1NDC.html" title="The NDC class implements nested diagnostic contexts as defined by Neil Harrison in the article "Patte...">NDC</a>.</p>
<p>Custom Layouts may include the nested diagnostic context for the current thread in log messages, without any user intervention. Hence, even if a server is serving multiple clients simultaneously, the logs emanating from the same code (belonging to the same category) can still be distinguished because each client request will have a different <a class="el" href="classlog4shib_1_1NDC.html" title="The NDC class implements nested diagnostic contexts as defined by Neil Harrison in the article "Patte...">NDC</a> tag.</p>
<p><em>Unfortunately, unlike Java, C++ does not have platform independent multithreading support. Therefore, currently <a class="el" href="namespacelog4shib.html" title="The top level namespace for all 'Log for C++' types and classes. ">log4shib</a> is not multithread aware, it implicitly assumes only one thread exists, the main process thread. </em> </p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a class="anchor" id="a507bd425de69a35595f9a79a00fd89dd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef std::vector<<a class="el" href="structlog4shib_1_1NDC_1_1DiagnosticContext.html">DiagnosticContext</a>> <a class="el" href="classlog4shib_1_1NDC.html#a507bd425de69a35595f9a79a00fd89dd">log4shib::NDC::ContextStack</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a9ede4a225fe2947851f2dfbd3a32ab88"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">log4shib::NDC::NDC </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ac2eb9e1e8fa72d5902985d8ce8b67790"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">log4shib::NDC::~NDC </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 class="anchor" id="af148073475eedee699785db59dbc2646"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void log4shib::NDC::_clear </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>
<a class="anchor" id="a04d2405984f71cc411be1bbe0f253b7c"></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="classlog4shib_1_1NDC.html#a507bd425de69a35595f9a79a00fd89dd">NDC::ContextStack</a> * log4shib::NDC::_cloneStack </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>
<a class="anchor" id="aa5a9d5d06b6d74132a2f81034dbbcde6"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const std::string & log4shib::NDC::_get </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">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="af13bce8c4e548a4bec03d700e7141307"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int log4shib::NDC::_getDepth </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">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ab5b155608270ea341a78a75ca8d94951"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void log4shib::NDC::_inherit </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classlog4shib_1_1NDC.html#a507bd425de69a35595f9a79a00fd89dd">NDC::ContextStack</a> * </td>
<td class="paramname"><em>stack</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">
</div>
</div>
<a class="anchor" id="ad546c30547b4ea23147dad49b3a24a9d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string log4shib::NDC::_pop </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>
<a class="anchor" id="ae9a47afdb02c7d91f76a14f28ba99e34"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void log4shib::NDC::_push </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>message</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">
</div>
</div>
<a class="anchor" id="a433e6047c39b9aa1d55a0a7189f6752b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void log4shib::NDC::_setMaxDepth </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>maxDepth</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">
</div>
</div>
<a class="anchor" id="a0145e86d42b70baf44911a7872d08efc"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void log4shib::NDC::clear </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Clear any nested disgnostic information if any. </p>
<p>This method is useful in cases where the same thread can be potentially used over and over in different unrelated contexts.</p>
<p>This method is equivalent to calling the <code>setMaxDepth</code> method with a zero <code>maxDepth</code> argument. </p>
</div>
</div>
<a class="anchor" id="a63c2ff0dfa52d5d3378f1c1c2df82f16"></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="classlog4shib_1_1NDC.html#a507bd425de69a35595f9a79a00fd89dd">NDC::ContextStack</a> * log4shib::NDC::cloneStack </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Clone the diagnostic context for the current thread. </p>
<p>Internally a diagnostic context is represented as a stack. A given thread can supply the stack (i.e. diagnostic context) to a child thread so that the child can inherit the parent thread's diagnostic context.</p>
<p>The child thread uses the <code>inherit</code> method to inherit the parent's diagnostic context.</p>
<dl class="section return"><dt>Returns</dt><dd>Stack A clone of the current thread's diagnostic context. </dd></dl>
</div>
</div>
<a class="anchor" id="a3d4b310fdb74fb026dbc6c0c4866a0ec"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const std::string & log4shib::NDC::get </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the current diagnostic context string. </p>
<dl class="section return"><dt>Returns</dt><dd>the context string. </dd></dl>
</div>
</div>
<a class="anchor" id="a73f4b454aca0e38be352d4c7358de89d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int log4shib::NDC::getDepth </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the current nesting depth of this diagnostic context. </p>
<dl class="section return"><dt>Returns</dt><dd>the nesting depth </dd></dl>
</div>
</div>
<a class="anchor" id="a1c8aa7b0c8520840cfedfb0c46d20d1d"></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="classlog4shib_1_1NDC.html">NDC</a> & log4shib::NDC::getNDC </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the <a class="el" href="classlog4shib_1_1NDC.html" title="The NDC class implements nested diagnostic contexts as defined by Neil Harrison in the article "Patte...">NDC</a> for the current thread. </p>
<dl class="section return"><dt>Returns</dt><dd>the <a class="el" href="classlog4shib_1_1NDC.html" title="The NDC class implements nested diagnostic contexts as defined by Neil Harrison in the article "Patte...">NDC</a> for the current thread </dd></dl>
</div>
</div>
<a class="anchor" id="afe91081394b595e427e82a1a70882012"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void log4shib::NDC::inherit </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classlog4shib_1_1NDC.html#a507bd425de69a35595f9a79a00fd89dd">NDC::ContextStack</a> * </td>
<td class="paramname"><em>stack</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a941b4f6f76ee15984f6eeda7755fa386"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string log4shib::NDC::pop </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Clients should call this method before leaving a diagnostic context. </p>
<p>The returned value is the value that was pushed last. If no context is available, then the empty string "" is returned.</p>
<dl class="section return"><dt>Returns</dt><dd>String The innermost diagnostic context. </dd></dl>
</div>
</div>
<a class="anchor" id="a52042120979c62c8f4e32a2700237db6"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void log4shib::NDC::push </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>message</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Push new diagnostic context information for the current thread. </p>
<p>The contents of the <code>message</code> parameter is determined solely by the client.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">message</td><td>The new diagnostic context information. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aaef728dd678440f0ff5e6b693ddc9d46"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void log4shib::NDC::setMaxDepth </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>maxDepth</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the maximum nesting depth for the current <a class="el" href="classlog4shib_1_1NDC.html" title="The NDC class implements nested diagnostic contexts as defined by Neil Harrison in the article "Patte...">NDC</a>. </p>
<p>Curently NDCs do not enforce a maximum depth and consequentially this method has no effect. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">maxDepth</td><td>the maximum nesting depth </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="af7bb5c2940ef1fd2e437ed4316b3e0e1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlog4shib_1_1NDC.html#a507bd425de69a35595f9a79a00fd89dd">ContextStack</a> log4shib::NDC::_stack</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="NDC_8hh_source.html">NDC.hh</a></li>
<li><a class="el" href="NDC_8cpp.html">NDC.cpp</a></li>
</ul>
</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>
