ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-20 02:55:50 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
rippled/classripple_1_1test_1_1Overlay.html
bthomee 33451fdc96 deploy: 1d42c4f6de
2025-11-04 00:36:48 -08:00

294 lines
14 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::test::Overlay 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.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="namespaceripple_1_1test.html">test</a></li><li class="navelem"><a class="el" href="classripple_1_1test_1_1Overlay.html">Overlay</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classripple_1_1test_1_1Overlay-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::test::Overlay Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
</div><!--header-->
<div class="contents">
<p>Simulate server's <a class="el" href="classripple_1_1OverlayImpl.html">OverlayImpl</a>.
<a href="classripple_1_1test_1_1Overlay.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for ripple::test::Overlay:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1test_1_1Overlay__inherit__graph.png" border="0" usemap="#aripple_1_1test_1_1Overlay_inherit__map" alt="Inheritance graph"/></div>
<map name="aripple_1_1test_1_1Overlay_inherit__map" id="aripple_1_1test_1_1Overlay_inherit__map">
<area shape="rect" title="Simulate server&#39;s OverlayImpl." alt="" coords="18,5,169,31"/>
<area shape="rect" href="classripple_1_1test_1_1OverlaySim.html" title=" " alt="" coords="5,79,181,104"/>
<area shape="poly" title=" " alt="" coords="96,44,96,79,91,79,91,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="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a93e6a7d00765f6d6ce936e730d934717" id="r_a93e6a7d00765f6d6ce936e730d934717"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1test_1_1Overlay.html#a93e6a7d00765f6d6ce936e730d934717">Overlay</a> ()=default</td></tr>
<tr class="separator:a93e6a7d00765f6d6ce936e730d934717"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6dc593c2f9757f0dddb8aaf1ca20c45f" id="r_a6dc593c2f9757f0dddb8aaf1ca20c45f"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1test_1_1Overlay.html#a6dc593c2f9757f0dddb8aaf1ca20c45f">~Overlay</a> ()=default</td></tr>
<tr class="separator:a6dc593c2f9757f0dddb8aaf1ca20c45f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a326cae5fe44765c4998da53ab74b9100" id="r_a326cae5fe44765c4998da53ab74b9100"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1test_1_1Overlay.html#a326cae5fe44765c4998da53ab74b9100">updateSlotAndSquelch</a> (<a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> const &amp;key, <a class="el" href="classripple_1_1PublicKey.html">PublicKey</a> const &amp;<a class="el" href="namespaceripple_1_1test_1_1jtx.html#a000ffa48b8512f4af030e7fd63c26cad">validator</a>, <a class="el" href="classripple_1_1Peer.html#a56cc3cdd9c73921f23cb43a2bfa696a1">Peer::id_t</a> id, <a class="el" href="namespaceripple_1_1test.html#a7ead0a4637af4b331e2ede8e1f823a32">SquelchCB</a> f, protocol::MessageType type=protocol::mtVALIDATION)=0</td></tr>
<tr class="separator:a326cae5fe44765c4998da53ab74b9100"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac22c1839b424fa08d288f7e8b2280e53" id="r_ac22c1839b424fa08d288f7e8b2280e53"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1test_1_1Overlay.html#ac22c1839b424fa08d288f7e8b2280e53">deleteIdlePeers</a> (<a class="el" href="namespaceripple_1_1test.html#aab7a6684e14c1ff558572b334056f591">UnsquelchCB</a>)=0</td></tr>
<tr class="separator:ac22c1839b424fa08d288f7e8b2280e53"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7af470228e54baf9d93a3ab2cc71a4d5" id="r_a7af470228e54baf9d93a3ab2cc71a4d5"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1test_1_1Overlay.html#a7af470228e54baf9d93a3ab2cc71a4d5">deletePeer</a> (<a class="el" href="classripple_1_1Peer.html#a56cc3cdd9c73921f23cb43a2bfa696a1">Peer::id_t</a>, <a class="el" href="namespaceripple_1_1test.html#aab7a6684e14c1ff558572b334056f591">UnsquelchCB</a>)=0</td></tr>
<tr class="separator:a7af470228e54baf9d93a3ab2cc71a4d5"><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>Simulate server's <a class="el" href="classripple_1_1OverlayImpl.html">OverlayImpl</a>. </p>
<p class="definition">Definition at line <a class="el" href="reduce__relay__test_8cpp_source.html#l00222">222</a> of file <a class="el" href="reduce__relay__test_8cpp_source.html">reduce_relay_test.cpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a93e6a7d00765f6d6ce936e730d934717" name="a93e6a7d00765f6d6ce936e730d934717"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a93e6a7d00765f6d6ce936e730d934717">&#9670;&#160;</a></span>Overlay()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ripple::test::Overlay::Overlay </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="a6dc593c2f9757f0dddb8aaf1ca20c45f" name="a6dc593c2f9757f0dddb8aaf1ca20c45f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6dc593c2f9757f0dddb8aaf1ca20c45f">&#9670;&#160;</a></span>~Overlay()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual ripple::test::Overlay::~Overlay </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</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="a326cae5fe44765c4998da53ab74b9100" name="a326cae5fe44765c4998da53ab74b9100"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a326cae5fe44765c4998da53ab74b9100">&#9670;&#160;</a></span>updateSlotAndSquelch()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void ripple::test::Overlay::updateSlotAndSquelch </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> const &amp;&#160;</td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classripple_1_1PublicKey.html">PublicKey</a> const &amp;&#160;</td>
<td class="paramname"><em>validator</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classripple_1_1Peer.html#a56cc3cdd9c73921f23cb43a2bfa696a1">Peer::id_t</a>&#160;</td>
<td class="paramname"><em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceripple_1_1test.html#a7ead0a4637af4b331e2ede8e1f823a32">SquelchCB</a>&#160;</td>
<td class="paramname"><em>f</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">protocol::MessageType&#160;</td>
<td class="paramname"><em>type</em> = <code>protocol::mtVALIDATION</code>&#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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="classripple_1_1test_1_1OverlaySim.html#a83eaa659523a835a423d78f44ce4af6e">ripple::test::OverlaySim</a>.</p>
</div>
</div>
<a id="ac22c1839b424fa08d288f7e8b2280e53" name="ac22c1839b424fa08d288f7e8b2280e53"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac22c1839b424fa08d288f7e8b2280e53">&#9670;&#160;</a></span>deleteIdlePeers()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void ripple::test::Overlay::deleteIdlePeers </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceripple_1_1test.html#aab7a6684e14c1ff558572b334056f591">UnsquelchCB</a>&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="classripple_1_1test_1_1OverlaySim.html#a99364d64099e6d27af806964246ebf12">ripple::test::OverlaySim</a>.</p>
</div>
</div>
<a id="a7af470228e54baf9d93a3ab2cc71a4d5" name="a7af470228e54baf9d93a3ab2cc71a4d5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7af470228e54baf9d93a3ab2cc71a4d5">&#9670;&#160;</a></span>deletePeer()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void ripple::test::Overlay::deletePeer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1Peer.html#a56cc3cdd9c73921f23cb43a2bfa696a1">Peer::id_t</a>&#160;</td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceripple_1_1test.html#aab7a6684e14c1ff558572b334056f591">UnsquelchCB</a>&#160;</td>
<td class="paramname">&#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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="classripple_1_1test_1_1OverlaySim.html#a77e02bc9b7e72ce0dfe71746a762fddd">ripple::test::OverlaySim</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