joshua/dash-docs
1
0
Fork 0
mirror of https://github.com/seigler/dash-docs synced 2025-07-27 17:56:16 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
dash-docs/en/doxygen/html/classCMutexLock.html

443 lines
18 KiB
HTML
Raw Blame History

<!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.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Dash Core: CMutexLock&lt; Mutex &gt; Class Template 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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></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 id="projectlogo"><img alt="Logo" src="bitcoin_logo_doxygen.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Dash Core
&#160;<span id="projectnumber">0.12.2.1</span>
</div>
<div id="projectbrief">P2P Digital Currency</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classCMutexLock.html','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</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 class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classCMutexLock-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">CMutexLock&lt; Mutex &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="sync_8h_source.html">sync.h</a>&gt;</code></p>
<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:a5de553653dbbcc1432d07658fa9b0e8b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCMutexLock.html#a5de553653dbbcc1432d07658fa9b0e8b">CMutexLock</a> (Mutex &amp;mutexIn, const char *pszName, const char *pszFile, int nLine, bool fTry=false) <a class="el" href="threadsafety_8h.html#a77729163b7f6867da40ad5daa5f926f3">EXCLUSIVE_LOCK_FUNCTION</a>(mutexIn)</td></tr>
<tr class="separator:a5de553653dbbcc1432d07658fa9b0e8b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4725b7154d87d0e0eb47c62d299963be"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCMutexLock.html#a4725b7154d87d0e0eb47c62d299963be">CMutexLock</a> (Mutex *pmutexIn, const char *pszName, const char *pszFile, int nLine, bool fTry=false) <a class="el" href="threadsafety_8h.html#a77729163b7f6867da40ad5daa5f926f3">EXCLUSIVE_LOCK_FUNCTION</a>(pmutexIn)</td></tr>
<tr class="separator:a4725b7154d87d0e0eb47c62d299963be"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af475e374b70ac03db516d00f65b723b7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCMutexLock.html#af475e374b70ac03db516d00f65b723b7">~CMutexLock</a> () <a class="el" href="threadsafety_8h.html#abd56e19f9b4781b1a5212a46951cf5c3">UNLOCK_FUNCTION</a>()</td></tr>
<tr class="separator:af475e374b70ac03db516d00f65b723b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4358803c87a873252abebdd1b625d293"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCMutexLock.html#a4358803c87a873252abebdd1b625d293">operator bool</a> ()</td></tr>
<tr class="separator:a4358803c87a873252abebdd1b625d293"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr class="memitem:a8a9f734c76f1b766445bec41b91393dd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCMutexLock.html#a8a9f734c76f1b766445bec41b91393dd">Enter</a> (const char *pszName, const char *pszFile, int nLine)</td></tr>
<tr class="separator:a8a9f734c76f1b766445bec41b91393dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9ba3770fa3e256a183b0ee52ebf048c4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCMutexLock.html#a9ba3770fa3e256a183b0ee52ebf048c4">TryEnter</a> (const char *pszName, const char *pszFile, int nLine)</td></tr>
<tr class="separator:a9ba3770fa3e256a183b0ee52ebf048c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a2f3b4666271388be42da0198ba717744"><td class="memItemLeft" align="right" valign="top">boost::unique_lock&lt; Mutex &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCMutexLock.html#a2f3b4666271388be42da0198ba717744">lock</a></td></tr>
<tr class="separator:a2f3b4666271388be42da0198ba717744"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename Mutex&gt;<br />
class CMutexLock&lt; Mutex &gt;</h3>
<p>Wrapper around boost::unique_lock&lt;Mutex&gt; </p>
<p class="definition">Definition at line <a class="el" href="sync_8h_source.html#l00104">104</a> of file <a class="el" href="sync_8h_source.html">sync.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a5de553653dbbcc1432d07658fa9b0e8b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5de553653dbbcc1432d07658fa9b0e8b">&#9670;&nbsp;</a></span>CMutexLock() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Mutex &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCMutexLock.html">CMutexLock</a>&lt; Mutex &gt;::<a class="el" href="classCMutexLock.html">CMutexLock</a> </td>
<td>(</td>
<td class="paramtype">Mutex &amp;&#160;</td>
<td class="paramname"><em>mutexIn</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>pszName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>pszFile</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>nLine</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>fTry</em> = <code>false</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="sync_8h_source.html#l00132">132</a> of file <a class="el" href="sync_8h_source.html">sync.h</a>.</p>
</div>
</div>
<a id="a4725b7154d87d0e0eb47c62d299963be"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4725b7154d87d0e0eb47c62d299963be">&#9670;&nbsp;</a></span>CMutexLock() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Mutex &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCMutexLock.html">CMutexLock</a>&lt; Mutex &gt;::<a class="el" href="classCMutexLock.html">CMutexLock</a> </td>
<td>(</td>
<td class="paramtype">Mutex *&#160;</td>
<td class="paramname"><em>pmutexIn</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>pszName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>pszFile</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>nLine</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>fTry</em> = <code>false</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="sync_8h_source.html#l00140">140</a> of file <a class="el" href="sync_8h_source.html">sync.h</a>.</p>
</div>
</div>
<a id="af475e374b70ac03db516d00f65b723b7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af475e374b70ac03db516d00f65b723b7">&#9670;&nbsp;</a></span>~CMutexLock()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Mutex &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCMutexLock.html">CMutexLock</a>&lt; Mutex &gt;::~<a class="el" href="classCMutexLock.html">CMutexLock</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="sync_8h_source.html#l00151">151</a> of file <a class="el" href="sync_8h_source.html">sync.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a8a9f734c76f1b766445bec41b91393dd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8a9f734c76f1b766445bec41b91393dd">&#9670;&nbsp;</a></span>Enter()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Mutex &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classCMutexLock.html">CMutexLock</a>&lt; Mutex &gt;::Enter </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>pszName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>pszFile</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>nLine</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="sync_8h_source.html#l00109">109</a> of file <a class="el" href="sync_8h_source.html">sync.h</a>.</p>
</div>
</div>
<a id="a4358803c87a873252abebdd1b625d293"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4358803c87a873252abebdd1b625d293">&#9670;&nbsp;</a></span>operator bool()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Mutex &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCMutexLock.html">CMutexLock</a>&lt; Mutex &gt;::operator bool </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="sync_8h_source.html#l00157">157</a> of file <a class="el" href="sync_8h_source.html">sync.h</a>.</p>
</div>
</div>
<a id="a9ba3770fa3e256a183b0ee52ebf048c4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9ba3770fa3e256a183b0ee52ebf048c4">&#9670;&nbsp;</a></span>TryEnter()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Mutex &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classCMutexLock.html">CMutexLock</a>&lt; Mutex &gt;::TryEnter </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>pszName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>pszFile</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>nLine</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="sync_8h_source.html#l00122">122</a> of file <a class="el" href="sync_8h_source.html">sync.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a2f3b4666271388be42da0198ba717744"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2f3b4666271388be42da0198ba717744">&#9670;&nbsp;</a></span>lock</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Mutex &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">boost::unique_lock&lt;Mutex&gt; <a class="el" href="classCMutexLock.html">CMutexLock</a>&lt; Mutex &gt;::lock</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="sync_8h_source.html#l00107">107</a> of file <a class="el" href="sync_8h_source.html">sync.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/<a class="el" href="sync_8h_source.html">sync.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="classCMutexLock.html">CMutexLock</a></li>
<li class="footer">Generated on Thu Dec 14 2017 13:15:12 for Dash Core by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
</ul>
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink