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

258 lines
13 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::AsyncObject&lt; Derived &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_1AsyncObject.html">AsyncObject</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="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classripple_1_1AsyncObject-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::AsyncObject&lt; Derived &gt; Class Template Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Mix-in to track when all pending I/O is complete.
<a href="classripple_1_1AsyncObject.html#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for ripple::AsyncObject&lt; Derived &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1AsyncObject__coll__graph.png" border="0" usemap="#aripple_1_1AsyncObject_3_01Derived_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="aripple_1_1AsyncObject_3_01Derived_01_4_coll__map" id="aripple_1_1AsyncObject_3_01Derived_01_4_coll__map">
<area shape="rect" title="Mix&#45;in to track when all pending I/O is complete." alt="" coords="5,93,153,133"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/atomic/atomic.html" title=" " alt="" coords="8,5,151,31"/>
<area shape="poly" title=" " alt="" coords="82,44,82,93,77,93,77,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="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_1AsyncObject_1_1CompletionCounter.html">CompletionCounter</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">RAII container that maintains the count of pending I/O. <a href="classripple_1_1AsyncObject_1_1CompletionCounter.html#details">More...</a><br /></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:ae2cfd3064c61d0c627d432dd86bc1d3d" id="r_ae2cfd3064c61d0c627d432dd86bc1d3d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AsyncObject.html#ae2cfd3064c61d0c627d432dd86bc1d3d">~AsyncObject</a> ()</td></tr>
<tr class="separator:ae2cfd3064c61d0c627d432dd86bc1d3d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5f6ac3b96957f62e4c1f86534445f58d" id="r_a5f6ac3b96957f62e4c1f86534445f58d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AsyncObject.html#a5f6ac3b96957f62e4c1f86534445f58d">addReference</a> ()</td></tr>
<tr class="separator:a5f6ac3b96957f62e4c1f86534445f58d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad926c8b473a993dbef11226430d06bef" id="r_ad926c8b473a993dbef11226430d06bef"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AsyncObject.html#ad926c8b473a993dbef11226430d06bef">removeReference</a> ()</td></tr>
<tr class="separator:ad926c8b473a993dbef11226430d06bef"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-methods" name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a09920409b1b92027191bf013f5cc7a98" id="r_a09920409b1b92027191bf013f5cc7a98"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AsyncObject.html#a09920409b1b92027191bf013f5cc7a98">AsyncObject</a> ()</td></tr>
<tr class="separator:a09920409b1b92027191bf013f5cc7a98"><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:a5c608863a32294d98bcb0180c827fefe" id="r_a5c608863a32294d98bcb0180c827fefe"><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_1AsyncObject.html#a5c608863a32294d98bcb0180c827fefe">m_pending</a></td></tr>
<tr class="separator:a5c608863a32294d98bcb0180c827fefe"><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 Derived&gt;<br />
class ripple::AsyncObject&lt; Derived &gt;</div><p>Mix-in to track when all pending I/O is complete. </p>
<p>Derived classes must be callable with this signature: void asyncHandlersComplete() </p>
<p class="definition">Definition at line <a class="el" href="ResolverAsio_8cpp_source.html#l00036">36</a> of file <a class="el" href="ResolverAsio_8cpp_source.html">ResolverAsio.cpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a09920409b1b92027191bf013f5cc7a98" name="a09920409b1b92027191bf013f5cc7a98"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a09920409b1b92027191bf013f5cc7a98">&#9670;&#160;</a></span>AsyncObject()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Derived &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1AsyncObject.html">ripple::AsyncObject</a>&lt; Derived &gt;::AsyncObject </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="ResolverAsio_8cpp_source.html#l00039">39</a> of file <a class="el" href="ResolverAsio_8cpp_source.html">ResolverAsio.cpp</a>.</p>
</div>
</div>
<a id="ae2cfd3064c61d0c627d432dd86bc1d3d" name="ae2cfd3064c61d0c627d432dd86bc1d3d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae2cfd3064c61d0c627d432dd86bc1d3d">&#9670;&#160;</a></span>~AsyncObject()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Derived &gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1AsyncObject.html">ripple::AsyncObject</a>&lt; Derived &gt;::~<a class="el" href="classripple_1_1AsyncObject.html">AsyncObject</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="ResolverAsio_8cpp_source.html#l00044">44</a> of file <a class="el" href="ResolverAsio_8cpp_source.html">ResolverAsio.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a5f6ac3b96957f62e4c1f86534445f58d" name="a5f6ac3b96957f62e4c1f86534445f58d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5f6ac3b96957f62e4c1f86534445f58d">&#9670;&#160;</a></span>addReference()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Derived &gt; </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classripple_1_1AsyncObject.html">ripple::AsyncObject</a>&lt; Derived &gt;::addReference </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="ResolverAsio_8cpp_source.html#l00084">84</a> of file <a class="el" href="ResolverAsio_8cpp_source.html">ResolverAsio.cpp</a>.</p>
</div>
</div>
<a id="ad926c8b473a993dbef11226430d06bef" name="ad926c8b473a993dbef11226430d06bef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad926c8b473a993dbef11226430d06bef">&#9670;&#160;</a></span>removeReference()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Derived &gt; </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classripple_1_1AsyncObject.html">ripple::AsyncObject</a>&lt; Derived &gt;::removeReference </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="ResolverAsio_8cpp_source.html#l00090">90</a> of file <a class="el" href="ResolverAsio_8cpp_source.html">ResolverAsio.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a5c608863a32294d98bcb0180c827fefe" name="a5c608863a32294d98bcb0180c827fefe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5c608863a32294d98bcb0180c827fefe">&#9670;&#160;</a></span>m_pending</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Derived &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_1AsyncObject.html">ripple::AsyncObject</a>&lt; Derived &gt;::m_pending</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="ResolverAsio_8cpp_source.html#l00098">98</a> of file <a class="el" href="ResolverAsio_8cpp_source.html">ResolverAsio.cpp</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