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

673 lines
36 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::InboundLedgers 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="classripple_1_1InboundLedgers.html">InboundLedgers</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classripple_1_1InboundLedgers-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::InboundLedgers Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
</div><!--header-->
<div class="contents">
<p>Manages the lifetime of inbound ledgers.
<a href="classripple_1_1InboundLedgers.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="InboundLedgers_8h_source.html">InboundLedgers.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ripple::InboundLedgers:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1InboundLedgers__inherit__graph.png" border="0" usemap="#aripple_1_1InboundLedgers_inherit__map" alt="Inheritance graph"/></div>
<map name="aripple_1_1InboundLedgers_inherit__map" id="aripple_1_1InboundLedgers_inherit__map">
<area shape="rect" title="Manages the lifetime of inbound ledgers." alt="" coords="125,5,296,31"/>
<area shape="rect" href="classripple_1_1InboundLedgersImp.html" title=" " alt="" coords="5,86,200,111"/>
<area shape="poly" title=" " alt="" coords="185,41,120,88,117,84,182,37"/>
<area shape="rect" href="classripple_1_1test_1_1MagicInboundLedgers.html" title="Simulate a network InboundLedgers." alt="" coords="225,79,415,119"/>
<area shape="poly" title=" " alt="" coords="239,36,295,76,292,81,236,41"/>
</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-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a0b264439abc0967cb47ebd106c0d62f6" id="r_a0b264439abc0967cb47ebd106c0d62f6"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1InboundLedgers.html#a0b264439abc0967cb47ebd106c0d62f6">clock_type</a> = <a class="el" href="classbeast_1_1abstract__clock.html">beast::abstract_clock</a>&lt; <a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/steady_clock.html">std::chrono::steady_clock</a> &gt;</td></tr>
<tr class="separator:a0b264439abc0967cb47ebd106c0d62f6"><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:a69b145089704c611f56786ace0262abd" id="r_a69b145089704c611f56786ace0262abd"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1InboundLedgers.html#a69b145089704c611f56786ace0262abd">~InboundLedgers</a> ()=default</td></tr>
<tr class="separator:a69b145089704c611f56786ace0262abd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a504951d354fa8cbd7c0d41f90f776a4f" id="r_a504951d354fa8cbd7c0d41f90f776a4f"><td class="memItemLeft" align="right" valign="top">virtual <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_1Ledger.html">Ledger</a> const &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1InboundLedgers.html#a504951d354fa8cbd7c0d41f90f776a4f">acquire</a> (<a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> const &amp;hash, <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> seq, <a class="el" href="classripple_1_1InboundLedger.html#a3e8d7f8b5fa089a184dcc9b00b6e0da7">InboundLedger::Reason</a>)=0</td></tr>
<tr class="separator:a504951d354fa8cbd7c0d41f90f776a4f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2f947ae377258e360a593100db329100" id="r_a2f947ae377258e360a593100db329100"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1InboundLedgers.html#a2f947ae377258e360a593100db329100">acquireAsync</a> (<a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> const &amp;hash, <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> seq, <a class="el" href="classripple_1_1InboundLedger.html#a3e8d7f8b5fa089a184dcc9b00b6e0da7">InboundLedger::Reason</a> reason)=0</td></tr>
<tr class="separator:a2f947ae377258e360a593100db329100"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8d54affab86e8dcc634bbcd926019ef1" id="r_a8d54affab86e8dcc634bbcd926019ef1"><td class="memItemLeft" align="right" valign="top">virtual <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_1InboundLedger.html">InboundLedger</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1InboundLedgers.html#a8d54affab86e8dcc634bbcd926019ef1">find</a> (<a class="el" href="namespaceripple.html#af5a72d3e0d9b6913c13f688390b90796">LedgerHash</a> const &amp;hash)=0</td></tr>
<tr class="separator:a8d54affab86e8dcc634bbcd926019ef1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a600000acda36c21ecc1f29defe89a278" id="r_a600000acda36c21ecc1f29defe89a278"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1InboundLedgers.html#a600000acda36c21ecc1f29defe89a278">gotLedgerData</a> (<a class="el" href="namespaceripple.html#af5a72d3e0d9b6913c13f688390b90796">LedgerHash</a> const &amp;ledgerHash, <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;, <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; protocol::TMLedgerData &gt;)=0</td></tr>
<tr class="separator:a600000acda36c21ecc1f29defe89a278"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad9450051586f5f5ae5a0297d15fdbfdf" id="r_ad9450051586f5f5ae5a0297d15fdbfdf"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1InboundLedgers.html#ad9450051586f5f5ae5a0297d15fdbfdf">gotStaleData</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; protocol::TMLedgerData &gt; packet)=0</td></tr>
<tr class="separator:ad9450051586f5f5ae5a0297d15fdbfdf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5c5d7da0b302fc02ed81082c32fcd48d" id="r_a5c5d7da0b302fc02ed81082c32fcd48d"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1InboundLedgers.html#a5c5d7da0b302fc02ed81082c32fcd48d">logFailure</a> (<a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> const &amp;h, <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> seq)=0</td></tr>
<tr class="separator:a5c5d7da0b302fc02ed81082c32fcd48d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abfa7313dd062dc0f416dfa71d8dad546" id="r_abfa7313dd062dc0f416dfa71d8dad546"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1InboundLedgers.html#abfa7313dd062dc0f416dfa71d8dad546">isFailure</a> (<a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> const &amp;h)=0</td></tr>
<tr class="separator:abfa7313dd062dc0f416dfa71d8dad546"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0dd139449bf0efa340edb0b3265032c6" id="r_a0dd139449bf0efa340edb0b3265032c6"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1InboundLedgers.html#a0dd139449bf0efa340edb0b3265032c6">clearFailures</a> ()=0</td></tr>
<tr class="separator:a0dd139449bf0efa340edb0b3265032c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a51a2b07c207e628f159aa89e6402250d" id="r_a51a2b07c207e628f159aa89e6402250d"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classJson_1_1Value.html">Json::Value</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1InboundLedgers.html#a51a2b07c207e628f159aa89e6402250d">getInfo</a> ()=0</td></tr>
<tr class="separator:a51a2b07c207e628f159aa89e6402250d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa8e8fceb23a3f9bf00b604c9c0a69d87" id="r_aa8e8fceb23a3f9bf00b604c9c0a69d87"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1InboundLedgers.html#aa8e8fceb23a3f9bf00b604c9c0a69d87">fetchRate</a> ()=0</td></tr>
<tr class="memdesc:aa8e8fceb23a3f9bf00b604c9c0a69d87"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the rate of historical ledger fetches per minute. <br /></td></tr>
<tr class="separator:aa8e8fceb23a3f9bf00b604c9c0a69d87"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aff8b120dd69c652db5c3327d7eab5f8d" id="r_aff8b120dd69c652db5c3327d7eab5f8d"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1InboundLedgers.html#aff8b120dd69c652db5c3327d7eab5f8d">onLedgerFetched</a> ()=0</td></tr>
<tr class="memdesc:aff8b120dd69c652db5c3327d7eab5f8d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called when a complete ledger is obtained. <br /></td></tr>
<tr class="separator:aff8b120dd69c652db5c3327d7eab5f8d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac03c12b9aad2af653f21f72411205d1e" id="r_ac03c12b9aad2af653f21f72411205d1e"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1InboundLedgers.html#ac03c12b9aad2af653f21f72411205d1e">gotFetchPack</a> ()=0</td></tr>
<tr class="separator:ac03c12b9aad2af653f21f72411205d1e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2bb3b2c716ef8839a360493277a0c53d" id="r_a2bb3b2c716ef8839a360493277a0c53d"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1InboundLedgers.html#a2bb3b2c716ef8839a360493277a0c53d">sweep</a> ()=0</td></tr>
<tr class="separator:a2bb3b2c716ef8839a360493277a0c53d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5619c1c0ea5b6e666d33da64f8203a5a" id="r_a5619c1c0ea5b6e666d33da64f8203a5a"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1InboundLedgers.html#a5619c1c0ea5b6e666d33da64f8203a5a">stop</a> ()=0</td></tr>
<tr class="separator:a5619c1c0ea5b6e666d33da64f8203a5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6091914913a7c97f83a790b217f068e4" id="r_a6091914913a7c97f83a790b217f068e4"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1InboundLedgers.html#a6091914913a7c97f83a790b217f068e4">cacheSize</a> ()=0</td></tr>
<tr class="separator:a6091914913a7c97f83a790b217f068e4"><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>Manages the lifetime of inbound ledgers. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classripple_1_1InboundLedger.html">InboundLedger</a> </dd></dl>
<p class="definition">Definition at line <a class="el" href="InboundLedgers_8h_source.html#l00014">14</a> of file <a class="el" href="InboundLedgers_8h_source.html">InboundLedgers.h</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a0b264439abc0967cb47ebd106c0d62f6" name="a0b264439abc0967cb47ebd106c0d62f6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0b264439abc0967cb47ebd106c0d62f6">&#9670;&#160;</a></span>clock_type</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classripple_1_1InboundLedgers.html#a0b264439abc0967cb47ebd106c0d62f6">ripple::InboundLedgers::clock_type</a> = <a class="el" href="classbeast_1_1abstract__clock.html">beast::abstract_clock</a>&lt;<a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/steady_clock.html">std::chrono::steady_clock</a>&gt;</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="InboundLedgers_8h_source.html#l00017">17</a> of file <a class="el" href="InboundLedgers_8h_source.html">InboundLedgers.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a69b145089704c611f56786ace0262abd" name="a69b145089704c611f56786ace0262abd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a69b145089704c611f56786ace0262abd">&#9670;&#160;</a></span>~InboundLedgers()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual ripple::InboundLedgers::~InboundLedgers </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="a504951d354fa8cbd7c0d41f90f776a4f" name="a504951d354fa8cbd7c0d41f90f776a4f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a504951d354fa8cbd7c0d41f90f776a4f">&#9670;&#160;</a></span>acquire()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <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_1Ledger.html">Ledger</a> const &gt; ripple::InboundLedgers::acquire </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> const &amp;&#160;</td>
<td class="paramname"><em>hash</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>seq</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classripple_1_1InboundLedger.html#a3e8d7f8b5fa089a184dcc9b00b6e0da7">InboundLedger::Reason</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_1InboundLedgersImp.html#a9f77846dfd400c30fbe4ab16fa7f32ca">ripple::InboundLedgersImp</a>, and <a class="el" href="classripple_1_1test_1_1MagicInboundLedgers.html#aea192ed7c43895d59e801625db5e7521">ripple::test::MagicInboundLedgers</a>.</p>
</div>
</div>
<a id="a2f947ae377258e360a593100db329100" name="a2f947ae377258e360a593100db329100"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2f947ae377258e360a593100db329100">&#9670;&#160;</a></span>acquireAsync()</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::InboundLedgers::acquireAsync </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> const &amp;&#160;</td>
<td class="paramname"><em>hash</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>seq</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classripple_1_1InboundLedger.html#a3e8d7f8b5fa089a184dcc9b00b6e0da7">InboundLedger::Reason</a>&#160;</td>
<td class="paramname"><em>reason</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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="classripple_1_1test_1_1MagicInboundLedgers.html#a08b979d6bf0f113b252cb1573214842c">ripple::test::MagicInboundLedgers</a>, and <a class="el" href="classripple_1_1InboundLedgersImp.html#aa664e171b1570a5e426f1fa342b46891">ripple::InboundLedgersImp</a>.</p>
</div>
</div>
<a id="a8d54affab86e8dcc634bbcd926019ef1" name="a8d54affab86e8dcc634bbcd926019ef1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8d54affab86e8dcc634bbcd926019ef1">&#9670;&#160;</a></span>find()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <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_1InboundLedger.html">InboundLedger</a> &gt; ripple::InboundLedgers::find </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceripple.html#af5a72d3e0d9b6913c13f688390b90796">LedgerHash</a> const &amp;&#160;</td>
<td class="paramname"><em>hash</em></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_1MagicInboundLedgers.html#a4d45327225ec164ac3a96d9abb259e33">ripple::test::MagicInboundLedgers</a>.</p>
</div>
</div>
<a id="a600000acda36c21ecc1f29defe89a278" name="a600000acda36c21ecc1f29defe89a278"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a600000acda36c21ecc1f29defe89a278">&#9670;&#160;</a></span>gotLedgerData()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool ripple::InboundLedgers::gotLedgerData </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceripple.html#af5a72d3e0d9b6913c13f688390b90796">LedgerHash</a> const &amp;&#160;</td>
<td class="paramname"><em>ledgerHash</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;&#160;</td>
<td class="paramname">, </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; protocol::TMLedgerData &gt;&#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_1InboundLedgersImp.html#ac207b111ec4c0ddbe9e63e2d91f595fc">ripple::InboundLedgersImp</a>, and <a class="el" href="classripple_1_1test_1_1MagicInboundLedgers.html#a32ad5902ac5e1149893eb38b3cf1ab2e">ripple::test::MagicInboundLedgers</a>.</p>
</div>
</div>
<a id="ad9450051586f5f5ae5a0297d15fdbfdf" name="ad9450051586f5f5ae5a0297d15fdbfdf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad9450051586f5f5ae5a0297d15fdbfdf">&#9670;&#160;</a></span>gotStaleData()</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::InboundLedgers::gotStaleData </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; protocol::TMLedgerData &gt;&#160;</td>
<td class="paramname"><em>packet</em></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_1MagicInboundLedgers.html#ab40a62e766af5c40dbc03f571f22083c">ripple::test::MagicInboundLedgers</a>, and <a class="el" href="classripple_1_1InboundLedgersImp.html#a6d940d88767dd473bf0a68efa2208b27">ripple::InboundLedgersImp</a>.</p>
</div>
</div>
<a id="a5c5d7da0b302fc02ed81082c32fcd48d" name="a5c5d7da0b302fc02ed81082c32fcd48d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5c5d7da0b302fc02ed81082c32fcd48d">&#9670;&#160;</a></span>logFailure()</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::InboundLedgers::logFailure </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> const &amp;&#160;</td>
<td class="paramname"><em>h</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>seq</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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="classripple_1_1test_1_1MagicInboundLedgers.html#a8b5dec1e1d8d856f4406c59b63c6174c">ripple::test::MagicInboundLedgers</a>, and <a class="el" href="classripple_1_1InboundLedgersImp.html#a6bf9e1542579f52723b136fa43dbe1e7">ripple::InboundLedgersImp</a>.</p>
</div>
</div>
<a id="abfa7313dd062dc0f416dfa71d8dad546" name="abfa7313dd062dc0f416dfa71d8dad546"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abfa7313dd062dc0f416dfa71d8dad546">&#9670;&#160;</a></span>isFailure()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool ripple::InboundLedgers::isFailure </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> const &amp;&#160;</td>
<td class="paramname"><em>h</em></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_1MagicInboundLedgers.html#aa284042ad6d4bea239c65803884f2b54">ripple::test::MagicInboundLedgers</a>, and <a class="el" href="classripple_1_1InboundLedgersImp.html#ae4a2ffebfe62cf8b4d606c0590e866c7">ripple::InboundLedgersImp</a>.</p>
</div>
</div>
<a id="a0dd139449bf0efa340edb0b3265032c6" name="a0dd139449bf0efa340edb0b3265032c6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0dd139449bf0efa340edb0b3265032c6">&#9670;&#160;</a></span>clearFailures()</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::InboundLedgers::clearFailures </td>
<td>(</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_1MagicInboundLedgers.html#a2a0e7fb5a536af0345a8907127699add">ripple::test::MagicInboundLedgers</a>, and <a class="el" href="classripple_1_1InboundLedgersImp.html#a012aae8d9bdc9b8556d9319217228210">ripple::InboundLedgersImp</a>.</p>
</div>
</div>
<a id="a51a2b07c207e628f159aa89e6402250d" name="a51a2b07c207e628f159aa89e6402250d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a51a2b07c207e628f159aa89e6402250d">&#9670;&#160;</a></span>getInfo()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classJson_1_1Value.html">Json::Value</a> ripple::InboundLedgers::getInfo </td>
<td>(</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_1MagicInboundLedgers.html#a5cc0f2ed06a80fc9d04d346edf0caa4c">ripple::test::MagicInboundLedgers</a>, and <a class="el" href="classripple_1_1InboundLedgersImp.html#a4542637e8a4d75ae96a8dec456038a7b">ripple::InboundLedgersImp</a>.</p>
</div>
</div>
<a id="aa8e8fceb23a3f9bf00b604c9c0a69d87" name="aa8e8fceb23a3f9bf00b604c9c0a69d87"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa8e8fceb23a3f9bf00b604c9c0a69d87">&#9670;&#160;</a></span>fetchRate()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> ripple::InboundLedgers::fetchRate </td>
<td>(</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>Returns the rate of historical ledger fetches per minute. </p>
<p>Implemented in <a class="el" href="classripple_1_1test_1_1MagicInboundLedgers.html#ad121c705b23993a932db17e2e4a21ae1">ripple::test::MagicInboundLedgers</a>, and <a class="el" href="classripple_1_1InboundLedgersImp.html#ab901198c8351967199bcb95bfb7162d5">ripple::InboundLedgersImp</a>.</p>
</div>
</div>
<a id="aff8b120dd69c652db5c3327d7eab5f8d" name="aff8b120dd69c652db5c3327d7eab5f8d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aff8b120dd69c652db5c3327d7eab5f8d">&#9670;&#160;</a></span>onLedgerFetched()</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::InboundLedgers::onLedgerFetched </td>
<td>(</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>Called when a complete ledger is obtained. </p>
<p>Implemented in <a class="el" href="classripple_1_1test_1_1MagicInboundLedgers.html#a13db828e982bb41618dea15a8b01e003">ripple::test::MagicInboundLedgers</a>, and <a class="el" href="classripple_1_1InboundLedgersImp.html#ac51f712bab614e07330b6859ef447d44">ripple::InboundLedgersImp</a>.</p>
</div>
</div>
<a id="ac03c12b9aad2af653f21f72411205d1e" name="ac03c12b9aad2af653f21f72411205d1e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac03c12b9aad2af653f21f72411205d1e">&#9670;&#160;</a></span>gotFetchPack()</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::InboundLedgers::gotFetchPack </td>
<td>(</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_1MagicInboundLedgers.html#ad721f621115df060fa2f9882dd8891d7">ripple::test::MagicInboundLedgers</a>, and <a class="el" href="classripple_1_1InboundLedgersImp.html#a3f1dab2ad47bcf10ad51497ad503a7ea">ripple::InboundLedgersImp</a>.</p>
</div>
</div>
<a id="a2bb3b2c716ef8839a360493277a0c53d" name="a2bb3b2c716ef8839a360493277a0c53d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2bb3b2c716ef8839a360493277a0c53d">&#9670;&#160;</a></span>sweep()</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::InboundLedgers::sweep </td>
<td>(</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_1MagicInboundLedgers.html#a3b9573297de275d86c441ac4cc5b2d49">ripple::test::MagicInboundLedgers</a>, and <a class="el" href="classripple_1_1InboundLedgersImp.html#a56c2e865dd2f67eef9cf7516d5f57876">ripple::InboundLedgersImp</a>.</p>
</div>
</div>
<a id="a5619c1c0ea5b6e666d33da64f8203a5a" name="a5619c1c0ea5b6e666d33da64f8203a5a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5619c1c0ea5b6e666d33da64f8203a5a">&#9670;&#160;</a></span>stop()</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::InboundLedgers::stop </td>
<td>(</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_1MagicInboundLedgers.html#a624ebbf034f8c0d13e795ee4b22c33a5">ripple::test::MagicInboundLedgers</a>, and <a class="el" href="classripple_1_1InboundLedgersImp.html#a88e8fd50a41647c9c50909858eeff941">ripple::InboundLedgersImp</a>.</p>
</div>
</div>
<a id="a6091914913a7c97f83a790b217f068e4" name="a6091914913a7c97f83a790b217f068e4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6091914913a7c97f83a790b217f068e4">&#9670;&#160;</a></span>cacheSize()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> ripple::InboundLedgers::cacheSize </td>
<td>(</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_1MagicInboundLedgers.html#a76b767a94cdcc71676302a7958daf57c">ripple::test::MagicInboundLedgers</a>, and <a class="el" href="classripple_1_1InboundLedgersImp.html#a067df4bc98f0ac69bddc48a7a241af7b">ripple::InboundLedgersImp</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