dash-docs/en/doxygen/html/classCSemaphoreGrant.html

438 lines
19 KiB
HTML

<!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: CSemaphoreGrant 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="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('classCSemaphoreGrant.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-attribs">Private Attributes</a> &#124;
<a href="classCSemaphoreGrant-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">CSemaphoreGrant Class 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:ac52976968379ea8e2470cfba877c3e89"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCSemaphoreGrant.html#ac52976968379ea8e2470cfba877c3e89">Acquire</a> ()</td></tr>
<tr class="separator:ac52976968379ea8e2470cfba877c3e89"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8d985eeace74e037baeb39bd2d586576"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCSemaphoreGrant.html#a8d985eeace74e037baeb39bd2d586576">Release</a> ()</td></tr>
<tr class="separator:a8d985eeace74e037baeb39bd2d586576"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9952d9ea087ced803c099f69992ebb1d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCSemaphoreGrant.html#a9952d9ea087ced803c099f69992ebb1d">TryAcquire</a> ()</td></tr>
<tr class="separator:a9952d9ea087ced803c099f69992ebb1d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab3e6f84f304703abc52517b0c8de26cf"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCSemaphoreGrant.html#ab3e6f84f304703abc52517b0c8de26cf">MoveTo</a> (<a class="el" href="classCSemaphoreGrant.html">CSemaphoreGrant</a> &amp;grant)</td></tr>
<tr class="separator:ab3e6f84f304703abc52517b0c8de26cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a84ca79a4c8519f1a69697c060cabc51d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCSemaphoreGrant.html#a84ca79a4c8519f1a69697c060cabc51d">CSemaphoreGrant</a> ()</td></tr>
<tr class="separator:a84ca79a4c8519f1a69697c060cabc51d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5998c457c7c223a8257166161d12b355"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCSemaphoreGrant.html#a5998c457c7c223a8257166161d12b355">CSemaphoreGrant</a> (<a class="el" href="classCSemaphore.html">CSemaphore</a> &amp;sema, bool fTry=false)</td></tr>
<tr class="separator:a5998c457c7c223a8257166161d12b355"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaba5579eb3ad3647d79e71c9970dcb54"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCSemaphoreGrant.html#aaba5579eb3ad3647d79e71c9970dcb54">~CSemaphoreGrant</a> ()</td></tr>
<tr class="separator:aaba5579eb3ad3647d79e71c9970dcb54"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a91458b860e45949d87d770252e590a9b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCSemaphoreGrant.html#a91458b860e45949d87d770252e590a9b">operator bool</a> ()</td></tr>
<tr class="separator:a91458b860e45949d87d770252e590a9b"><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:afed7f1f7ac912c175dcd9c898fa4e2ed"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCSemaphore.html">CSemaphore</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCSemaphoreGrant.html#afed7f1f7ac912c175dcd9c898fa4e2ed">sem</a></td></tr>
<tr class="separator:afed7f1f7ac912c175dcd9c898fa4e2ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0c416dd364ca4d085555d69658c060e3"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCSemaphoreGrant.html#a0c416dd364ca4d085555d69658c060e3">fHaveGrant</a></td></tr>
<tr class="separator:a0c416dd364ca4d085555d69658c060e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>RAII-style semaphore lock </p>
<p class="definition">Definition at line <a class="el" href="sync_8h_source.html#l00223">223</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="a84ca79a4c8519f1a69697c060cabc51d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a84ca79a4c8519f1a69697c060cabc51d">&#9670;&nbsp;</a></span>CSemaphoreGrant() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">CSemaphoreGrant::CSemaphoreGrant </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#l00262">262</a> of file <a class="el" href="sync_8h_source.html">sync.h</a>.</p>
</div>
</div>
<a id="a5998c457c7c223a8257166161d12b355"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5998c457c7c223a8257166161d12b355">&#9670;&nbsp;</a></span>CSemaphoreGrant() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">CSemaphoreGrant::CSemaphoreGrant </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCSemaphore.html">CSemaphore</a> &amp;&#160;</td>
<td class="paramname"><em>sema</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#l00264">264</a> of file <a class="el" href="sync_8h_source.html">sync.h</a>.</p>
</div>
</div>
<a id="aaba5579eb3ad3647d79e71c9970dcb54"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaba5579eb3ad3647d79e71c9970dcb54">&#9670;&nbsp;</a></span>~CSemaphoreGrant()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">CSemaphoreGrant::~CSemaphoreGrant </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#l00272">272</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="ac52976968379ea8e2470cfba877c3e89"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac52976968379ea8e2470cfba877c3e89">&#9670;&nbsp;</a></span>Acquire()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void CSemaphoreGrant::Acquire </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#l00230">230</a> of file <a class="el" href="sync_8h_source.html">sync.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="sync_8h_source.html#l00264">CSemaphoreGrant()</a>.</p>
</div>
</div>
<a id="ab3e6f84f304703abc52517b0c8de26cf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab3e6f84f304703abc52517b0c8de26cf">&#9670;&nbsp;</a></span>MoveTo()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void CSemaphoreGrant::MoveTo </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCSemaphoreGrant.html">CSemaphoreGrant</a> &amp;&#160;</td>
<td class="paramname"><em>grant</em></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#l00253">253</a> of file <a class="el" href="sync_8h_source.html">sync.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="net_8cpp_source.html#l01886">CConnman::OpenNetworkConnection()</a>, and <a class="el" href="net_8cpp_source.html#l01842">CConnman::ThreadMnbRequestConnections()</a>.</p>
</div>
</div>
<a id="a91458b860e45949d87d770252e590a9b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a91458b860e45949d87d770252e590a9b">&#9670;&nbsp;</a></span>operator bool()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">CSemaphoreGrant::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#l00277">277</a> of file <a class="el" href="sync_8h_source.html">sync.h</a>.</p>
</div>
</div>
<a id="a8d985eeace74e037baeb39bd2d586576"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8d985eeace74e037baeb39bd2d586576">&#9670;&nbsp;</a></span>Release()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void CSemaphoreGrant::Release </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#l00238">238</a> of file <a class="el" href="sync_8h_source.html">sync.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="sync_8h_source.html#l00253">MoveTo()</a>, <a class="el" href="net_8cpp_source.html#l01109">CConnman::ThreadSocketHandler()</a>, and <a class="el" href="sync_8h_source.html#l00272">~CSemaphoreGrant()</a>.</p>
</div>
</div>
<a id="a9952d9ea087ced803c099f69992ebb1d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9952d9ea087ced803c099f69992ebb1d">&#9670;&nbsp;</a></span>TryAcquire()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool CSemaphoreGrant::TryAcquire </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#l00246">246</a> of file <a class="el" href="sync_8h_source.html">sync.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="sync_8h_source.html#l00264">CSemaphoreGrant()</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a0c416dd364ca4d085555d69658c060e3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0c416dd364ca4d085555d69658c060e3">&#9670;&nbsp;</a></span>fHaveGrant</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool CSemaphoreGrant::fHaveGrant</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#l00227">227</a> of file <a class="el" href="sync_8h_source.html">sync.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="sync_8h_source.html#l00230">Acquire()</a>, <a class="el" href="sync_8h_source.html#l00253">MoveTo()</a>, <a class="el" href="sync_8h_source.html#l00277">operator bool()</a>, <a class="el" href="sync_8h_source.html#l00238">Release()</a>, and <a class="el" href="sync_8h_source.html#l00246">TryAcquire()</a>.</p>
</div>
</div>
<a id="afed7f1f7ac912c175dcd9c898fa4e2ed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afed7f1f7ac912c175dcd9c898fa4e2ed">&#9670;&nbsp;</a></span>sem</h2>
<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="classCSemaphore.html">CSemaphore</a>* CSemaphoreGrant::sem</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#l00226">226</a> of file <a class="el" href="sync_8h_source.html">sync.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="sync_8h_source.html#l00230">Acquire()</a>, <a class="el" href="sync_8h_source.html#l00253">MoveTo()</a>, <a class="el" href="sync_8h_source.html#l00238">Release()</a>, and <a class="el" href="sync_8h_source.html#l00246">TryAcquire()</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="classCSemaphoreGrant.html">CSemaphoreGrant</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>