mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-25 13:35:54 +00:00
589 lines
31 KiB
HTML
589 lines
31 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">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.17"/>
|
|
<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 style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">rippled
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.17 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(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">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</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> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<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>
|
|
<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="#ripple_1_1InboundLedgers_inherit__map" alt="Inheritance graph"/></div>
|
|
<map name="ripple_1_1InboundLedgers_inherit__map" id="ripple_1_1InboundLedgers_inherit__map">
|
|
<area shape="rect" title="Manages the lifetime of inbound ledgers." alt="" coords="125,5,296,32"/>
|
|
<area shape="rect" href="classripple_1_1InboundLedgersImp.html" title=" " alt="" coords="5,87,200,114"/>
|
|
<area shape="rect" href="classripple_1_1test_1_1MagicInboundLedgers.html" title="Simulate a network InboundLedgers." alt="" coords="225,80,415,121"/>
|
|
</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 name="pub-types"></a>
|
|
Public Types</h2></td></tr>
|
|
<tr class="memitem:a0b264439abc0967cb47ebd106c0d62f6"><td class="memItemLeft" align="right" valign="top">using </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>< <a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/steady_clock.html">std::chrono::steady_clock</a> ></td></tr>
|
|
<tr class="separator:a0b264439abc0967cb47ebd106c0d62f6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a69b145089704c611f56786ace0262abd"><td class="memItemLeft" align="right" valign="top">virtual </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"> </td></tr>
|
|
<tr class="memitem:ad346b5eb8ce7d749218ad3fb1ef45530"><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>< <a class="el" href="classripple_1_1Ledger.html">Ledger</a> const > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1InboundLedgers.html#ad346b5eb8ce7d749218ad3fb1ef45530">acquire</a> (<a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> const &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:ad346b5eb8ce7d749218ad3fb1ef45530"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0d8a7699ca582b7fd8eab345f10c021d"><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>< <a class="el" href="classripple_1_1InboundLedger.html">InboundLedger</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1InboundLedgers.html#a0d8a7699ca582b7fd8eab345f10c021d">find</a> (<a class="el" href="namespaceripple.html#af5a72d3e0d9b6913c13f688390b90796">LedgerHash</a> const &hash)=0</td></tr>
|
|
<tr class="separator:a0d8a7699ca582b7fd8eab345f10c021d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a600000acda36c21ecc1f29defe89a278"><td class="memItemLeft" align="right" valign="top">virtual bool </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 &ledgerHash, <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>< <a class="el" href="classripple_1_1Peer.html">Peer</a> >, <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>< protocol::TMLedgerData >)=0</td></tr>
|
|
<tr class="separator:a600000acda36c21ecc1f29defe89a278"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad9450051586f5f5ae5a0297d15fdbfdf"><td class="memItemLeft" align="right" valign="top">virtual void </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>< protocol::TMLedgerData > packet)=0</td></tr>
|
|
<tr class="separator:ad9450051586f5f5ae5a0297d15fdbfdf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5c5d7da0b302fc02ed81082c32fcd48d"><td class="memItemLeft" align="right" valign="top">virtual void </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 &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"> </td></tr>
|
|
<tr class="memitem:abfa7313dd062dc0f416dfa71d8dad546"><td class="memItemLeft" align="right" valign="top">virtual bool </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 &h)=0</td></tr>
|
|
<tr class="separator:abfa7313dd062dc0f416dfa71d8dad546"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0dd139449bf0efa340edb0b3265032c6"><td class="memItemLeft" align="right" valign="top">virtual void </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"> </td></tr>
|
|
<tr class="memitem:a51a2b07c207e628f159aa89e6402250d"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classJson_1_1Value.html">Json::Value</a> </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"> </td></tr>
|
|
<tr class="memitem: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> </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"> </td><td class="mdescRight">Returns the rate of historical ledger fetches per minute. <a href="classripple_1_1InboundLedgers.html#aa8e8fceb23a3f9bf00b604c9c0a69d87">More...</a><br /></td></tr>
|
|
<tr class="separator:aa8e8fceb23a3f9bf00b604c9c0a69d87"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aff8b120dd69c652db5c3327d7eab5f8d"><td class="memItemLeft" align="right" valign="top">virtual void </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"> </td><td class="mdescRight">Called when a complete ledger is obtained. <a href="classripple_1_1InboundLedgers.html#aff8b120dd69c652db5c3327d7eab5f8d">More...</a><br /></td></tr>
|
|
<tr class="separator:aff8b120dd69c652db5c3327d7eab5f8d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac03c12b9aad2af653f21f72411205d1e"><td class="memItemLeft" align="right" valign="top">virtual void </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"> </td></tr>
|
|
<tr class="memitem:a2bb3b2c716ef8839a360493277a0c53d"><td class="memItemLeft" align="right" valign="top">virtual void </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"> </td></tr>
|
|
<tr class="memitem:a5619c1c0ea5b6e666d33da64f8203a5a"><td class="memItemLeft" align="right" valign="top">virtual void </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"> </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#l00033">33</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"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0b264439abc0967cb47ebd106c0d62f6">◆ </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><<a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/steady_clock.html">std::chrono::steady_clock</a>></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="InboundLedgers_8h_source.html#l00036">36</a> of file <a class="el" href="InboundLedgers_8h_source.html">InboundLedgers.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a69b145089704c611f56786ace0262abd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a69b145089704c611f56786ace0262abd">◆ </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="ad346b5eb8ce7d749218ad3fb1ef45530"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad346b5eb8ce7d749218ad3fb1ef45530">◆ </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><<a class="el" href="classripple_1_1Ledger.html">Ledger</a> const> ripple::InboundLedgers::acquire </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> const & </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> </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> </td>
|
|
<td class="paramname"> </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#a956648d3d15c9e8ffba10b960a6c5e55">ripple::test::MagicInboundLedgers</a>, and <a class="el" href="classripple_1_1InboundLedgersImp.html#a4410398a5eaebf565d5355feba32dd9b">ripple::InboundLedgersImp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0d8a7699ca582b7fd8eab345f10c021d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0d8a7699ca582b7fd8eab345f10c021d">◆ </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><<a class="el" href="classripple_1_1InboundLedger.html">InboundLedger</a>> ripple::InboundLedgers::find </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespaceripple.html#af5a72d3e0d9b6913c13f688390b90796">LedgerHash</a> const & </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_1InboundLedgersImp.html#a970ca13c3ac53d4be592a7e9d000cf2b">ripple::InboundLedgersImp</a>, and <a class="el" href="classripple_1_1test_1_1MagicInboundLedgers.html#a588f7b40af6c6c3ffa7b084c6325c03a">ripple::test::MagicInboundLedgers</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a600000acda36c21ecc1f29defe89a278"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a600000acda36c21ecc1f29defe89a278">◆ </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 & </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>< <a class="el" href="classripple_1_1Peer.html">Peer</a> > </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>< protocol::TMLedgerData > </td>
|
|
<td class="paramname"> </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#a32ad5902ac5e1149893eb38b3cf1ab2e">ripple::test::MagicInboundLedgers</a>, and <a class="el" href="classripple_1_1InboundLedgersImp.html#ac207b111ec4c0ddbe9e63e2d91f595fc">ripple::InboundLedgersImp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad9450051586f5f5ae5a0297d15fdbfdf"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad9450051586f5f5ae5a0297d15fdbfdf">◆ </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>< protocol::TMLedgerData > </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_1InboundLedgersImp.html#a6d940d88767dd473bf0a68efa2208b27">ripple::InboundLedgersImp</a>, and <a class="el" href="classripple_1_1test_1_1MagicInboundLedgers.html#ab40a62e766af5c40dbc03f571f22083c">ripple::test::MagicInboundLedgers</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5c5d7da0b302fc02ed81082c32fcd48d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5c5d7da0b302fc02ed81082c32fcd48d">◆ </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 & </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> </td>
|
|
<td class="paramname"><em>seq</em> </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#a6bf9e1542579f52723b136fa43dbe1e7">ripple::InboundLedgersImp</a>, and <a class="el" href="classripple_1_1test_1_1MagicInboundLedgers.html#a8b5dec1e1d8d856f4406c59b63c6174c">ripple::test::MagicInboundLedgers</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abfa7313dd062dc0f416dfa71d8dad546"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abfa7313dd062dc0f416dfa71d8dad546">◆ </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 & </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_1InboundLedgersImp.html#ae4a2ffebfe62cf8b4d606c0590e866c7">ripple::InboundLedgersImp</a>, and <a class="el" href="classripple_1_1test_1_1MagicInboundLedgers.html#aa284042ad6d4bea239c65803884f2b54">ripple::test::MagicInboundLedgers</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0dd139449bf0efa340edb0b3265032c6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0dd139449bf0efa340edb0b3265032c6">◆ </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_1InboundLedgersImp.html#a012aae8d9bdc9b8556d9319217228210">ripple::InboundLedgersImp</a>, and <a class="el" href="classripple_1_1test_1_1MagicInboundLedgers.html#a2a0e7fb5a536af0345a8907127699add">ripple::test::MagicInboundLedgers</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a51a2b07c207e628f159aa89e6402250d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a51a2b07c207e628f159aa89e6402250d">◆ </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_1InboundLedgersImp.html#a4542637e8a4d75ae96a8dec456038a7b">ripple::InboundLedgersImp</a>, and <a class="el" href="classripple_1_1test_1_1MagicInboundLedgers.html#a5cc0f2ed06a80fc9d04d346edf0caa4c">ripple::test::MagicInboundLedgers</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa8e8fceb23a3f9bf00b604c9c0a69d87"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa8e8fceb23a3f9bf00b604c9c0a69d87">◆ </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_1InboundLedgersImp.html#ab901198c8351967199bcb95bfb7162d5">ripple::InboundLedgersImp</a>, and <a class="el" href="classripple_1_1test_1_1MagicInboundLedgers.html#ad121c705b23993a932db17e2e4a21ae1">ripple::test::MagicInboundLedgers</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aff8b120dd69c652db5c3327d7eab5f8d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aff8b120dd69c652db5c3327d7eab5f8d">◆ </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_1InboundLedgersImp.html#ac51f712bab614e07330b6859ef447d44">ripple::InboundLedgersImp</a>, and <a class="el" href="classripple_1_1test_1_1MagicInboundLedgers.html#a13db828e982bb41618dea15a8b01e003">ripple::test::MagicInboundLedgers</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac03c12b9aad2af653f21f72411205d1e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac03c12b9aad2af653f21f72411205d1e">◆ </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_1InboundLedgersImp.html#a3f1dab2ad47bcf10ad51497ad503a7ea">ripple::InboundLedgersImp</a>, and <a class="el" href="classripple_1_1test_1_1MagicInboundLedgers.html#ad721f621115df060fa2f9882dd8891d7">ripple::test::MagicInboundLedgers</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2bb3b2c716ef8839a360493277a0c53d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2bb3b2c716ef8839a360493277a0c53d">◆ </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_1InboundLedgersImp.html#a56c2e865dd2f67eef9cf7516d5f57876">ripple::InboundLedgersImp</a>, and <a class="el" href="classripple_1_1test_1_1MagicInboundLedgers.html#a3b9573297de275d86c441ac4cc5b2d49">ripple::test::MagicInboundLedgers</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5619c1c0ea5b6e666d33da64f8203a5a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5619c1c0ea5b6e666d33da64f8203a5a">◆ </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_1InboundLedgersImp.html#a88e8fd50a41647c9c50909858eeff941">ripple::InboundLedgersImp</a>, and <a class="el" href="classripple_1_1test_1_1MagicInboundLedgers.html#a624ebbf034f8c0d13e795ee4b22c33a5">ripple::test::MagicInboundLedgers</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.17
|
|
</small></address>
|
|
</body>
|
|
</html>
|