Files
rippled/structripple_1_1test_1_1csf_1_1JumpCollector.html
2025-11-04 00:36:48 -08:00

311 lines
20 KiB
HTML

<!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::csf::JumpCollector Struct 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="namespaceripple_1_1test_1_1csf.html">csf</a></li><li class="navelem"><a class="el" href="structripple_1_1test_1_1csf_1_1JumpCollector.html">JumpCollector</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="#pub-attribs">Public Attributes</a> &#124;
<a href="structripple_1_1test_1_1csf_1_1JumpCollector-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::test::csf::JumpCollector Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Saves information about Jumps for closed and fully validated ledgers.
<a href="structripple_1_1test_1_1csf_1_1JumpCollector.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="collectors_8h_source.html">collectors.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for ripple::test::csf::JumpCollector:</div>
<div class="dyncontent">
<div class="center"><img src="structripple_1_1test_1_1csf_1_1JumpCollector__coll__graph.png" border="0" usemap="#aripple_1_1test_1_1csf_1_1JumpCollector_coll__map" alt="Collaboration graph"/></div>
<map name="aripple_1_1test_1_1csf_1_1JumpCollector_coll__map" id="aripple_1_1test_1_1csf_1_1JumpCollector_coll__map">
<area shape="rect" title="Saves information about Jumps for closed and fully validated ledgers." alt="" coords="2303,269,2429,309"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/vector.html" title=" " alt="" coords="1944,261,2124,316"/>
<area shape="poly" title=" " alt="" coords="2138,286,2302,286,2302,291,2138,291"/>
<area shape="rect" href="structripple_1_1test_1_1csf_1_1JumpCollector_1_1Jump.html" title=" " alt="" coords="1676,269,1831,309"/>
<area shape="poly" title=" " alt="" coords="1844,286,1944,286,1944,291,1844,291"/>
<area shape="rect" href="classripple_1_1tagged__integer.html" title=" " alt="" coords="829,239,1036,279"/>
<area shape="poly" title=" " alt="" coords="1050,257,1325,261,1652,275,1676,277,1675,283,1652,281,1325,266,1050,262"/>
<area shape="rect" title=" " alt="" coords="375,5,683,177"/>
<area shape="poly" title=" " alt="" coords="697,158,885,237,883,242,694,163"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="477,384,580,409"/>
<area shape="poly" title=" " alt="" coords="593,396,654,389,686,381,715,369,727,357,738,343,781,313,828,290,862,277,864,282,830,295,784,317,742,347,731,361,717,374,687,386,655,395,594,401"/>
<area shape="rect" href="classripple_1_1tagged__integer.html" title=" " alt="" coords="839,498,1026,538"/>
<area shape="poly" title=" " alt="" coords="594,387,644,387,700,392,756,407,782,419,807,435,817,447,820,460,823,473,831,484,849,496,846,500,827,488,818,475,815,461,812,449,804,439,780,424,754,412,699,398,643,392,594,392"/>
<area shape="rect" href="classripple_1_1tagged__integer.html" title=" " alt="" coords="845,305,1020,345"/>
<area shape="poly" title=" " alt="" coords="593,388,693,376,805,357,864,342,866,347,806,362,694,381,594,393"/>
<area shape="rect" href="classripple_1_1test_1_1csf_1_1Ledger.html" title="A ledger is a set of observed transactions and a sequence number identifying the ledger." alt="" coords="1465,297,1592,337"/>
<area shape="poly" title=" " alt="" coords="1605,310,1652,305,1675,301,1676,306,1652,310,1606,315"/>
<area shape="rect" href="structripple_1_1test_1_1csf_1_1Ledger_1_1Instance.html" title=" " alt="" coords="1225,411,1355,451"/>
<area shape="poly" title=" " alt="" coords="1348,403,1440,360,1489,334,1492,339,1443,364,1350,408"/>
<area shape="poly" title=" " alt="" coords="1040,509,1120,497,1200,477,1230,464,1257,449,1260,454,1232,469,1202,482,1121,503,1040,514"/>
<area shape="rect" title=" " alt="" coords="341,498,716,655"/>
<area shape="poly" title=" " alt="" coords="730,545,839,529,840,534,730,550"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/chrono/duration.html" title=" " alt="" coords="855,562,1011,602"/>
<area shape="poly" title=" " alt="" coords="1024,575,1112,559,1158,545,1200,525,1223,509,1243,489,1274,450,1278,453,1247,493,1226,513,1203,530,1160,550,1114,564,1025,580"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/chrono/time_point.html" title=" " alt="" coords="847,370,1019,410"/>
<area shape="poly" title=" " alt="" coords="1033,401,1060,405,1225,423,1225,428,1060,410,1032,406"/>
<area shape="poly" title=" " alt="" coords="1034,321,1465,315,1465,320,1034,326"/>
<area shape="poly" title=" " alt="" coords="1034,340,1138,360,1202,375,1234,391,1263,409,1260,413,1232,396,1200,381,1137,365,1033,345"/>
<area shape="rect" title=" " alt="" coords="347,202,710,359"/>
<area shape="poly" title=" " alt="" coords="724,288,806,297,846,303,845,308,805,302,723,293"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/vector.html" title=" " alt="" coords="861,434,1004,474"/>
<area shape="poly" title=" " alt="" coords="1018,456,1106,456,1201,450,1225,446,1226,451,1202,455,1106,462,1017,461"/>
<area shape="rect" href="classripple_1_1tagged__integer.html" title="A type&#45;safe wrap around standard integral types." alt="" coords="446,434,611,474"/>
<area shape="poly" title=" " alt="" coords="625,451,861,451,861,457,625,457"/>
<area shape="rect" title=" " alt="" coords="5,383,292,525"/>
<area shape="poly" title=" " alt="" coords="306,451,446,451,446,457,306,457"/>
</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="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1test_1_1csf_1_1JumpCollector_1_1Jump.html">Jump</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 id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a648b16939cc6499466e7f1e86d6433f8" id="r_a648b16939cc6499466e7f1e86d6433f8"><td class="memTemplParams" colspan="2">template&lt;class E &gt; </td></tr>
<tr class="memitem:a648b16939cc6499466e7f1e86d6433f8"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structripple_1_1test_1_1csf_1_1JumpCollector.html#a648b16939cc6499466e7f1e86d6433f8">on</a> (<a class="el" href="namespaceripple_1_1test_1_1csf.html#a1a320722bad8a720a9497b656493dd50">PeerID</a>, <a class="el" href="namespaceripple_1_1test_1_1csf.html#a94af4815b9aaf71de676cd8377415473">SimTime</a>, E const &amp;e)</td></tr>
<tr class="separator:a648b16939cc6499466e7f1e86d6433f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a573a37f823030a459ce59e6108cf964f" id="r_a573a37f823030a459ce59e6108cf964f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1test_1_1csf_1_1JumpCollector.html#a573a37f823030a459ce59e6108cf964f">on</a> (<a class="el" href="namespaceripple_1_1test_1_1csf.html#a1a320722bad8a720a9497b656493dd50">PeerID</a> who, <a class="el" href="namespaceripple_1_1test_1_1csf.html#a94af4815b9aaf71de676cd8377415473">SimTime</a> when, <a class="el" href="structripple_1_1test_1_1csf_1_1AcceptLedger.html">AcceptLedger</a> const &amp;e)</td></tr>
<tr class="separator:a573a37f823030a459ce59e6108cf964f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae81a6eac5ca794a3a288b22d7fa5d46e" id="r_ae81a6eac5ca794a3a288b22d7fa5d46e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1test_1_1csf_1_1JumpCollector.html#ae81a6eac5ca794a3a288b22d7fa5d46e">on</a> (<a class="el" href="namespaceripple_1_1test_1_1csf.html#a1a320722bad8a720a9497b656493dd50">PeerID</a> who, <a class="el" href="namespaceripple_1_1test_1_1csf.html#a94af4815b9aaf71de676cd8377415473">SimTime</a> when, <a class="el" href="structripple_1_1test_1_1csf_1_1FullyValidateLedger.html">FullyValidateLedger</a> const &amp;e)</td></tr>
<tr class="separator:ae81a6eac5ca794a3a288b22d7fa5d46e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:ae9e0390798475dff0e3e2f5048b4103f" id="r_ae9e0390798475dff0e3e2f5048b4103f"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a>&lt; <a class="el" href="structripple_1_1test_1_1csf_1_1JumpCollector_1_1Jump.html">Jump</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1test_1_1csf_1_1JumpCollector.html#ae9e0390798475dff0e3e2f5048b4103f">closeJumps</a></td></tr>
<tr class="separator:ae9e0390798475dff0e3e2f5048b4103f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a50dbded65e857a5e9598875d471b6ff5" id="r_a50dbded65e857a5e9598875d471b6ff5"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a>&lt; <a class="el" href="structripple_1_1test_1_1csf_1_1JumpCollector_1_1Jump.html">Jump</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1test_1_1csf_1_1JumpCollector.html#a50dbded65e857a5e9598875d471b6ff5">fullyValidatedJumps</a></td></tr>
<tr class="separator:a50dbded65e857a5e9598875d471b6ff5"><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>Saves information about Jumps for closed and fully validated ledgers. </p>
<p>A jump occurs when a node closes/fully validates a new ledger that is not the immediate child of the prior closed/fully validated ledgers. This includes jumps across branches and jumps ahead in the same branch of ledger history. </p>
<p class="definition">Definition at line <a class="el" href="collectors_8h_source.html#l00662">662</a> of file <a class="el" href="collectors_8h_source.html">collectors.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a648b16939cc6499466e7f1e86d6433f8" name="a648b16939cc6499466e7f1e86d6433f8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a648b16939cc6499466e7f1e86d6433f8">&#9670;&#160;</a></span>on() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class E &gt; </div>
<table class="memname">
<tr>
<td class="memname">void ripple::test::csf::JumpCollector::on </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceripple_1_1test_1_1csf.html#a1a320722bad8a720a9497b656493dd50">PeerID</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_1_1csf.html#a94af4815b9aaf71de676cd8377415473">SimTime</a>&#160;</td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">E const &amp;&#160;</td>
<td class="paramname"><em>e</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="collectors_8h_source.html#l00678">678</a> of file <a class="el" href="collectors_8h_source.html">collectors.h</a>.</p>
</div>
</div>
<a id="a573a37f823030a459ce59e6108cf964f" name="a573a37f823030a459ce59e6108cf964f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a573a37f823030a459ce59e6108cf964f">&#9670;&#160;</a></span>on() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ripple::test::csf::JumpCollector::on </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceripple_1_1test_1_1csf.html#a1a320722bad8a720a9497b656493dd50">PeerID</a>&#160;</td>
<td class="paramname"><em>who</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceripple_1_1test_1_1csf.html#a94af4815b9aaf71de676cd8377415473">SimTime</a>&#160;</td>
<td class="paramname"><em>when</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structripple_1_1test_1_1csf_1_1AcceptLedger.html">AcceptLedger</a> const &amp;&#160;</td>
<td class="paramname"><em>e</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="collectors_8h_source.html#l00683">683</a> of file <a class="el" href="collectors_8h_source.html">collectors.h</a>.</p>
</div>
</div>
<a id="ae81a6eac5ca794a3a288b22d7fa5d46e" name="ae81a6eac5ca794a3a288b22d7fa5d46e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae81a6eac5ca794a3a288b22d7fa5d46e">&#9670;&#160;</a></span>on() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ripple::test::csf::JumpCollector::on </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceripple_1_1test_1_1csf.html#a1a320722bad8a720a9497b656493dd50">PeerID</a>&#160;</td>
<td class="paramname"><em>who</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceripple_1_1test_1_1csf.html#a94af4815b9aaf71de676cd8377415473">SimTime</a>&#160;</td>
<td class="paramname"><em>when</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structripple_1_1test_1_1csf_1_1FullyValidateLedger.html">FullyValidateLedger</a> const &amp;&#160;</td>
<td class="paramname"><em>e</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="collectors_8h_source.html#l00691">691</a> of file <a class="el" href="collectors_8h_source.html">collectors.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="ae9e0390798475dff0e3e2f5048b4103f" name="ae9e0390798475dff0e3e2f5048b4103f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae9e0390798475dff0e3e2f5048b4103f">&#9670;&#160;</a></span>closeJumps</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a>&lt;<a class="el" href="structripple_1_1test_1_1csf_1_1JumpCollector_1_1Jump.html">Jump</a>&gt; ripple::test::csf::JumpCollector::closeJumps</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="collectors_8h_source.html#l00672">672</a> of file <a class="el" href="collectors_8h_source.html">collectors.h</a>.</p>
</div>
</div>
<a id="a50dbded65e857a5e9598875d471b6ff5" name="a50dbded65e857a5e9598875d471b6ff5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a50dbded65e857a5e9598875d471b6ff5">&#9670;&#160;</a></span>fullyValidatedJumps</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a>&lt;<a class="el" href="structripple_1_1test_1_1csf_1_1JumpCollector_1_1Jump.html">Jump</a>&gt; ripple::test::csf::JumpCollector::fullyValidatedJumps</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="collectors_8h_source.html#l00673">673</a> of file <a class="el" href="collectors_8h_source.html">collectors.h</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>