mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-20 11:05:54 +00:00
182 lines
9.2 KiB
HTML
182 lines
9.2 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::AbstractFetchPackContainer 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&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&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_1AbstractFetchPackContainer.html">AbstractFetchPackContainer</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="classripple_1_1AbstractFetchPackContainer-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">ripple::AbstractFetchPackContainer Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>An interface facilitating retrieval of fetch packs without an application or ledgermaster object.
|
|
<a href="classripple_1_1AbstractFetchPackContainer.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="AbstractFetchPackContainer_8h_source.html">AbstractFetchPackContainer.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for ripple::AbstractFetchPackContainer:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classripple_1_1AbstractFetchPackContainer__inherit__graph.png" border="0" usemap="#aripple_1_1AbstractFetchPackContainer_inherit__map" alt="Inheritance graph"/></div>
|
|
<map name="aripple_1_1AbstractFetchPackContainer_inherit__map" id="aripple_1_1AbstractFetchPackContainer_inherit__map">
|
|
<area shape="rect" title="An interface facilitating retrieval of fetch packs without an application or ledgermaster object." alt="" coords="5,5,192,45"/>
|
|
<area shape="rect" href="classripple_1_1LedgerMaster.html" title=" " alt="" coords="21,93,177,119"/>
|
|
<area shape="poly" title=" " alt="" coords="101,59,101,93,96,93,96,59"/>
|
|
</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:a2bef43de3153bf61d0308cb077285313" id="r_a2bef43de3153bf61d0308cb077285313"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AbstractFetchPackContainer.html#a2bef43de3153bf61d0308cb077285313">~AbstractFetchPackContainer</a> ()=default</td></tr>
|
|
<tr class="separator:a2bef43de3153bf61d0308cb077285313"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a38ff557891e927e4bf046acdb8af37bd" id="r_a38ff557891e927e4bf046acdb8af37bd"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>< <a class="el" href="namespaceripple.html#ab1f2184bb5938b5508798cd47a561a21">Blob</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AbstractFetchPackContainer.html#a38ff557891e927e4bf046acdb8af37bd">getFetchPack</a> (<a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> const &nodeHash)=0</td></tr>
|
|
<tr class="memdesc:a38ff557891e927e4bf046acdb8af37bd"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves partial ledger data of the coresponding hash from peers. <br /></td></tr>
|
|
<tr class="separator:a38ff557891e927e4bf046acdb8af37bd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>An interface facilitating retrieval of fetch packs without an application or ledgermaster object. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="AbstractFetchPackContainer_8h_source.html#l00014">14</a> of file <a class="el" href="AbstractFetchPackContainer_8h_source.html">AbstractFetchPackContainer.h</a>.</p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a2bef43de3153bf61d0308cb077285313" name="a2bef43de3153bf61d0308cb077285313"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2bef43de3153bf61d0308cb077285313">◆ </a></span>~AbstractFetchPackContainer()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual ripple::AbstractFetchPackContainer::~AbstractFetchPackContainer </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="a38ff557891e927e4bf046acdb8af37bd" name="a38ff557891e927e4bf046acdb8af37bd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a38ff557891e927e4bf046acdb8af37bd">◆ </a></span>getFetchPack()</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/utility/optional.html">std::optional</a>< <a class="el" href="namespaceripple.html#ab1f2184bb5938b5508798cd47a561a21">Blob</a> > ripple::AbstractFetchPackContainer::getFetchPack </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> const & </td>
|
|
<td class="paramname"><em>nodeHash</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>Retrieves partial ledger data of the coresponding hash from peers. </p>
|
|
<p>`</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">nodeHash</td><td>The 256-bit hash of the data to fetch. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><code><a class="elRef" href="http://en.cppreference.com/w/cpp/types/is_same.html">std::nullopt</a></code> if the hash isn't cached, otherwise, the hash associated data. </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1LedgerMaster.html#aa65154f38461c13e79695d7d6c7fa4c9">ripple::LedgerMaster</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <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>
|