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_1ClosureCounter.html
bthomee 33451fdc96 deploy: 1d42c4f6de
2025-11-04 00:36:48 -08:00

575 lines
34 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::ClosureCounter&lt; Ret_t, Args_t &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_1ClosureCounter.html">ClosureCounter</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<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="classripple_1_1ClosureCounter-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::ClosureCounter&lt; Ret_t, Args_t &gt; Class Template Reference</div></div>
</div><!--header-->
<div class="contents">
<p>The role of a <code><a class="el" href="classripple_1_1ClosureCounter.html" title="The role of a ClosureCounter is to assist in shutdown by letting callers wait for the completion of c...">ClosureCounter</a></code> is to assist in shutdown by letting callers wait for the completion of closures (of a specific type signature) that they previously registered.
<a href="classripple_1_1ClosureCounter.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="ClosureCounter_8h_source.html">ClosureCounter.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for ripple::ClosureCounter&lt; Ret_t, Args_t &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1ClosureCounter__coll__graph.png" border="0" usemap="#aripple_1_1ClosureCounter_3_01Ret__t_00_01Args__t_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="aripple_1_1ClosureCounter_3_01Ret__t_00_01Args__t_01_4_coll__map" id="aripple_1_1ClosureCounter_3_01Ret__t_00_01Args__t_01_4_coll__map">
<area shape="rect" title="The role of a ClosureCounter is to assist in shutdown by letting callers wait for the completion of c..." alt="" coords="124,93,291,133"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/thread/mutex.html" title=" " alt="" coords="5,5,97,31"/>
<area shape="poly" title=" " alt="" coords="83,35,177,91,174,95,81,40"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/thread/condition_variable.html" title=" " alt="" coords="122,5,293,31"/>
<area shape="poly" title=" " alt="" coords="210,44,210,93,205,93,205,44"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/atomic/atomic.html" title=" " alt="" coords="317,5,460,31"/>
<area shape="poly" title=" " alt="" coords="381,45,373,59,361,71,328,91,292,103,290,98,325,86,358,67,369,56,377,42"/>
</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="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ClosureCounter_1_1Substitute.html">Substitute</a></td></tr>
<tr class="separator:"><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:a1ae059e35862ae4564be04cd937b77b5" id="r_a1ae059e35862ae4564be04cd937b77b5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ClosureCounter.html#a1ae059e35862ae4564be04cd937b77b5">ClosureCounter</a> ()=default</td></tr>
<tr class="separator:a1ae059e35862ae4564be04cd937b77b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a33ec531a992efd2aa1d54038ba593754" id="r_a33ec531a992efd2aa1d54038ba593754"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ClosureCounter.html#a33ec531a992efd2aa1d54038ba593754">ClosureCounter</a> (<a class="el" href="classripple_1_1ClosureCounter.html">ClosureCounter</a> const &amp;)=delete</td></tr>
<tr class="separator:a33ec531a992efd2aa1d54038ba593754"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:add5769c13c89ad4200869278b9b27ae7" id="r_add5769c13c89ad4200869278b9b27ae7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1ClosureCounter.html">ClosureCounter</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ClosureCounter.html#add5769c13c89ad4200869278b9b27ae7">operator=</a> (<a class="el" href="classripple_1_1ClosureCounter.html">ClosureCounter</a> const &amp;)=delete</td></tr>
<tr class="separator:add5769c13c89ad4200869278b9b27ae7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae81daf5aa300babc764a8d170482230f" id="r_ae81daf5aa300babc764a8d170482230f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ClosureCounter.html#ae81daf5aa300babc764a8d170482230f">~ClosureCounter</a> ()</td></tr>
<tr class="memdesc:ae81daf5aa300babc764a8d170482230f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor verifies all in-flight closures are complete. <br /></td></tr>
<tr class="separator:ae81daf5aa300babc764a8d170482230f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af0786d10092850fd4a1f10d0bec927a7" id="r_af0786d10092850fd4a1f10d0bec927a7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ClosureCounter.html#af0786d10092850fd4a1f10d0bec927a7">join</a> (char const *name, <a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/duration.html">std::chrono::milliseconds</a> wait, <a class="el" href="classbeast_1_1Journal.html">beast::Journal</a> j)</td></tr>
<tr class="memdesc:af0786d10092850fd4a1f10d0bec927a7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns once all counted in-flight closures are destroyed. <br /></td></tr>
<tr class="separator:af0786d10092850fd4a1f10d0bec927a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a14a40130eba0b1a5a12e8b8a0df809b5" id="r_a14a40130eba0b1a5a12e8b8a0df809b5"><td class="memTemplParams" colspan="2">template&lt;class Closure &gt; </td></tr>
<tr class="memitem:a14a40130eba0b1a5a12e8b8a0df809b5"><td class="memTemplItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>&lt; <a class="el" href="classripple_1_1ClosureCounter_1_1Substitute.html">Substitute</a>&lt; Closure &gt; &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classripple_1_1ClosureCounter.html#a14a40130eba0b1a5a12e8b8a0df809b5">wrap</a> (Closure &amp;&amp;closure)</td></tr>
<tr class="memdesc:a14a40130eba0b1a5a12e8b8a0df809b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wrap the passed closure with a reference counter. <br /></td></tr>
<tr class="separator:a14a40130eba0b1a5a12e8b8a0df809b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa2194cbada192730b683d89a27434fb8" id="r_aa2194cbada192730b683d89a27434fb8"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ClosureCounter.html#aa2194cbada192730b683d89a27434fb8">count</a> () const</td></tr>
<tr class="memdesc:aa2194cbada192730b683d89a27434fb8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Current number of Closures outstanding. <br /></td></tr>
<tr class="separator:aa2194cbada192730b683d89a27434fb8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a063738b31b4d437c410ea4e1c2cde160" id="r_a063738b31b4d437c410ea4e1c2cde160"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ClosureCounter.html#a063738b31b4d437c410ea4e1c2cde160">joined</a> () const</td></tr>
<tr class="memdesc:a063738b31b4d437c410ea4e1c2cde160"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if this has been joined. <br /></td></tr>
<tr class="separator:a063738b31b4d437c410ea4e1c2cde160"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-methods" name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr class="memitem:a159b270200c0a146ac2bcd3c7ebf77e6" id="r_a159b270200c0a146ac2bcd3c7ebf77e6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1ClosureCounter.html">ClosureCounter</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ClosureCounter.html#a159b270200c0a146ac2bcd3c7ebf77e6">operator++</a> ()</td></tr>
<tr class="separator:a159b270200c0a146ac2bcd3c7ebf77e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa096cbe5507cabb97e71c83ff25e528d" id="r_aa096cbe5507cabb97e71c83ff25e528d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1ClosureCounter.html">ClosureCounter</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ClosureCounter.html#aa096cbe5507cabb97e71c83ff25e528d">operator--</a> ()</td></tr>
<tr class="separator:aa096cbe5507cabb97e71c83ff25e528d"><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:a7657852232c52a27d41d6ec1a01b39a8" id="r_a7657852232c52a27d41d6ec1a01b39a8"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/thread/mutex.html">std::mutex</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ClosureCounter.html#a7657852232c52a27d41d6ec1a01b39a8">mutex_</a> {}</td></tr>
<tr class="separator:a7657852232c52a27d41d6ec1a01b39a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae88e054a2fb5bf4f9f5098783b2e20fe" id="r_ae88e054a2fb5bf4f9f5098783b2e20fe"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/thread/condition_variable.html">std::condition_variable</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ClosureCounter.html#ae88e054a2fb5bf4f9f5098783b2e20fe">allClosuresDoneCond_</a> {}</td></tr>
<tr class="separator:ae88e054a2fb5bf4f9f5098783b2e20fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6bbb44eb2decd510cba1ea86f023f1b0" id="r_a6bbb44eb2decd510cba1ea86f023f1b0"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ClosureCounter.html#a6bbb44eb2decd510cba1ea86f023f1b0">waitForClosures_</a> {false}</td></tr>
<tr class="separator:a6bbb44eb2decd510cba1ea86f023f1b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6624680820fcf0e17478b71c7c6ab0f1" id="r_a6624680820fcf0e17478b71c7c6ab0f1"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/atomic/atomic.html">std::atomic</a>&lt; int &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ClosureCounter.html#a6624680820fcf0e17478b71c7c6ab0f1">closureCount_</a> {0}</td></tr>
<tr class="separator:a6624680820fcf0e17478b71c7c6ab0f1"><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;typename Ret_t, typename... Args_t&gt;<br />
class ripple::ClosureCounter&lt; Ret_t, Args_t &gt;</div><p>The role of a <code><a class="el" href="classripple_1_1ClosureCounter.html" title="The role of a ClosureCounter is to assist in shutdown by letting callers wait for the completion of c...">ClosureCounter</a></code> is to assist in shutdown by letting callers wait for the completion of closures (of a specific type signature) that they previously registered. </p>
<p>These closures are typically callbacks for asynchronous operations. The lifetime of a <code><a class="el" href="classripple_1_1ClosureCounter.html" title="The role of a ClosureCounter is to assist in shutdown by letting callers wait for the completion of c...">ClosureCounter</a></code> consists of two phases: the initial expanding "fork" phase, and the subsequent shrinking "join" phase.</p>
<p>In the fork phase, callers register a closure by passing the closure and receiving a substitute in return. The substitute has the same callable interface as the closure, and it informs the <code><a class="el" href="classripple_1_1ClosureCounter.html" title="The role of a ClosureCounter is to assist in shutdown by letting callers wait for the completion of c...">ClosureCounter</a></code> whenever it is copied or destroyed, so that it can keep an accurate count of copies.</p>
<p>The transition to the join phase is made by a call to <code>join</code>. In this phase, every substitute returned going forward will be null, signaling to the caller that they should drop the closure and cancel their operation. <code>join</code> blocks until all existing closure substitutes are destroyed.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Ret_t</td><td>The return type of the closure. </td></tr>
<tr><td class="paramname">Args_t</td><td>The argument types of the closure. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="ClosureCounter_8h_source.html#l00035">35</a> of file <a class="el" href="ClosureCounter_8h_source.html">ClosureCounter.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a1ae059e35862ae4564be04cd937b77b5" name="a1ae059e35862ae4564be04cd937b77b5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1ae059e35862ae4564be04cd937b77b5">&#9670;&#160;</a></span>ClosureCounter() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Ret_t , typename... Args_t&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1ClosureCounter.html">ripple::ClosureCounter</a>&lt; Ret_t, Args_t &gt;::ClosureCounter </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a33ec531a992efd2aa1d54038ba593754" name="a33ec531a992efd2aa1d54038ba593754"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a33ec531a992efd2aa1d54038ba593754">&#9670;&#160;</a></span>ClosureCounter() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Ret_t , typename... Args_t&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1ClosureCounter.html">ripple::ClosureCounter</a>&lt; Ret_t, Args_t &gt;::ClosureCounter </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1ClosureCounter.html">ClosureCounter</a>&lt; Ret_t, Args_t &gt; const &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ae81daf5aa300babc764a8d170482230f" name="ae81daf5aa300babc764a8d170482230f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae81daf5aa300babc764a8d170482230f">&#9670;&#160;</a></span>~ClosureCounter()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Ret_t , typename... Args_t&gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1ClosureCounter.html">ripple::ClosureCounter</a>&lt; Ret_t, Args_t &gt;::~<a class="el" href="classripple_1_1ClosureCounter.html">ClosureCounter</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor verifies all in-flight closures are complete. </p>
<p class="definition">Definition at line <a class="el" href="ClosureCounter_8h_source.html#l00134">134</a> of file <a class="el" href="ClosureCounter_8h_source.html">ClosureCounter.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a159b270200c0a146ac2bcd3c7ebf77e6" name="a159b270200c0a146ac2bcd3c7ebf77e6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a159b270200c0a146ac2bcd3c7ebf77e6">&#9670;&#160;</a></span>operator++()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Ret_t , typename... Args_t&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1ClosureCounter.html">ClosureCounter</a> &amp; <a class="el" href="classripple_1_1ClosureCounter.html">ripple::ClosureCounter</a>&lt; Ret_t, Args_t &gt;::operator++ </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></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="ClosureCounter_8h_source.html#l00045">45</a> of file <a class="el" href="ClosureCounter_8h_source.html">ClosureCounter.h</a>.</p>
</div>
</div>
<a id="aa096cbe5507cabb97e71c83ff25e528d" name="aa096cbe5507cabb97e71c83ff25e528d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa096cbe5507cabb97e71c83ff25e528d">&#9670;&#160;</a></span>operator--()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Ret_t , typename... Args_t&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1ClosureCounter.html">ClosureCounter</a> &amp; <a class="el" href="classripple_1_1ClosureCounter.html">ripple::ClosureCounter</a>&lt; Ret_t, Args_t &gt;::operator-- </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></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="ClosureCounter_8h_source.html#l00054">54</a> of file <a class="el" href="ClosureCounter_8h_source.html">ClosureCounter.h</a>.</p>
</div>
</div>
<a id="add5769c13c89ad4200869278b9b27ae7" name="add5769c13c89ad4200869278b9b27ae7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#add5769c13c89ad4200869278b9b27ae7">&#9670;&#160;</a></span>operator=()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Ret_t , typename... Args_t&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1ClosureCounter.html">ClosureCounter</a> &amp; <a class="el" href="classripple_1_1ClosureCounter.html">ripple::ClosureCounter</a>&lt; Ret_t, Args_t &gt;::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1ClosureCounter.html">ClosureCounter</a>&lt; Ret_t, Args_t &gt; const &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="af0786d10092850fd4a1f10d0bec927a7" name="af0786d10092850fd4a1f10d0bec927a7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af0786d10092850fd4a1f10d0bec927a7">&#9670;&#160;</a></span>join()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Ret_t , typename... Args_t&gt; </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classripple_1_1ClosureCounter.html">ripple::ClosureCounter</a>&lt; Ret_t, Args_t &gt;::join </td>
<td>(</td>
<td class="paramtype">char const *&#160;</td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/duration.html">std::chrono::milliseconds</a>&#160;</td>
<td class="paramname"><em>wait</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classbeast_1_1Journal.html">beast::Journal</a>&#160;</td>
<td class="paramname"><em>j</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns once all counted in-flight closures are destroyed. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>Name reported if join time exceeds wait. </td></tr>
<tr><td class="paramname">wait</td><td>If <a class="el" href="classripple_1_1ClosureCounter.html#af0786d10092850fd4a1f10d0bec927a7" title="Returns once all counted in-flight closures are destroyed.">join()</a> exceeds this duration report to Journal. </td></tr>
<tr><td class="paramname">j</td><td>Journal written to if wait is exceeded. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="ClosureCounter_8h_source.html#l00147">147</a> of file <a class="el" href="ClosureCounter_8h_source.html">ClosureCounter.h</a>.</p>
</div>
</div>
<a id="a14a40130eba0b1a5a12e8b8a0df809b5" name="a14a40130eba0b1a5a12e8b8a0df809b5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a14a40130eba0b1a5a12e8b8a0df809b5">&#9670;&#160;</a></span>wrap()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Ret_t , typename... Args_t&gt; </div>
<div class="memtemplate">
template&lt;class Closure &gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>&lt; <a class="el" href="classripple_1_1ClosureCounter_1_1Substitute.html">Substitute</a>&lt; Closure &gt; &gt; <a class="el" href="classripple_1_1ClosureCounter.html">ripple::ClosureCounter</a>&lt; Ret_t, Args_t &gt;::wrap </td>
<td>(</td>
<td class="paramtype">Closure &amp;&amp;&#160;</td>
<td class="paramname"><em>closure</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Wrap the passed closure with a reference counter. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">closure</td><td>Closure that accepts Args_t parameters and returns Ret_t. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>If <a class="el" href="classripple_1_1ClosureCounter.html#af0786d10092850fd4a1f10d0bec927a7" title="Returns once all counted in-flight closures are destroyed.">join()</a> has been called returns <a class="elRef" href="http://en.cppreference.com/w/cpp/types/is_same.html">std::nullopt</a>. Otherwise returns a <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a> that wraps closure with a reference counter. </dd></dl>
<p class="definition">Definition at line <a class="el" href="ClosureCounter_8h_source.html#l00173">173</a> of file <a class="el" href="ClosureCounter_8h_source.html">ClosureCounter.h</a>.</p>
</div>
</div>
<a id="aa2194cbada192730b683d89a27434fb8" name="aa2194cbada192730b683d89a27434fb8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa2194cbada192730b683d89a27434fb8">&#9670;&#160;</a></span>count()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Ret_t , typename... Args_t&gt; </div>
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="classripple_1_1ClosureCounter.html">ripple::ClosureCounter</a>&lt; Ret_t, Args_t &gt;::count </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Current number of Closures outstanding. </p>
<p>Only useful for testing. </p>
<p class="definition">Definition at line <a class="el" href="ClosureCounter_8h_source.html#l00186">186</a> of file <a class="el" href="ClosureCounter_8h_source.html">ClosureCounter.h</a>.</p>
</div>
</div>
<a id="a063738b31b4d437c410ea4e1c2cde160" name="a063738b31b4d437c410ea4e1c2cde160"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a063738b31b4d437c410ea4e1c2cde160">&#9670;&#160;</a></span>joined()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Ret_t , typename... Args_t&gt; </div>
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classripple_1_1ClosureCounter.html">ripple::ClosureCounter</a>&lt; Ret_t, Args_t &gt;::joined </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if this has been joined. </p>
<p>Even if true is returned, counted closures may still be in flight. However if (<a class="el" href="classripple_1_1ClosureCounter.html#a063738b31b4d437c410ea4e1c2cde160" title="Returns true if this has been joined.">joined()</a> &amp;&amp; (<a class="el" href="classripple_1_1ClosureCounter.html#aa2194cbada192730b683d89a27434fb8" title="Current number of Closures outstanding.">count()</a> == 0)) there should be no more counted closures in flight. </p>
<p class="definition">Definition at line <a class="el" href="ClosureCounter_8h_source.html#l00198">198</a> of file <a class="el" href="ClosureCounter_8h_source.html">ClosureCounter.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a7657852232c52a27d41d6ec1a01b39a8" name="a7657852232c52a27d41d6ec1a01b39a8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7657852232c52a27d41d6ec1a01b39a8">&#9670;&#160;</a></span>mutex_</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Ret_t , typename... Args_t&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/thread/mutex.html">std::mutex</a> <a class="el" href="classripple_1_1ClosureCounter.html">ripple::ClosureCounter</a>&lt; Ret_t, Args_t &gt;::mutex_ {}</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">mutable</span><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="ClosureCounter_8h_source.html#l00038">38</a> of file <a class="el" href="ClosureCounter_8h_source.html">ClosureCounter.h</a>.</p>
</div>
</div>
<a id="ae88e054a2fb5bf4f9f5098783b2e20fe" name="ae88e054a2fb5bf4f9f5098783b2e20fe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae88e054a2fb5bf4f9f5098783b2e20fe">&#9670;&#160;</a></span>allClosuresDoneCond_</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Ret_t , typename... Args_t&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/thread/condition_variable.html">std::condition_variable</a> <a class="el" href="classripple_1_1ClosureCounter.html">ripple::ClosureCounter</a>&lt; Ret_t, Args_t &gt;::allClosuresDoneCond_ {}</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="ClosureCounter_8h_source.html#l00039">39</a> of file <a class="el" href="ClosureCounter_8h_source.html">ClosureCounter.h</a>.</p>
</div>
</div>
<a id="a6bbb44eb2decd510cba1ea86f023f1b0" name="a6bbb44eb2decd510cba1ea86f023f1b0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6bbb44eb2decd510cba1ea86f023f1b0">&#9670;&#160;</a></span>waitForClosures_</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Ret_t , typename... Args_t&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classripple_1_1ClosureCounter.html">ripple::ClosureCounter</a>&lt; Ret_t, Args_t &gt;::waitForClosures_ {false}</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="ClosureCounter_8h_source.html#l00040">40</a> of file <a class="el" href="ClosureCounter_8h_source.html">ClosureCounter.h</a>.</p>
</div>
</div>
<a id="a6624680820fcf0e17478b71c7c6ab0f1" name="a6624680820fcf0e17478b71c7c6ab0f1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6624680820fcf0e17478b71c7c6ab0f1">&#9670;&#160;</a></span>closureCount_</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Ret_t , typename... Args_t&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/atomic/atomic.html">std::atomic</a>&lt;int&gt; <a class="el" href="classripple_1_1ClosureCounter.html">ripple::ClosureCounter</a>&lt; Ret_t, Args_t &gt;::closureCount_ {0}</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="ClosureCounter_8h_source.html#l00041">41</a> of file <a class="el" href="ClosureCounter_8h_source.html">ClosureCounter.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