ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-23 12:35:50 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
a84d06b17d69754eb8af364182d5865ac35a05bc
rippled/classripple_1_1PeerFinder_1_1Sim_1_1FunctionQueue.html
manojsdoshi 430f6c0cf3 deploy: 023f5704d0
2020-04-24 01:09:47 +00:00

252 lines
14 KiB
HTML
Raw 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">
<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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: ripple::PeerFinder::Sim::FunctionQueue 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="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="projectalign" style="padding-left: 0.5em;">
<div id="projectname">rippled
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<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>
<!-- 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 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="namespaceripple_1_1PeerFinder.html">PeerFinder</a></li><li class="navelem"><a class="el" href="namespaceripple_1_1PeerFinder_1_1Sim.html">Sim</a></li><li class="navelem"><a class="el" href="classripple_1_1PeerFinder_1_1Sim_1_1FunctionQueue.html">FunctionQueue</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-attribs">Private Attributes</a> &#124;
<a href="classripple_1_1PeerFinder_1_1Sim_1_1FunctionQueue-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ripple::PeerFinder::Sim::FunctionQueue Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Maintains a queue of functors that can be called later.
<a href="classripple_1_1PeerFinder_1_1Sim_1_1FunctionQueue.html#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for ripple::PeerFinder::Sim::FunctionQueue:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1PeerFinder_1_1Sim_1_1FunctionQueue__coll__graph.png" border="0" usemap="#ripple_1_1PeerFinder_1_1Sim_1_1FunctionQueue_coll__map" alt="Collaboration graph"/></div>
<map name="ripple_1_1PeerFinder_1_1Sim_1_1FunctionQueue_coll__map" id="ripple_1_1PeerFinder_1_1Sim_1_1FunctionQueue_coll__map">
<area shape="rect" title="Maintains a queue of functors that can be called later." alt="" coords="953,13,1112,54"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/list.html" title=" " alt="" coords="583,5,848,61"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/memory/unique_ptr.html" title=" " alt="" coords="235,5,469,61"/>
<area shape="rect" href="classripple_1_1PeerFinder_1_1Sim_1_1FunctionQueue_1_1BasicWork.html" title=" " alt="" coords="5,5,164,61"/>
</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 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_1PeerFinder_1_1Sim_1_1FunctionQueue_1_1BasicWork.html">BasicWork</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</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_1PeerFinder_1_1Sim_1_1FunctionQueue_1_1Work.html">Work</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 name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a1083f4f7f04942d5cb79fc6c3e9bd3b4"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1PeerFinder_1_1Sim_1_1FunctionQueue.html#a1083f4f7f04942d5cb79fc6c3e9bd3b4">FunctionQueue</a> ()=default</td></tr>
<tr class="separator:a1083f4f7f04942d5cb79fc6c3e9bd3b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af45e66b7a14d2e9208859f18fc310003"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1PeerFinder_1_1Sim_1_1FunctionQueue.html#af45e66b7a14d2e9208859f18fc310003">empty</a> ()</td></tr>
<tr class="memdesc:af45e66b7a14d2e9208859f18fc310003"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns <code>true</code> if there is no remaining work. <a href="classripple_1_1PeerFinder_1_1Sim_1_1FunctionQueue.html#af45e66b7a14d2e9208859f18fc310003">More...</a><br /></td></tr>
<tr class="separator:af45e66b7a14d2e9208859f18fc310003"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac993c85665977257e98d4543f0d87979"><td class="memTemplParams" colspan="2">template&lt;typename Function &gt; </td></tr>
<tr class="memitem:ac993c85665977257e98d4543f0d87979"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classripple_1_1PeerFinder_1_1Sim_1_1FunctionQueue.html#ac993c85665977257e98d4543f0d87979">post</a> (Function f)</td></tr>
<tr class="memdesc:ac993c85665977257e98d4543f0d87979"><td class="mdescLeft">&#160;</td><td class="mdescRight">Queue a function. <a href="classripple_1_1PeerFinder_1_1Sim_1_1FunctionQueue.html#ac993c85665977257e98d4543f0d87979">More...</a><br /></td></tr>
<tr class="separator:ac993c85665977257e98d4543f0d87979"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2672bb2688fe1ece44c2d8dafa3644a9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1PeerFinder_1_1Sim_1_1FunctionQueue.html#a2672bb2688fe1ece44c2d8dafa3644a9">run</a> ()</td></tr>
<tr class="memdesc:a2672bb2688fe1ece44c2d8dafa3644a9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Run all pending functions. <a href="classripple_1_1PeerFinder_1_1Sim_1_1FunctionQueue.html#a2672bb2688fe1ece44c2d8dafa3644a9">More...</a><br /></td></tr>
<tr class="separator:a2672bb2688fe1ece44c2d8dafa3644a9"><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:a5c04a7dabadb2ad35f7f248848bfacd3"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/container/list.html">std::list</a>&lt; <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/unique_ptr.html">std::unique_ptr</a>&lt; <a class="el" href="classripple_1_1PeerFinder_1_1Sim_1_1FunctionQueue_1_1BasicWork.html">BasicWork</a> &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1PeerFinder_1_1Sim_1_1FunctionQueue.html#a5c04a7dabadb2ad35f7f248848bfacd3">m_work</a></td></tr>
<tr class="separator:a5c04a7dabadb2ad35f7f248848bfacd3"><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>Maintains a queue of functors that can be called later. </p>
<p class="definition">Definition at line <a class="el" href="FunctionQueue_8h_source.html#l00028">28</a> of file <a class="el" href="FunctionQueue_8h_source.html">FunctionQueue.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a1083f4f7f04942d5cb79fc6c3e9bd3b4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1083f4f7f04942d5cb79fc6c3e9bd3b4">&#9670;&nbsp;</a></span>FunctionQueue()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ripple::PeerFinder::Sim::FunctionQueue::FunctionQueue </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="af45e66b7a14d2e9208859f18fc310003"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af45e66b7a14d2e9208859f18fc310003">&#9670;&nbsp;</a></span>empty()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ripple::PeerFinder::Sim::FunctionQueue::empty </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns <code>true</code> if there is no remaining work. </p>
<p class="definition">Definition at line <a class="el" href="FunctionQueue_8h_source.html#l00066">66</a> of file <a class="el" href="FunctionQueue_8h_source.html">FunctionQueue.h</a>.</p>
</div>
</div>
<a id="ac993c85665977257e98d4543f0d87979"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac993c85665977257e98d4543f0d87979">&#9670;&nbsp;</a></span>post()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Function &gt; </div>
<table class="memname">
<tr>
<td class="memname">void ripple::PeerFinder::Sim::FunctionQueue::post </td>
<td>(</td>
<td class="paramtype">Function&#160;</td>
<td class="paramname"><em>f</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Queue a function. </p>
<p>Function must be callable with this signature: void (void) </p>
<p class="definition">Definition at line <a class="el" href="FunctionQueue_8h_source.html#l00077">77</a> of file <a class="el" href="FunctionQueue_8h_source.html">FunctionQueue.h</a>.</p>
</div>
</div>
<a id="a2672bb2688fe1ece44c2d8dafa3644a9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2672bb2688fe1ece44c2d8dafa3644a9">&#9670;&nbsp;</a></span>run()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ripple::PeerFinder::Sim::FunctionQueue::run </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Run all pending functions. </p>
<p>The functions will be invoked in the order they were queued. </p>
<p class="definition">Definition at line <a class="el" href="FunctionQueue_8h_source.html#l00086">86</a> of file <a class="el" href="FunctionQueue_8h_source.html">FunctionQueue.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a5c04a7dabadb2ad35f7f248848bfacd3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5c04a7dabadb2ad35f7f248848bfacd3">&#9670;&nbsp;</a></span>m_work</h2>
<div class="memitem">
<div class="memproto">
<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/container/list.html">std::list</a>&lt;<a class="elRef" href="http://en.cppreference.com/w/cpp/memory/unique_ptr.html">std::unique_ptr</a>&lt;<a class="el" href="classripple_1_1PeerFinder_1_1Sim_1_1FunctionQueue_1_1BasicWork.html">BasicWork</a>&gt; &gt; ripple::PeerFinder::Sim::FunctionQueue::m_work</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="FunctionQueue_8h_source.html#l00061">61</a> of file <a class="el" href="FunctionQueue_8h_source.html">FunctionQueue.h</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink