ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-20 19:15:54 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
e1dae4fb62ce2d05ca34c66a26724e0568d0f75a
rippled/classripple_1_1reduce__relay_1_1SquelchHandler.html
bthomee e7f4ae8bed deploy: afc05659ed
2025-08-19 09:49:50 -07:00

255 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" 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::reduce_relay::SquelchHandler 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_1reduce__relay.html">reduce_relay</a></li><li class="navelem"><a class="el" href="classripple_1_1reduce__relay_1_1SquelchHandler.html">SquelchHandler</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_1reduce__relay_1_1SquelchHandler-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::reduce_relay::SquelchHandler Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
</div><!--header-->
<div class="contents">
<p>Abstract class.
<a href="classripple_1_1reduce__relay_1_1SquelchHandler.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="overlay_2Slot_8h_source.html">Slot.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ripple::reduce_relay::SquelchHandler:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1reduce__relay_1_1SquelchHandler__inherit__graph.png" border="0" usemap="#aripple_1_1reduce__relay_1_1SquelchHandler_inherit__map" alt="Inheritance graph"/></div>
<map name="aripple_1_1reduce__relay_1_1SquelchHandler_inherit__map" id="aripple_1_1reduce__relay_1_1SquelchHandler_inherit__map">
<area shape="rect" title="Abstract class." alt="" coords="5,47,156,87"/>
<area shape="rect" href="classripple_1_1OverlayImpl.html" title=" " alt="" coords="219,5,365,31"/>
<area shape="poly" title=" " alt="" coords="169,44,236,28,238,33,170,49"/>
<area shape="rect" href="classripple_1_1test_1_1OverlaySim.html" title=" " alt="" coords="204,55,380,80"/>
<area shape="poly" title=" " alt="" coords="170,65,204,65,204,70,170,70"/>
<area shape="rect" href="structripple_1_1test_1_1reduce__relay__test_1_1Handler.html" title=" " alt="" coords="215,105,369,145"/>
<area shape="poly" title=" " alt="" coords="169,88,218,102,217,107,167,94"/>
</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:a71f49e7ef5c733be62f912fbce7dde91" id="r_a71f49e7ef5c733be62f912fbce7dde91"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1reduce__relay_1_1SquelchHandler.html#a71f49e7ef5c733be62f912fbce7dde91">~SquelchHandler</a> ()</td></tr>
<tr class="separator:a71f49e7ef5c733be62f912fbce7dde91"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab4d8e211c7a5a11678910a73d7c9664b" id="r_ab4d8e211c7a5a11678910a73d7c9664b"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1reduce__relay_1_1SquelchHandler.html#ab4d8e211c7a5a11678910a73d7c9664b">squelch</a> (<a class="el" href="classripple_1_1PublicKey.html">PublicKey</a> const &amp;validator, <a class="el" href="classripple_1_1Peer.html#a56cc3cdd9c73921f23cb43a2bfa696a1">Peer::id_t</a> id, <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> duration) const =0</td></tr>
<tr class="memdesc:ab4d8e211c7a5a11678910a73d7c9664b"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classripple_1_1reduce__relay_1_1Squelch.html" title="Maintains squelching of relaying messages from validators.">Squelch</a> handler. <br /></td></tr>
<tr class="separator:ab4d8e211c7a5a11678910a73d7c9664b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a042597f2a0888e54624245fc7104ef7f" id="r_a042597f2a0888e54624245fc7104ef7f"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1reduce__relay_1_1SquelchHandler.html#a042597f2a0888e54624245fc7104ef7f">unsquelch</a> (<a class="el" href="classripple_1_1PublicKey.html">PublicKey</a> const &amp;validator, <a class="el" href="classripple_1_1Peer.html#a56cc3cdd9c73921f23cb43a2bfa696a1">Peer::id_t</a> id) const =0</td></tr>
<tr class="memdesc:a042597f2a0888e54624245fc7104ef7f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unsquelch handler. <br /></td></tr>
<tr class="separator:a042597f2a0888e54624245fc7104ef7f"><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>Abstract class. </p>
<p>Declares squelch and unsquelch handlers. <a class="el" href="classripple_1_1OverlayImpl.html">OverlayImpl</a> inherits from this class. Motivation is for easier unit tests to facilitate on the fly changing callbacks. </p>
<p class="definition">Definition at line <a class="el" href="overlay_2Slot_8h_source.html#l00072">72</a> of file <a class="el" href="overlay_2Slot_8h_source.html">overlay/Slot.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a71f49e7ef5c733be62f912fbce7dde91" name="a71f49e7ef5c733be62f912fbce7dde91"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a71f49e7ef5c733be62f912fbce7dde91">&#9670;&#160;</a></span>~SquelchHandler()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual ripple::reduce_relay::SquelchHandler::~SquelchHandler </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> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="overlay_2Slot_8h_source.html#l00075">75</a> of file <a class="el" href="overlay_2Slot_8h_source.html">overlay/Slot.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ab4d8e211c7a5a11678910a73d7c9664b" name="ab4d8e211c7a5a11678910a73d7c9664b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab4d8e211c7a5a11678910a73d7c9664b">&#9670;&#160;</a></span>squelch()</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::reduce_relay::SquelchHandler::squelch </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="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a>&#160;</td>
<td class="paramname"><em>duration</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</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><a class="el" href="classripple_1_1reduce__relay_1_1Squelch.html" title="Maintains squelching of relaying messages from validators.">Squelch</a> handler. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">validator</td><td>Public key of the source validator </td></tr>
<tr><td class="paramname">id</td><td><a class="el" href="classripple_1_1Peer.html" title="Represents a peer connection in the overlay.">Peer</a>'s id to squelch </td></tr>
<tr><td class="paramname">duration</td><td><a class="el" href="classripple_1_1reduce__relay_1_1Squelch.html" title="Maintains squelching of relaying messages from validators.">Squelch</a> duration in seconds </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="structripple_1_1test_1_1reduce__relay__test_1_1Handler.html#a414137b0fbacfee3d3e9c3282e7f9431">ripple::test::reduce_relay_test::Handler</a>, <a class="el" href="classripple_1_1OverlayImpl.html#a4af02b1675b8d13ceb9ea72d031906f6">ripple::OverlayImpl</a>, and <a class="el" href="classripple_1_1test_1_1OverlaySim.html#aaf03bfd0def865f14724ced7b14efde3">ripple::test::OverlaySim</a>.</p>
</div>
</div>
<a id="a042597f2a0888e54624245fc7104ef7f" name="a042597f2a0888e54624245fc7104ef7f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a042597f2a0888e54624245fc7104ef7f">&#9670;&#160;</a></span>unsquelch()</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::reduce_relay::SquelchHandler::unsquelch </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>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</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>Unsquelch handler. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">validator</td><td>Public key of the source validator </td></tr>
<tr><td class="paramname">id</td><td><a class="el" href="classripple_1_1Peer.html" title="Represents a peer connection in the overlay.">Peer</a>'s id to unsquelch </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="structripple_1_1test_1_1reduce__relay__test_1_1Handler.html#ab93a7b94ebb6b222e6c7248238cc64f2">ripple::test::reduce_relay_test::Handler</a>, <a class="el" href="classripple_1_1test_1_1OverlaySim.html#a4ee62c71fa078b87853988df1ed8fe0a">ripple::test::OverlaySim</a>, and <a class="el" href="classripple_1_1OverlayImpl.html#a9bffa5dc79c7be0b7c4c75cce173ad2a">ripple::OverlayImpl</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