<!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"/>
<title>Apache log4cxx: MDC Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Apache log4cxx <span id="projectnumber">Version 0.10.0</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</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>
</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>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('classlog4cxx_1_1_m_d_c.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<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> </div>
<div class="headertitle">
<h1>MDC Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="log4cxx::MDC" -->
<p>The <a class="el" href="classlog4cxx_1_1_m_d_c.html" title="The MDC class is similar to the NDC class except that it is based on a map instead of a stack...">MDC</a> class is similar to the <a class="el" href="classlog4cxx_1_1_n_d_c.html">NDC</a> class except that it is based on a map instead of a stack.
<a href="#_details">More...</a></p>
<p><a href="classlog4cxx_1_1_m_d_c-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef std::map< <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a>, <br class="typebreak"/>
<a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_m_d_c.html#a4030dd6e2d8a76b6c585d1cef5263bc3">Map</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">String to string stl map. <a href="#a4030dd6e2d8a76b6c585d1cef5263bc3"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_m_d_c.html#a2a882b816aa637e1543c6a570dd1a7eb">MDC</a> (const std::string &key, const std::string &value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Places a key/value pair in the <a class="el" href="classlog4cxx_1_1_m_d_c.html" title="The MDC class is similar to the NDC class except that it is based on a map instead of a stack...">MDC</a> for the current thread which will be removed during the corresponding destructor. <a href="#a2a882b816aa637e1543c6a570dd1a7eb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_m_d_c.html#a2326d5a5e81116eee25aa4d2c39c49e9">~MDC</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_m_d_c.html#a9bff8633f47efc7793ae0ffe87b402b0">MDC</a> (const std::wstring &key, const std::wstring &value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Places a key/value pair in the <a class="el" href="classlog4cxx_1_1_m_d_c.html" title="The MDC class is similar to the NDC class except that it is based on a map instead of a stack...">MDC</a> for the current thread which will be removed during the corresponding destructor. <a href="#a9bff8633f47efc7793ae0ffe87b402b0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_m_d_c.html#a1f471b3d239689db97778aa17e3f5ed8">MDC</a> (const std::basic_string< <a class="el" href="namespacelog4cxx.html#a7edf438a3547255847b2b903b1a36aaf">UniChar</a> > &key, const std::basic_string< <a class="el" href="namespacelog4cxx.html#a7edf438a3547255847b2b903b1a36aaf">UniChar</a> > &value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Places a key/value pair in the <a class="el" href="classlog4cxx_1_1_m_d_c.html" title="The MDC class is similar to the NDC class except that it is based on a map instead of a stack...">MDC</a> for the current thread which will be removed during the corresponding destructor. <a href="#a1f471b3d239689db97778aa17e3f5ed8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_m_d_c.html#a2f3bcadbb0e6a4cc8a8f1499c8866450">MDC</a> (const <a class="el" href="logstring_8h.html#ad35eb97932d08076f748ac657b1ae024">CFStringRef</a> &key, const <a class="el" href="logstring_8h.html#ad35eb97932d08076f748ac657b1ae024">CFStringRef</a> &value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Places a key/value pair in the <a class="el" href="classlog4cxx_1_1_m_d_c.html" title="The MDC class is similar to the NDC class except that it is based on a map instead of a stack...">MDC</a> for the current thread which will be removed during the corresponding destructor. <a href="#a2f3bcadbb0e6a4cc8a8f1499c8866450"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_m_d_c.html#a45472f2d9b761da3eb25360daff9f476">put</a> (const std::string &key, const std::string &value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Put a context value (the <code>o</code> parameter) as identified with the <code>key</code> parameter into the current thread's context map. <a href="#a45472f2d9b761da3eb25360daff9f476"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_m_d_c.html#abc403a2ab4fb7b3baf41e833afa04ded">putLS</a> (const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &key, const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Put a context value (the <code>o</code> parameter) as identified with the <code>key</code> parameter into the current thread's context map. <a href="#abc403a2ab4fb7b3baf41e833afa04ded"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_m_d_c.html#af6771691bee1cbc5638a1f2109f7167c">get</a> (const std::string &key)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the context identified by the <code>key</code> parameter. <a href="#af6771691bee1cbc5638a1f2109f7167c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_m_d_c.html#a12267159d17fd955fabd3839786dd50a">get</a> (const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &key, <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &dest)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the context identified by the <code>key</code> parameter. <a href="#a12267159d17fd955fabd3839786dd50a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_m_d_c.html#a325037d765f6ce8afa86e60b504dbc3f">remove</a> (const std::string &key)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove the the context identified by the <code>key</code> parameter. <a href="#a325037d765f6ce8afa86e60b504dbc3f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_m_d_c.html#aebfe829030498a0554449e7ab6c68bd0">put</a> (const std::wstring &key, const std::wstring &value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Put a context value (the <code>o</code> parameter) as identified with the <code>key</code> parameter into the current thread's context map. <a href="#aebfe829030498a0554449e7ab6c68bd0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static std::wstring </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_m_d_c.html#a621d0f42c88e15489e0d8052c9fa2803">get</a> (const std::wstring &key)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the context identified by the <code>key</code> parameter. <a href="#a621d0f42c88e15489e0d8052c9fa2803"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static std::wstring </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_m_d_c.html#a504a2e6086951236bfee4ac7719fd518">remove</a> (const std::wstring &key)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove the the context identified by the <code>key</code> parameter. <a href="#a504a2e6086951236bfee4ac7719fd518"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_m_d_c.html#a79706ea375429084ed7628ca41d625f0">put</a> (const std::basic_string< <a class="el" href="namespacelog4cxx.html#a7edf438a3547255847b2b903b1a36aaf">UniChar</a> > &key, const std::basic_string< <a class="el" href="namespacelog4cxx.html#a7edf438a3547255847b2b903b1a36aaf">UniChar</a> > &value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Put a context value (the <code>o</code> parameter) as identified with the <code>key</code> parameter into the current thread's context map. <a href="#a79706ea375429084ed7628ca41d625f0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static std::basic_string< <a class="el" href="namespacelog4cxx.html#a7edf438a3547255847b2b903b1a36aaf">UniChar</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_m_d_c.html#a37725f032994dd4dfa5be6bc5404ca68">get</a> (const std::basic_string< <a class="el" href="namespacelog4cxx.html#a7edf438a3547255847b2b903b1a36aaf">UniChar</a> > &key)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the context identified by the <code>key</code> parameter. <a href="#a37725f032994dd4dfa5be6bc5404ca68"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static std::basic_string< <a class="el" href="namespacelog4cxx.html#a7edf438a3547255847b2b903b1a36aaf">UniChar</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_m_d_c.html#a19a4dee0cfe0d67ae0f53920ec50f173">remove</a> (const std::basic_string< <a class="el" href="namespacelog4cxx.html#a7edf438a3547255847b2b903b1a36aaf">UniChar</a> > &key)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove the the context identified by the <code>key</code> parameter. <a href="#a19a4dee0cfe0d67ae0f53920ec50f173"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_m_d_c.html#a3cb3daef64fd647a59dbdc2c637ab888">put</a> (const <a class="el" href="logstring_8h.html#ad35eb97932d08076f748ac657b1ae024">CFStringRef</a> &key, const <a class="el" href="logstring_8h.html#ad35eb97932d08076f748ac657b1ae024">CFStringRef</a> &value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Put a context value (the <code>o</code> parameter) as identified with the <code>key</code> parameter into the current thread's context map. <a href="#a3cb3daef64fd647a59dbdc2c637ab888"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="logstring_8h.html#ad35eb97932d08076f748ac657b1ae024">CFStringRef</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_m_d_c.html#ad125219142104426a6d1c2dae8558096">get</a> (const <a class="el" href="logstring_8h.html#ad35eb97932d08076f748ac657b1ae024">CFStringRef</a> &key)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the context identified by the <code>key</code> parameter. <a href="#ad125219142104426a6d1c2dae8558096"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="logstring_8h.html#ad35eb97932d08076f748ac657b1ae024">CFStringRef</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_m_d_c.html#abe858b545c5426fdc13aded56e8236d9">remove</a> (const <a class="el" href="logstring_8h.html#ad35eb97932d08076f748ac657b1ae024">CFStringRef</a> &key)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove the the context identified by the <code>key</code> parameter. <a href="#abe858b545c5426fdc13aded56e8236d9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_m_d_c.html#a9dce34e433ae0c4f6c3d28a0d90990a6">remove</a> (const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &key, <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &prevValue)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove the the context identified by the <code>key</code> parameter. <a href="#a9dce34e433ae0c4f6c3d28a0d90990a6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_m_d_c.html#a14dabca7589b28dc6adca2c5367546e1">clear</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clear all entries in the <a class="el" href="classlog4cxx_1_1_m_d_c.html" title="The MDC class is similar to the NDC class except that it is based on a map instead of a stack...">MDC</a>. <a href="#a14dabca7589b28dc6adca2c5367546e1"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>The <a class="el" href="classlog4cxx_1_1_m_d_c.html" title="The MDC class is similar to the NDC class except that it is based on a map instead of a stack...">MDC</a> class is similar to the <a class="el" href="classlog4cxx_1_1_n_d_c.html">NDC</a> class except that it is based on a map instead of a stack. </p>
<p>It provides <em>mapped diagnostic contexts</em>. A <em>Mapped Diagnostic Context</em>, or <a class="el" href="classlog4cxx_1_1_m_d_c.html" title="The MDC class is similar to the NDC class except that it is based on a map instead of a stack...">MDC</a> in short, is an instrument for distinguishing interleaved log output from different sources. Log output is typically interleaved when a server handles multiple clients near-simultaneously.</p>
<p><b><em>The <a class="el" href="classlog4cxx_1_1_m_d_c.html" title="The MDC class is similar to the NDC class except that it is based on a map instead of a stack...">MDC</a> is managed on a per thread basis</em></b>. A child thread automatically inherits a <em>copy</em> of the mapped diagnostic context of its parent. </p>
</div><hr/><h2>Member Typedef Documentation</h2>
<a class="anchor" id="a4030dd6e2d8a76b6c585d1cef5263bc3"></a><!-- doxytag: member="log4cxx::MDC::Map" ref="a4030dd6e2d8a76b6c585d1cef5263bc3" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef std::map<<a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a>, <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a>> <a class="el" href="classlog4cxx_1_1_m_d_c.html#a4030dd6e2d8a76b6c585d1cef5263bc3">Map</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>String to string stl map. </p>
</div>
</div>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a2a882b816aa637e1543c6a570dd1a7eb"></a><!-- doxytag: member="log4cxx::MDC::MDC" ref="a2a882b816aa637e1543c6a570dd1a7eb" args="(const std::string &key, const std::string &value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlog4cxx_1_1_m_d_c.html">MDC</a> </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Places a key/value pair in the <a class="el" href="classlog4cxx_1_1_m_d_c.html" title="The MDC class is similar to the NDC class except that it is based on a map instead of a stack...">MDC</a> for the current thread which will be removed during the corresponding destructor. </p>
<p>Both construction and destruction are expected to be on the same thread. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td>key </td></tr>
<tr><td class="paramname">value</td><td>value. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a2326d5a5e81116eee25aa4d2c39c49e9"></a><!-- doxytag: member="log4cxx::MDC::~MDC" ref="a2326d5a5e81116eee25aa4d2c39c49e9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">~<a class="el" href="classlog4cxx_1_1_m_d_c.html">MDC</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a9bff8633f47efc7793ae0ffe87b402b0"></a><!-- doxytag: member="log4cxx::MDC::MDC" ref="a9bff8633f47efc7793ae0ffe87b402b0" args="(const std::wstring &key, const std::wstring &value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlog4cxx_1_1_m_d_c.html">MDC</a> </td>
<td>(</td>
<td class="paramtype">const std::wstring & </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::wstring & </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Places a key/value pair in the <a class="el" href="classlog4cxx_1_1_m_d_c.html" title="The MDC class is similar to the NDC class except that it is based on a map instead of a stack...">MDC</a> for the current thread which will be removed during the corresponding destructor. </p>
<p>Both construction and destruction are expected to be on the same thread. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td>key </td></tr>
<tr><td class="paramname">value</td><td>value. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a1f471b3d239689db97778aa17e3f5ed8"></a><!-- doxytag: member="log4cxx::MDC::MDC" ref="a1f471b3d239689db97778aa17e3f5ed8" args="(const std::basic_string< UniChar > &key, const std::basic_string< UniChar > &value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlog4cxx_1_1_m_d_c.html">MDC</a> </td>
<td>(</td>
<td class="paramtype">const std::basic_string< <a class="el" href="namespacelog4cxx.html#a7edf438a3547255847b2b903b1a36aaf">UniChar</a> > & </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::basic_string< <a class="el" href="namespacelog4cxx.html#a7edf438a3547255847b2b903b1a36aaf">UniChar</a> > & </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Places a key/value pair in the <a class="el" href="classlog4cxx_1_1_m_d_c.html" title="The MDC class is similar to the NDC class except that it is based on a map instead of a stack...">MDC</a> for the current thread which will be removed during the corresponding destructor. </p>
<p>Both construction and destruction are expected to be on the same thread. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td>key </td></tr>
<tr><td class="paramname">value</td><td>value. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a2f3bcadbb0e6a4cc8a8f1499c8866450"></a><!-- doxytag: member="log4cxx::MDC::MDC" ref="a2f3bcadbb0e6a4cc8a8f1499c8866450" args="(const CFStringRef &key, const CFStringRef &value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlog4cxx_1_1_m_d_c.html">MDC</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="logstring_8h.html#ad35eb97932d08076f748ac657b1ae024">CFStringRef</a> & </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="logstring_8h.html#ad35eb97932d08076f748ac657b1ae024">CFStringRef</a> & </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Places a key/value pair in the <a class="el" href="classlog4cxx_1_1_m_d_c.html" title="The MDC class is similar to the NDC class except that it is based on a map instead of a stack...">MDC</a> for the current thread which will be removed during the corresponding destructor. </p>
<p>Both construction and destruction are expected to be on the same thread. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td>key </td></tr>
<tr><td class="paramname">value</td><td>value. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a14dabca7589b28dc6adca2c5367546e1"></a><!-- doxytag: member="log4cxx::MDC::clear" ref="a14dabca7589b28dc6adca2c5367546e1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void clear </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Clear all entries in the <a class="el" href="classlog4cxx_1_1_m_d_c.html" title="The MDC class is similar to the NDC class except that it is based on a map instead of a stack...">MDC</a>. </p>
</div>
</div>
<a class="anchor" id="af6771691bee1cbc5638a1f2109f7167c"></a><!-- doxytag: member="log4cxx::MDC::get" ref="af6771691bee1cbc5638a1f2109f7167c" args="(const std::string &key)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static std::string get </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>key</em></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the context identified by the <code>key</code> parameter. </p>
<p>This method has no side effects. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td>key. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>value for key, empty if not set. </dd></dl>
</div>
</div>
<a class="anchor" id="a12267159d17fd955fabd3839786dd50a"></a><!-- doxytag: member="log4cxx::MDC::get" ref="a12267159d17fd955fabd3839786dd50a" args="(const LogString &key, LogString &dest)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static bool get </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>dest</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the context identified by the <code>key</code> parameter. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td>context key. </td></tr>
<tr><td class="paramname">dest</td><td>destination to which value is appended. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if key has associated value. </dd></dl>
</div>
</div>
<a class="anchor" id="a37725f032994dd4dfa5be6bc5404ca68"></a><!-- doxytag: member="log4cxx::MDC::get" ref="a37725f032994dd4dfa5be6bc5404ca68" args="(const std::basic_string< UniChar > &key)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static std::basic_string<<a class="el" href="namespacelog4cxx.html#a7edf438a3547255847b2b903b1a36aaf">UniChar</a>> get </td>
<td>(</td>
<td class="paramtype">const std::basic_string< <a class="el" href="namespacelog4cxx.html#a7edf438a3547255847b2b903b1a36aaf">UniChar</a> > & </td>
<td class="paramname"><em>key</em></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the context identified by the <code>key</code> parameter. </p>
<p>This method has no side effects. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td>key. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>value for key, empty if not set. </dd></dl>
</div>
</div>
<a class="anchor" id="a621d0f42c88e15489e0d8052c9fa2803"></a><!-- doxytag: member="log4cxx::MDC::get" ref="a621d0f42c88e15489e0d8052c9fa2803" args="(const std::wstring &key)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static std::wstring get </td>
<td>(</td>
<td class="paramtype">const std::wstring & </td>
<td class="paramname"><em>key</em></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the context identified by the <code>key</code> parameter. </p>
<p>This method has no side effects. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td>key. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>value for key, empty if not set. </dd></dl>
</div>
</div>
<a class="anchor" id="ad125219142104426a6d1c2dae8558096"></a><!-- doxytag: member="log4cxx::MDC::get" ref="ad125219142104426a6d1c2dae8558096" args="(const CFStringRef &key)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="logstring_8h.html#ad35eb97932d08076f748ac657b1ae024">CFStringRef</a> get </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="logstring_8h.html#ad35eb97932d08076f748ac657b1ae024">CFStringRef</a> & </td>
<td class="paramname"><em>key</em></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the context identified by the <code>key</code> parameter. </p>
<p>This method has no side effects. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td>key. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>value for key, empty if not set. </dd></dl>
</div>
</div>
<a class="anchor" id="a79706ea375429084ed7628ca41d625f0"></a><!-- doxytag: member="log4cxx::MDC::put" ref="a79706ea375429084ed7628ca41d625f0" args="(const std::basic_string< UniChar > &key, const std::basic_string< UniChar > &value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void put </td>
<td>(</td>
<td class="paramtype">const std::basic_string< <a class="el" href="namespacelog4cxx.html#a7edf438a3547255847b2b903b1a36aaf">UniChar</a> > & </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::basic_string< <a class="el" href="namespacelog4cxx.html#a7edf438a3547255847b2b903b1a36aaf">UniChar</a> > & </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Put a context value (the <code>o</code> parameter) as identified with the <code>key</code> parameter into the current thread's context map. </p>
<p>If the current thread does not have a context map it is created as a side effect. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td>key </td></tr>
<tr><td class="paramname">value</td><td>value. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a3cb3daef64fd647a59dbdc2c637ab888"></a><!-- doxytag: member="log4cxx::MDC::put" ref="a3cb3daef64fd647a59dbdc2c637ab888" args="(const CFStringRef &key, const CFStringRef &value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void put </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="logstring_8h.html#ad35eb97932d08076f748ac657b1ae024">CFStringRef</a> & </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="logstring_8h.html#ad35eb97932d08076f748ac657b1ae024">CFStringRef</a> & </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Put a context value (the <code>o</code> parameter) as identified with the <code>key</code> parameter into the current thread's context map. </p>
<p>If the current thread does not have a context map it is created as a side effect. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td>key </td></tr>
<tr><td class="paramname">value</td><td>value. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aebfe829030498a0554449e7ab6c68bd0"></a><!-- doxytag: member="log4cxx::MDC::put" ref="aebfe829030498a0554449e7ab6c68bd0" args="(const std::wstring &key, const std::wstring &value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void put </td>
<td>(</td>
<td class="paramtype">const std::wstring & </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::wstring & </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Put a context value (the <code>o</code> parameter) as identified with the <code>key</code> parameter into the current thread's context map. </p>
<p>If the current thread does not have a context map it is created as a side effect. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td>key </td></tr>
<tr><td class="paramname">value</td><td>value. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a45472f2d9b761da3eb25360daff9f476"></a><!-- doxytag: member="log4cxx::MDC::put" ref="a45472f2d9b761da3eb25360daff9f476" args="(const std::string &key, const std::string &value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void put </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Put a context value (the <code>o</code> parameter) as identified with the <code>key</code> parameter into the current thread's context map. </p>
<p>If the current thread does not have a context map it is created as a side effect. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td>key </td></tr>
<tr><td class="paramname">value</td><td>value. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="abc403a2ab4fb7b3baf41e833afa04ded"></a><!-- doxytag: member="log4cxx::MDC::putLS" ref="abc403a2ab4fb7b3baf41e833afa04ded" args="(const LogString &key, const LogString &value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void putLS </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Put a context value (the <code>o</code> parameter) as identified with the <code>key</code> parameter into the current thread's context map. </p>
<p>If the current thread does not have a context map it is created as a side effect. </p>
</div>
</div>
<a class="anchor" id="a325037d765f6ce8afa86e60b504dbc3f"></a><!-- doxytag: member="log4cxx::MDC::remove" ref="a325037d765f6ce8afa86e60b504dbc3f" args="(const std::string &key)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static std::string remove </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>key</em></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Remove the the context identified by the <code>key</code> parameter. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td>key. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>value if key had been set, empty if not. </dd></dl>
</div>
</div>
<a class="anchor" id="a9dce34e433ae0c4f6c3d28a0d90990a6"></a><!-- doxytag: member="log4cxx::MDC::remove" ref="a9dce34e433ae0c4f6c3d28a0d90990a6" args="(const LogString &key, LogString &prevValue)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static bool remove </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>prevValue</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Remove the the context identified by the <code>key</code> parameter. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td>key. </td></tr>
<tr><td class="paramname">prevValue</td><td>buffer to which previous value is appended. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if key existed in <a class="el" href="classlog4cxx_1_1_m_d_c.html" title="The MDC class is similar to the NDC class except that it is based on a map instead of a stack...">MDC</a>. </dd></dl>
</div>
</div>
<a class="anchor" id="a19a4dee0cfe0d67ae0f53920ec50f173"></a><!-- doxytag: member="log4cxx::MDC::remove" ref="a19a4dee0cfe0d67ae0f53920ec50f173" args="(const std::basic_string< UniChar > &key)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static std::basic_string<<a class="el" href="namespacelog4cxx.html#a7edf438a3547255847b2b903b1a36aaf">UniChar</a>> remove </td>
<td>(</td>
<td class="paramtype">const std::basic_string< <a class="el" href="namespacelog4cxx.html#a7edf438a3547255847b2b903b1a36aaf">UniChar</a> > & </td>
<td class="paramname"><em>key</em></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Remove the the context identified by the <code>key</code> parameter. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td>key. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>value if key had been set, empty if not. </dd></dl>
</div>
</div>
<a class="anchor" id="a504a2e6086951236bfee4ac7719fd518"></a><!-- doxytag: member="log4cxx::MDC::remove" ref="a504a2e6086951236bfee4ac7719fd518" args="(const std::wstring &key)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static std::wstring remove </td>
<td>(</td>
<td class="paramtype">const std::wstring & </td>
<td class="paramname"><em>key</em></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Remove the the context identified by the <code>key</code> parameter. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td>key. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>value if key had been set, empty if not. </dd></dl>
</div>
</div>
<a class="anchor" id="abe858b545c5426fdc13aded56e8236d9"></a><!-- doxytag: member="log4cxx::MDC::remove" ref="abe858b545c5426fdc13aded56e8236d9" args="(const CFStringRef &key)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="logstring_8h.html#ad35eb97932d08076f748ac657b1ae024">CFStringRef</a> remove </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="logstring_8h.html#ad35eb97932d08076f748ac657b1ae024">CFStringRef</a> & </td>
<td class="paramname"><em>key</em></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Remove the the context identified by the <code>key</code> parameter. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td>key. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>value if key had been set, empty if not. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="mdc_8h.html">mdc.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacelog4cxx.html">log4cxx</a> </li>
<li class="navelem"><a class="el" href="classlog4cxx_1_1_m_d_c.html">MDC</a> </li>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
</BODY>
</HTML>
