ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-27 22:45:52 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
cf1b2bc8e43a57da9a990f414c8a805026ce12ff
rippled/classripple_1_1DummyPeerSet.html
bthomee da1a1fe717 deploy: 3e152fec74
2025-05-08 11:05:03 +00:00

358 lines
19 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" 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.5"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: ripple::DummyPeerSet 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 id="projectrow">
<td id="projectalign">
<div id="projectname">rippled
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.5 -->
<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_1DummyPeerSet.html">DummyPeerSet</a></li> </ul>
</div>
</div><!-- top -->
<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="classripple_1_1DummyPeerSet-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::DummyPeerSet Class Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for ripple::DummyPeerSet:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1DummyPeerSet__inherit__graph.png" border="0" usemap="#aripple_1_1DummyPeerSet_inherit__map" alt="Inheritance graph"/></div>
<map name="aripple_1_1DummyPeerSet_inherit__map" id="aripple_1_1DummyPeerSet_inherit__map">
<area shape="rect" title=" " alt="" coords="5,79,175,104"/>
<area shape="rect" href="classripple_1_1PeerSet.html" title="Supports data retrieval by managing a set of peers." alt="" coords="31,5,149,31"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ripple::DummyPeerSet:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1DummyPeerSet__coll__graph.png" border="0" usemap="#aripple_1_1DummyPeerSet_coll__map" alt="Collaboration graph"/></div>
<map name="aripple_1_1DummyPeerSet_coll__map" id="aripple_1_1DummyPeerSet_coll__map">
<area shape="rect" title=" " alt="" coords="5,181,175,207"/>
<area shape="rect" href="classripple_1_1PeerSet.html" title="Supports data retrieval by managing a set of peers." alt="" coords="10,93,127,119"/>
<area shape="rect" href="classbeast_1_1Journal.html" title="A generic endpoint for log messages." alt="" coords="152,93,263,119"/>
<area shape="rect" href="classbeast_1_1Journal_1_1Sink.html" title="Abstraction for the underlying message destination." alt="" coords="134,5,281,31"/>
</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-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a58e78af0afaf2c6c8d9c7260f094aff6"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1DummyPeerSet.html#a58e78af0afaf2c6c8d9c7260f094aff6">DummyPeerSet</a> (<a class="el" href="classripple_1_1Application.html">Application</a> &amp;app)</td></tr>
<tr class="separator:a58e78af0afaf2c6c8d9c7260f094aff6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3bdffec7a1fbc933d20a00b5ac17534d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1DummyPeerSet.html#a3bdffec7a1fbc933d20a00b5ac17534d">addPeers</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> limit, <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/functional/function.html">std::function</a>&lt; bool(<a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; <a class="el" href="classripple_1_1Peer.html">Peer</a> &gt; const &amp;)&gt; hasItem, <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/functional/function.html">std::function</a>&lt; void(<a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; <a class="el" href="classripple_1_1Peer.html">Peer</a> &gt; const &amp;)&gt; onPeerAdded) override</td></tr>
<tr class="memdesc:a3bdffec7a1fbc933d20a00b5ac17534d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Try add more peers. <a href="classripple_1_1DummyPeerSet.html#a3bdffec7a1fbc933d20a00b5ac17534d">More...</a><br /></td></tr>
<tr class="separator:a3bdffec7a1fbc933d20a00b5ac17534d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4caf45ed3abda910abd2a6193e1f5ff3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1DummyPeerSet.html#a4caf45ed3abda910abd2a6193e1f5ff3">sendRequest</a> (::google::protobuf::Message const &amp;message, protocol::MessageType type, <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; <a class="el" href="classripple_1_1Peer.html">Peer</a> &gt; const &amp;peer) override</td></tr>
<tr class="separator:a4caf45ed3abda910abd2a6193e1f5ff3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a702cd2490b72fa679e9fd452fdc94008"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/container/set.html">std::set</a>&lt; <a class="el" href="classripple_1_1Peer.html#a56cc3cdd9c73921f23cb43a2bfa696a1">Peer::id_t</a> &gt; const &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1DummyPeerSet.html#a702cd2490b72fa679e9fd452fdc94008">getPeerIds</a> () const override</td></tr>
<tr class="memdesc:a702cd2490b72fa679e9fd452fdc94008"><td class="mdescLeft">&#160;</td><td class="mdescRight">get the set of ids of previously added peers <a href="classripple_1_1DummyPeerSet.html#a702cd2490b72fa679e9fd452fdc94008">More...</a><br /></td></tr>
<tr class="separator:a702cd2490b72fa679e9fd452fdc94008"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a751ba29d7fa5e1411ddd406e84f84d67"><td class="memTemplParams" colspan="2">template&lt;typename MessageType &gt; </td></tr>
<tr class="memitem:a751ba29d7fa5e1411ddd406e84f84d67"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classripple_1_1PeerSet.html#a751ba29d7fa5e1411ddd406e84f84d67">sendRequest</a> (MessageType const &amp;message, <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; <a class="el" href="classripple_1_1Peer.html">Peer</a> &gt; const &amp;peer)</td></tr>
<tr class="memdesc:a751ba29d7fa5e1411ddd406e84f84d67"><td class="mdescLeft">&#160;</td><td class="mdescRight">send a message <a href="classripple_1_1PeerSet.html#a751ba29d7fa5e1411ddd406e84f84d67">More...</a><br /></td></tr>
<tr class="separator:a751ba29d7fa5e1411ddd406e84f84d67"><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:abefbc8fb25e8a8aad8f023a347883083"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classbeast_1_1Journal.html">beast::Journal</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1DummyPeerSet.html#abefbc8fb25e8a8aad8f023a347883083">j_</a></td></tr>
<tr class="separator:abefbc8fb25e8a8aad8f023a347883083"><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 class="definition">Definition at line <a class="el" href="PeerSet_8cpp_source.html#l00149">149</a> of file <a class="el" href="PeerSet_8cpp_source.html">PeerSet.cpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a58e78af0afaf2c6c8d9c7260f094aff6" name="a58e78af0afaf2c6c8d9c7260f094aff6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a58e78af0afaf2c6c8d9c7260f094aff6">&#9670;&#160;</a></span>DummyPeerSet()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ripple::DummyPeerSet::DummyPeerSet </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1Application.html">Application</a> &amp;&#160;</td>
<td class="paramname"><em>app</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="PeerSet_8cpp_source.html#l00152">152</a> of file <a class="el" href="PeerSet_8cpp_source.html">PeerSet.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a3bdffec7a1fbc933d20a00b5ac17534d" name="a3bdffec7a1fbc933d20a00b5ac17534d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3bdffec7a1fbc933d20a00b5ac17534d">&#9670;&#160;</a></span>addPeers()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ripple::DummyPeerSet::addPeers </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a>&#160;</td>
<td class="paramname"><em>limit</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/functional/function.html">std::function</a>&lt; bool(<a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; <a class="el" href="classripple_1_1Peer.html">Peer</a> &gt; const &amp;)&gt;&#160;</td>
<td class="paramname"><em>hasItem</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/functional/function.html">std::function</a>&lt; void(<a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; <a class="el" href="classripple_1_1Peer.html">Peer</a> &gt; const &amp;)&gt;&#160;</td>
<td class="paramname"><em>onPeerAdded</em>&#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">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Try add more peers. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">limit</td><td>number of peers to add </td></tr>
<tr><td class="paramname">hasItem</td><td>callback that helps to select peers </td></tr>
<tr><td class="paramname">onPeerAdded</td><td>callback called when a peer is added </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classripple_1_1PeerSet.html#a3ec0f2c9ea5c123121145dfc61388c12">ripple::PeerSet</a>.</p>
<p class="definition">Definition at line <a class="el" href="PeerSet_8cpp_source.html#l00157">157</a> of file <a class="el" href="PeerSet_8cpp_source.html">PeerSet.cpp</a>.</p>
</div>
</div>
<a id="a4caf45ed3abda910abd2a6193e1f5ff3" name="a4caf45ed3abda910abd2a6193e1f5ff3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4caf45ed3abda910abd2a6193e1f5ff3">&#9670;&#160;</a></span>sendRequest() <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">void ripple::DummyPeerSet::sendRequest </td>
<td>(</td>
<td class="paramtype">::google::protobuf::Message const &amp;&#160;</td>
<td class="paramname"><em>message</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">protocol::MessageType&#160;</td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; <a class="el" href="classripple_1_1Peer.html">Peer</a> &gt; const &amp;&#160;</td>
<td class="paramname"><em>peer</em>&#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">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="classripple_1_1PeerSet.html#a91ee198dcb5053d841a2d220ca662ba7">ripple::PeerSet</a>.</p>
<p class="definition">Definition at line <a class="el" href="PeerSet_8cpp_source.html#l00166">166</a> of file <a class="el" href="PeerSet_8cpp_source.html">PeerSet.cpp</a>.</p>
</div>
</div>
<a id="a702cd2490b72fa679e9fd452fdc94008" name="a702cd2490b72fa679e9fd452fdc94008"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a702cd2490b72fa679e9fd452fdc94008">&#9670;&#160;</a></span>getPeerIds()</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/set.html">std::set</a>&lt; <a class="el" href="classripple_1_1Peer.html#a56cc3cdd9c73921f23cb43a2bfa696a1">Peer::id_t</a> &gt; const &amp; ripple::DummyPeerSet::getPeerIds </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>get the set of ids of previously added peers </p>
<p>Implements <a class="el" href="classripple_1_1PeerSet.html#a19e0c6ddb4adc29007d8702b8bd40916">ripple::PeerSet</a>.</p>
<p class="definition">Definition at line <a class="el" href="PeerSet_8cpp_source.html#l00175">175</a> of file <a class="el" href="PeerSet_8cpp_source.html">PeerSet.cpp</a>.</p>
</div>
</div>
<a id="a751ba29d7fa5e1411ddd406e84f84d67" name="a751ba29d7fa5e1411ddd406e84f84d67"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a751ba29d7fa5e1411ddd406e84f84d67">&#9670;&#160;</a></span>sendRequest() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename MessageType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ripple::PeerSet::sendRequest </td>
<td>(</td>
<td class="paramtype">MessageType const &amp;&#160;</td>
<td class="paramname"><em>message</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; <a class="el" href="classripple_1_1Peer.html">Peer</a> &gt; const &amp;&#160;</td>
<td class="paramname"><em>peer</em>&#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">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>send a message </p>
<p class="definition">Definition at line <a class="el" href="PeerSet_8h_source.html#l00059">59</a> of file <a class="el" href="PeerSet_8h_source.html">PeerSet.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="abefbc8fb25e8a8aad8f023a347883083" name="abefbc8fb25e8a8aad8f023a347883083"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abefbc8fb25e8a8aad8f023a347883083">&#9670;&#160;</a></span>j_</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="classbeast_1_1Journal.html">beast::Journal</a> ripple::DummyPeerSet::j_</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="PeerSet_8cpp_source.html#l00183">183</a> of file <a class="el" href="PeerSet_8cpp_source.html">PeerSet.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.5
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink