ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-20 11:05:54 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
rippled/classripple_1_1basic__semaphore.html
bthomee 33451fdc96 deploy: 1d42c4f6de
2025-11-04 00:36:48 -08:00

340 lines
18 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: ripple::basic_semaphore&lt; Mutex, CondVar &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="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 id="projectrow">
<td id="projectalign">
<div id="projectname">rippled
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- 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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceripple.html">ripple</a></li><li class="navelem"><a class="el" href="classripple_1_1basic__semaphore.html">basic_semaphore</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classripple_1_1basic__semaphore-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::basic_semaphore&lt; Mutex, CondVar &gt; Class Template Reference</div></div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="semaphore_8h_source.html">semaphore.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for ripple::basic_semaphore&lt; Mutex, CondVar &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1basic__semaphore__coll__graph.png" border="0" usemap="#aripple_1_1basic__semaphore_3_01Mutex_00_01CondVar_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="aripple_1_1basic__semaphore_3_01Mutex_00_01CondVar_01_4_coll__map" id="aripple_1_1basic__semaphore_3_01Mutex_00_01CondVar_01_4_coll__map">
<area shape="rect" title=" " alt="" coords="5,93,187,133"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/size_t.html" title=" " alt="" coords="52,5,140,31"/>
<area shape="poly" title=" " alt="" coords="99,44,99,93,93,93,93,44"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a70b65a73bd62bd3b1e15f25297514494" id="r_a70b65a73bd62bd3b1e15f25297514494"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1basic__semaphore.html#a70b65a73bd62bd3b1e15f25297514494">size_type</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a></td></tr>
<tr class="separator:a70b65a73bd62bd3b1e15f25297514494"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a881f36997b728fa7093cc0fed4150d8b" id="r_a881f36997b728fa7093cc0fed4150d8b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1basic__semaphore.html#a881f36997b728fa7093cc0fed4150d8b">basic_semaphore</a> (<a class="el" href="classripple_1_1basic__semaphore.html#a70b65a73bd62bd3b1e15f25297514494">size_type</a> count=0)</td></tr>
<tr class="memdesc:a881f36997b728fa7093cc0fed4150d8b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create the semaphore, with an optional initial count. <br /></td></tr>
<tr class="separator:a881f36997b728fa7093cc0fed4150d8b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afb527f24d3a10d885892f8f46d8ce49c" id="r_afb527f24d3a10d885892f8f46d8ce49c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1basic__semaphore.html#afb527f24d3a10d885892f8f46d8ce49c">notify</a> ()</td></tr>
<tr class="memdesc:afb527f24d3a10d885892f8f46d8ce49c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Increment the count and unblock one waiting thread. <br /></td></tr>
<tr class="separator:afb527f24d3a10d885892f8f46d8ce49c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4f15dff9ed04010b49cef17aa46b683b" id="r_a4f15dff9ed04010b49cef17aa46b683b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1basic__semaphore.html#a4f15dff9ed04010b49cef17aa46b683b">wait</a> ()</td></tr>
<tr class="memdesc:a4f15dff9ed04010b49cef17aa46b683b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Block until notify is called. <br /></td></tr>
<tr class="separator:a4f15dff9ed04010b49cef17aa46b683b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8b281f8b0690027c7f5c8071e866a013" id="r_a8b281f8b0690027c7f5c8071e866a013"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1basic__semaphore.html#a8b281f8b0690027c7f5c8071e866a013">try_wait</a> ()</td></tr>
<tr class="memdesc:a8b281f8b0690027c7f5c8071e866a013"><td class="mdescLeft">&#160;</td><td class="mdescRight">Perform a non-blocking wait. <br /></td></tr>
<tr class="separator:a8b281f8b0690027c7f5c8071e866a013"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a4cdfd0582d4673cb56de9d9de689aadc" id="r_a4cdfd0582d4673cb56de9d9de689aadc"><td class="memItemLeft" align="right" valign="top">Mutex&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1basic__semaphore.html#a4cdfd0582d4673cb56de9d9de689aadc">m_mutex</a></td></tr>
<tr class="separator:a4cdfd0582d4673cb56de9d9de689aadc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae88049f63899f4ed72c788b4b1f989be" id="r_ae88049f63899f4ed72c788b4b1f989be"><td class="memItemLeft" align="right" valign="top">CondVar&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1basic__semaphore.html#ae88049f63899f4ed72c788b4b1f989be">m_cond</a></td></tr>
<tr class="separator:ae88049f63899f4ed72c788b4b1f989be"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4e32a2af04d2aadf63f616543049f999" id="r_a4e32a2af04d2aadf63f616543049f999"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1basic__semaphore.html#a4e32a2af04d2aadf63f616543049f999">m_count</a></td></tr>
<tr class="separator:a4e32a2af04d2aadf63f616543049f999"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template&lt;class Mutex, class CondVar&gt;<br />
class ripple::basic_semaphore&lt; Mutex, CondVar &gt;</div>
<p class="definition">Definition at line <a class="el" href="semaphore_8h_source.html#l00038">38</a> of file <a class="el" href="semaphore_8h_source.html">semaphore.h</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a70b65a73bd62bd3b1e15f25297514494" name="a70b65a73bd62bd3b1e15f25297514494"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a70b65a73bd62bd3b1e15f25297514494">&#9670;&#160;</a></span>size_type</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Mutex , class CondVar &gt; </div>
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classripple_1_1basic__semaphore.html">ripple::basic_semaphore</a>&lt; Mutex, CondVar &gt;::size_type = <a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="semaphore_8h_source.html#l00046">46</a> of file <a class="el" href="semaphore_8h_source.html">semaphore.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a881f36997b728fa7093cc0fed4150d8b" name="a881f36997b728fa7093cc0fed4150d8b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a881f36997b728fa7093cc0fed4150d8b">&#9670;&#160;</a></span>basic_semaphore()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Mutex , class CondVar &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1basic__semaphore.html">ripple::basic_semaphore</a>&lt; Mutex, CondVar &gt;::basic_semaphore </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1basic__semaphore.html#a70b65a73bd62bd3b1e15f25297514494">size_type</a>&#160;</td>
<td class="paramname"><em>count</em> = <code>0</code></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create the semaphore, with an optional initial count. </p>
<p>If unspecified, the initial count is zero. </p>
<p class="definition">Definition at line <a class="el" href="semaphore_8h_source.html#l00051">51</a> of file <a class="el" href="semaphore_8h_source.html">semaphore.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="afb527f24d3a10d885892f8f46d8ce49c" name="afb527f24d3a10d885892f8f46d8ce49c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afb527f24d3a10d885892f8f46d8ce49c">&#9670;&#160;</a></span>notify()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Mutex , class CondVar &gt; </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classripple_1_1basic__semaphore.html">ripple::basic_semaphore</a>&lt; Mutex, CondVar &gt;::notify </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Increment the count and unblock one waiting thread. </p>
<p class="definition">Definition at line <a class="el" href="semaphore_8h_source.html#l00057">57</a> of file <a class="el" href="semaphore_8h_source.html">semaphore.h</a>.</p>
</div>
</div>
<a id="a4f15dff9ed04010b49cef17aa46b683b" name="a4f15dff9ed04010b49cef17aa46b683b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4f15dff9ed04010b49cef17aa46b683b">&#9670;&#160;</a></span>wait()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Mutex , class CondVar &gt; </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classripple_1_1basic__semaphore.html">ripple::basic_semaphore</a>&lt; Mutex, CondVar &gt;::wait </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Block until notify is called. </p>
<p class="definition">Definition at line <a class="el" href="semaphore_8h_source.html#l00066">66</a> of file <a class="el" href="semaphore_8h_source.html">semaphore.h</a>.</p>
</div>
</div>
<a id="a8b281f8b0690027c7f5c8071e866a013" name="a8b281f8b0690027c7f5c8071e866a013"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8b281f8b0690027c7f5c8071e866a013">&#9670;&#160;</a></span>try_wait()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Mutex , class CondVar &gt; </div>
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classripple_1_1basic__semaphore.html">ripple::basic_semaphore</a>&lt; Mutex, CondVar &gt;::try_wait </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Perform a non-blocking wait. </p>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> If the wait would be satisfied. </dd></dl>
<p class="definition">Definition at line <a class="el" href="semaphore_8h_source.html#l00078">78</a> of file <a class="el" href="semaphore_8h_source.html">semaphore.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a4cdfd0582d4673cb56de9d9de689aadc" name="a4cdfd0582d4673cb56de9d9de689aadc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4cdfd0582d4673cb56de9d9de689aadc">&#9670;&#160;</a></span>m_mutex</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Mutex , class CondVar &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Mutex <a class="el" href="classripple_1_1basic__semaphore.html">ripple::basic_semaphore</a>&lt; Mutex, CondVar &gt;::m_mutex</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="semaphore_8h_source.html#l00041">41</a> of file <a class="el" href="semaphore_8h_source.html">semaphore.h</a>.</p>
</div>
</div>
<a id="ae88049f63899f4ed72c788b4b1f989be" name="ae88049f63899f4ed72c788b4b1f989be"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae88049f63899f4ed72c788b4b1f989be">&#9670;&#160;</a></span>m_cond</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Mutex , class CondVar &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">CondVar <a class="el" href="classripple_1_1basic__semaphore.html">ripple::basic_semaphore</a>&lt; Mutex, CondVar &gt;::m_cond</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="semaphore_8h_source.html#l00042">42</a> of file <a class="el" href="semaphore_8h_source.html">semaphore.h</a>.</p>
</div>
</div>
<a id="a4e32a2af04d2aadf63f616543049f999" name="a4e32a2af04d2aadf63f616543049f999"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4e32a2af04d2aadf63f616543049f999">&#9670;&#160;</a></span>m_count</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Mutex , class CondVar &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> <a class="el" href="classripple_1_1basic__semaphore.html">ripple::basic_semaphore</a>&lt; Mutex, CondVar &gt;::m_count</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="semaphore_8h_source.html#l00043">43</a> of file <a class="el" href="semaphore_8h_source.html">semaphore.h</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink