<!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::threading Namespace 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 class="current"><a href="namespaces.html"><span>Namespaces</span></a></li> <li><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="namespaces.html"><span>Namespace List</span></a></li> <li><a href="namespacemembers.html"><span>Namespace 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="namespacelog4shib_1_1threading.html">threading</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#nested-classes">Classes</a> | <a href="#typedef-members">Typedefs</a> | <a href="#func-members">Functions</a> </div> <div class="headertitle"> <div class="title">log4shib::threading Namespace Reference</div> </div> </div><!--header--> <div class="contents"> <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">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1threading_1_1ThreadLocalDataHolder.html">ThreadLocalDataHolder</a></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">This class holds Thread local data of type T, i.e. <a href="classlog4shib_1_1threading_1_1ThreadLocalDataHolder.html#details">More...</a><br/></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1threading_1_1MSMutex.html">MSMutex</a></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A simple object wrapper around CreateMutex() and DeleteMutex() <a href="classlog4shib_1_1threading_1_1MSMutex.html#details">More...</a><br/></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1threading_1_1MSScopedLock.html">MSScopedLock</a></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A simple object wrapper around WaitForSingleObject() and ReleaseMutex() <a href="classlog4shib_1_1threading_1_1MSScopedLock.html#details">More...</a><br/></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1threading_1_1Mutex.html">Mutex</a></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4shib_1_1threading_1_1ScopedLock.html">ScopedLock</a></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">definition of <a class="el" href="classlog4shib_1_1threading_1_1ScopedLock.html" title="definition of ScopedLock; ">ScopedLock</a>; <a href="classlog4shib_1_1threading_1_1ScopedLock.html#details">More...</a><br/></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="typedef-members"></a> Typedefs</h2></td></tr> <tr class="memitem:a5974027637ea5eca724d59a77032ab46"><td class="memItemLeft" align="right" valign="top">typedef boost::mutex </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacelog4shib_1_1threading.html#a5974027637ea5eca724d59a77032ab46">Mutex</a></td></tr> <tr class="memdesc:a5974027637ea5eca724d59a77032ab46"><td class="mdescLeft"> </td><td class="mdescRight">Dummy type 'int' for <a class="el" href="classlog4shib_1_1threading_1_1Mutex.html">Mutex</a>. <a href="#a5974027637ea5eca724d59a77032ab46">More...</a><br/></td></tr> <tr class="separator:a5974027637ea5eca724d59a77032ab46"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a70910f3cbd78820431dea72fd911c9eb"><td class="memItemLeft" align="right" valign="top">typedef boost::mutex::scoped_lock </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacelog4shib_1_1threading.html#a70910f3cbd78820431dea72fd911c9eb">ScopedLock</a></td></tr> <tr class="memdesc:a70910f3cbd78820431dea72fd911c9eb"><td class="mdescLeft"> </td><td class="mdescRight">Dummy type 'int' defintion of <a class="el" href="classlog4shib_1_1threading_1_1ScopedLock.html" title="definition of ScopedLock; ">ScopedLock</a>;. <a href="#a70910f3cbd78820431dea72fd911c9eb">More...</a><br/></td></tr> <tr class="separator:a70910f3cbd78820431dea72fd911c9eb"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> Functions</h2></td></tr> <tr class="memitem:a4dca29fd2a98886d9dc075b246075bf8"><td class="memItemLeft" align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacelog4shib_1_1threading.html#a4dca29fd2a98886d9dc075b246075bf8">getThreadId</a> ()</td></tr> <tr class="memdesc:a4dca29fd2a98886d9dc075b246075bf8"><td class="mdescLeft"> </td><td class="mdescRight">Return an identifier for the current thread. <a href="#a4dca29fd2a98886d9dc075b246075bf8">More...</a><br/></td></tr> <tr class="separator:a4dca29fd2a98886d9dc075b246075bf8"><td class="memSeparator" colspan="2"> </td></tr> </table> <h2 class="groupheader">Typedef Documentation</h2> <a class="anchor" id="a5974027637ea5eca724d59a77032ab46"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef omni_mutex <a class="el" href="classlog4shib_1_1threading_1_1Mutex.html">log4shib::threading::Mutex</a></td> </tr> </table> </div><div class="memdoc"> <p>Dummy type 'int' for <a class="el" href="classlog4shib_1_1threading_1_1Mutex.html">Mutex</a>. </p> <p>A simple, non recursive <a class="el" href="classlog4shib_1_1threading_1_1Mutex.html">Mutex</a>.</p> <p>Yes, this adds a bit of overhead in the for of extra memory, but unfortunately 'void' is illegal.</p> <p>Equivalent to Boost.Threads boost::mutex </p> </div> </div> <a class="anchor" id="a70910f3cbd78820431dea72fd911c9eb"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef omni_mutex_lock <a class="el" href="classlog4shib_1_1threading_1_1ScopedLock.html">log4shib::threading::ScopedLock</a></td> </tr> </table> </div><div class="memdoc"> <p>Dummy type 'int' defintion of <a class="el" href="classlog4shib_1_1threading_1_1ScopedLock.html" title="definition of ScopedLock; ">ScopedLock</a>;. </p> <p>A simple "resource acquisition is initialization" idiom type lock for <a class="el" href="classlog4shib_1_1threading_1_1Mutex.html">Mutex</a>.</p> <p>Equivalent to Boost.Threads boost::scoped_lock. </p> </div> </div> <h2 class="groupheader">Function Documentation</h2> <a class="anchor" id="a4dca29fd2a98886d9dc075b246075bf8"></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::threading::getThreadId </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 an identifier for the current thread. </p> <p>returns the thread ID</p> <p>What these identifiers look like is completely up to the underlying thread library.</p> <p>What these identifiers look like is completely up to the underlying thread library. OmniThreads returns the POSIX thread Id. </p> </div> </div> </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>