This commit is contained in:
bthomee
2025-08-19 09:49:50 -07:00
parent bb5efdeec8
commit e7f4ae8bed
14888 changed files with 259444 additions and 168566 deletions

View File

@@ -3,7 +3,7 @@
<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="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: PeerSet.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -29,7 +29,7 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.5 -->
<!-- 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');
@@ -46,6 +46,11 @@ $(function() {
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
@@ -104,6 +109,7 @@ $(function() {
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> </div>
<div class="foldopen" id="foldopen00039" data-start="{" data-end="};">
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"><a class="line" href="classripple_1_1PeerSet.html"> 39</a></span><span class="keyword">class </span><a class="code hl_class" href="classripple_1_1PeerSet.html">PeerSet</a></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span>{</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span><span class="keyword">public</span>:</div>
@@ -117,10 +123,12 @@ $(function() {
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> </div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> <span class="keyword">template</span> &lt;<span class="keyword">typename</span> MessageType&gt;</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> <span class="keywordtype">void</span></div>
<div class="foldopen" id="foldopen00059" data-start="{" data-end="}">
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"><a class="line" href="classripple_1_1PeerSet.html#a751ba29d7fa5e1411ddd406e84f84d67"> 59</a></span> <a class="code hl_function" href="classripple_1_1PeerSet.html#a751ba29d7fa5e1411ddd406e84f84d67">sendRequest</a>(MessageType <span class="keyword">const</span>&amp; message, <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr&lt;Peer&gt;</a> <span class="keyword">const</span>&amp; peer)</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> {</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> this-&gt;<a class="code hl_function" href="classripple_1_1PeerSet.html#a751ba29d7fa5e1411ddd406e84f84d67">sendRequest</a>(message, <a class="code hl_function" href="namespaceripple.html#a26f911b45c375c0ef008c8c5e4416b02">protocolMessageType</a>(message), peer);</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> }</div>
</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> </div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"><a class="line" href="classripple_1_1PeerSet.html#a91ee198dcb5053d841a2d220ca662ba7"> 65</a></span> <a class="code hl_function" href="classripple_1_1PeerSet.html#a91ee198dcb5053d841a2d220ca662ba7">sendRequest</a>(</div>
@@ -131,7 +139,9 @@ $(function() {
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> <span class="keyword">virtual</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/container/set.html">std::set&lt;Peer::id_t&gt;</a> <span class="keyword">const</span>&amp;</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"><a class="line" href="classripple_1_1PeerSet.html#a19e0c6ddb4adc29007d8702b8bd40916"> 72</a></span> <a class="code hl_function" href="classripple_1_1PeerSet.html#a19e0c6ddb4adc29007d8702b8bd40916">getPeerIds</a>() <span class="keyword">const</span> = 0;</div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span>};</div>
</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> </div>
<div class="foldopen" id="foldopen00075" data-start="{" data-end="};">
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"><a class="line" href="classripple_1_1PeerSetBuilder.html"> 75</a></span><span class="keyword">class </span><a class="code hl_class" href="classripple_1_1PeerSetBuilder.html">PeerSetBuilder</a></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span>{</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span><span class="keyword">public</span>:</div>
@@ -140,6 +150,7 @@ $(function() {
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> <span class="keyword">virtual</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/memory/unique_ptr.html">std::unique_ptr&lt;PeerSet&gt;</a></div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"><a class="line" href="classripple_1_1PeerSetBuilder.html#aed1fe09229a4c005e39460262c574afc"> 81</a></span> <a class="code hl_function" href="classripple_1_1PeerSetBuilder.html#aed1fe09229a4c005e39460262c574afc">build</a>() = 0;</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span>};</div>
</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> </div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span><a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/memory/unique_ptr.html">std::unique_ptr&lt;PeerSetBuilder&gt;</a></div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span><a class="code hl_function" href="namespaceripple.html#a6d96d342f61e5dd48b86a8a37cdce642">make_PeerSetBuilder</a>(<a class="code hl_class" href="classripple_1_1Application.html">Application</a>&amp; app);</div>
@@ -150,21 +161,21 @@ $(function() {
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span>} <span class="comment">// namespace ripple</span></div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> </div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclassripple_1_1Application_html"><div class="ttname"><a href="classripple_1_1Application.html">ripple::Application</a></div><div class="ttdef"><b>Definition:</b> <a href="Application_8h_source.html#l00113">Application.h:114</a></div></div>
<div class="ttc" id="aclassripple_1_1PeerSetBuilder_html"><div class="ttname"><a href="classripple_1_1PeerSetBuilder.html">ripple::PeerSetBuilder</a></div><div class="ttdef"><b>Definition:</b> <a href="PeerSet_8h_source.html#l00075">PeerSet.h:76</a></div></div>
<div class="ttc" id="aclassripple_1_1Application_html"><div class="ttname"><a href="classripple_1_1Application.html">ripple::Application</a></div><div class="ttdef"><b>Definition</b> <a href="Application_8h_source.html#l00113">Application.h:114</a></div></div>
<div class="ttc" id="aclassripple_1_1PeerSetBuilder_html"><div class="ttname"><a href="classripple_1_1PeerSetBuilder.html">ripple::PeerSetBuilder</a></div><div class="ttdef"><b>Definition</b> <a href="PeerSet_8h_source.html#l00075">PeerSet.h:76</a></div></div>
<div class="ttc" id="aclassripple_1_1PeerSetBuilder_html_aca9dbf50fb60a340a3c3f7f49e9ed5fc"><div class="ttname"><a href="classripple_1_1PeerSetBuilder.html#aca9dbf50fb60a340a3c3f7f49e9ed5fc">ripple::PeerSetBuilder::~PeerSetBuilder</a></div><div class="ttdeci">virtual ~PeerSetBuilder()=default</div></div>
<div class="ttc" id="aclassripple_1_1PeerSetBuilder_html_aed1fe09229a4c005e39460262c574afc"><div class="ttname"><a href="classripple_1_1PeerSetBuilder.html#aed1fe09229a4c005e39460262c574afc">ripple::PeerSetBuilder::build</a></div><div class="ttdeci">virtual std::unique_ptr&lt; PeerSet &gt; build()=0</div></div>
<div class="ttc" id="aclassripple_1_1PeerSet_html"><div class="ttname"><a href="classripple_1_1PeerSet.html">ripple::PeerSet</a></div><div class="ttdoc">Supports data retrieval by managing a set of peers.</div><div class="ttdef"><b>Definition:</b> <a href="PeerSet_8h_source.html#l00039">PeerSet.h:40</a></div></div>
<div class="ttc" id="aclassripple_1_1PeerSet_html"><div class="ttname"><a href="classripple_1_1PeerSet.html">ripple::PeerSet</a></div><div class="ttdoc">Supports data retrieval by managing a set of peers.</div><div class="ttdef"><b>Definition</b> <a href="PeerSet_8h_source.html#l00039">PeerSet.h:40</a></div></div>
<div class="ttc" id="aclassripple_1_1PeerSet_html_a19e0c6ddb4adc29007d8702b8bd40916"><div class="ttname"><a href="classripple_1_1PeerSet.html#a19e0c6ddb4adc29007d8702b8bd40916">ripple::PeerSet::getPeerIds</a></div><div class="ttdeci">virtual std::set&lt; Peer::id_t &gt; const &amp; getPeerIds() const =0</div><div class="ttdoc">get the set of ids of previously added peers</div></div>
<div class="ttc" id="aclassripple_1_1PeerSet_html_a3ec0f2c9ea5c123121145dfc61388c12"><div class="ttname"><a href="classripple_1_1PeerSet.html#a3ec0f2c9ea5c123121145dfc61388c12">ripple::PeerSet::addPeers</a></div><div class="ttdeci">virtual void addPeers(std::size_t limit, std::function&lt; bool(std::shared_ptr&lt; Peer &gt; const &amp;)&gt; hasItem, std::function&lt; void(std::shared_ptr&lt; Peer &gt; const &amp;)&gt; onPeerAdded)=0</div><div class="ttdoc">Try add more peers.</div></div>
<div class="ttc" id="aclassripple_1_1PeerSet_html_a751ba29d7fa5e1411ddd406e84f84d67"><div class="ttname"><a href="classripple_1_1PeerSet.html#a751ba29d7fa5e1411ddd406e84f84d67">ripple::PeerSet::sendRequest</a></div><div class="ttdeci">void sendRequest(MessageType const &amp;message, std::shared_ptr&lt; Peer &gt; const &amp;peer)</div><div class="ttdoc">send a message</div><div class="ttdef"><b>Definition:</b> <a href="PeerSet_8h_source.html#l00059">PeerSet.h:59</a></div></div>
<div class="ttc" id="aclassripple_1_1PeerSet_html_a751ba29d7fa5e1411ddd406e84f84d67"><div class="ttname"><a href="classripple_1_1PeerSet.html#a751ba29d7fa5e1411ddd406e84f84d67">ripple::PeerSet::sendRequest</a></div><div class="ttdeci">void sendRequest(MessageType const &amp;message, std::shared_ptr&lt; Peer &gt; const &amp;peer)</div><div class="ttdoc">send a message</div><div class="ttdef"><b>Definition</b> <a href="PeerSet_8h_source.html#l00059">PeerSet.h:59</a></div></div>
<div class="ttc" id="aclassripple_1_1PeerSet_html_a91ee198dcb5053d841a2d220ca662ba7"><div class="ttname"><a href="classripple_1_1PeerSet.html#a91ee198dcb5053d841a2d220ca662ba7">ripple::PeerSet::sendRequest</a></div><div class="ttdeci">virtual void sendRequest(::google::protobuf::Message const &amp;message, protocol::MessageType type, std::shared_ptr&lt; Peer &gt; const &amp;peer)=0</div></div>
<div class="ttc" id="aclassripple_1_1PeerSet_html_aed73adc53a472315823d2386af51012b"><div class="ttname"><a href="classripple_1_1PeerSet.html#aed73adc53a472315823d2386af51012b">ripple::PeerSet::~PeerSet</a></div><div class="ttdeci">virtual ~PeerSet()=default</div></div>
<div class="ttc" id="afunction_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/utility/functional/function.html">std::function</a></div></div>
<div class="ttc" id="anamespaceripple_html"><div class="ttname"><a href="namespaceripple.html">ripple</a></div><div class="ttdoc">Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.</div><div class="ttdef"><b>Definition:</b> <a href="algorithm_8h_source.html#l00025">algorithm.h:25</a></div></div>
<div class="ttc" id="anamespaceripple_html_a26f911b45c375c0ef008c8c5e4416b02"><div class="ttname"><a href="namespaceripple.html#a26f911b45c375c0ef008c8c5e4416b02">ripple::protocolMessageType</a></div><div class="ttdeci">protocol::MessageType protocolMessageType(protocol::TMGetLedger const &amp;)</div><div class="ttdef"><b>Definition:</b> <a href="ProtocolMessage_8h_source.html#l00041">ProtocolMessage.h:41</a></div></div>
<div class="ttc" id="anamespaceripple_html_a5a08ef41766731386ceb3ec0866c47d8"><div class="ttname"><a href="namespaceripple.html#a5a08ef41766731386ceb3ec0866c47d8">ripple::make_DummyPeerSet</a></div><div class="ttdeci">std::unique_ptr&lt; PeerSet &gt; make_DummyPeerSet(Application &amp;app)</div><div class="ttdoc">Make a dummy PeerSet that does not do anything.</div><div class="ttdef"><b>Definition:</b> <a href="PeerSet_8cpp_source.html#l00187">PeerSet.cpp:187</a></div></div>
<div class="ttc" id="anamespaceripple_html_a6d96d342f61e5dd48b86a8a37cdce642"><div class="ttname"><a href="namespaceripple.html#a6d96d342f61e5dd48b86a8a37cdce642">ripple::make_PeerSetBuilder</a></div><div class="ttdeci">std::unique_ptr&lt; PeerSetBuilder &gt; make_PeerSetBuilder(Application &amp;app)</div><div class="ttdef"><b>Definition:</b> <a href="PeerSet_8cpp_source.html#l00144">PeerSet.cpp:144</a></div></div>
<div class="ttc" id="anamespaceripple_html"><div class="ttname"><a href="namespaceripple.html">ripple</a></div><div class="ttdoc">Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.</div><div class="ttdef"><b>Definition</b> <a href="algorithm_8h_source.html#l00025">algorithm.h:25</a></div></div>
<div class="ttc" id="anamespaceripple_html_a26f911b45c375c0ef008c8c5e4416b02"><div class="ttname"><a href="namespaceripple.html#a26f911b45c375c0ef008c8c5e4416b02">ripple::protocolMessageType</a></div><div class="ttdeci">protocol::MessageType protocolMessageType(protocol::TMGetLedger const &amp;)</div><div class="ttdef"><b>Definition</b> <a href="ProtocolMessage_8h_source.html#l00041">ProtocolMessage.h:41</a></div></div>
<div class="ttc" id="anamespaceripple_html_a5a08ef41766731386ceb3ec0866c47d8"><div class="ttname"><a href="namespaceripple.html#a5a08ef41766731386ceb3ec0866c47d8">ripple::make_DummyPeerSet</a></div><div class="ttdeci">std::unique_ptr&lt; PeerSet &gt; make_DummyPeerSet(Application &amp;app)</div><div class="ttdoc">Make a dummy PeerSet that does not do anything.</div><div class="ttdef"><b>Definition</b> <a href="PeerSet_8cpp_source.html#l00187">PeerSet.cpp:187</a></div></div>
<div class="ttc" id="anamespaceripple_html_a6d96d342f61e5dd48b86a8a37cdce642"><div class="ttname"><a href="namespaceripple.html#a6d96d342f61e5dd48b86a8a37cdce642">ripple::make_PeerSetBuilder</a></div><div class="ttdeci">std::unique_ptr&lt; PeerSetBuilder &gt; make_PeerSetBuilder(Application &amp;app)</div><div class="ttdef"><b>Definition</b> <a href="PeerSet_8cpp_source.html#l00144">PeerSet.cpp:144</a></div></div>
<div class="ttc" id="aset_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/container/set.html">std::set</a></div></div>
<div class="ttc" id="ashared_ptr_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a></div></div>
<div class="ttc" id="asize_t_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a></div></div>
@@ -172,7 +183,7 @@ $(function() {
</div><!-- fragment --></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
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>