Files
rippled/classripple_1_1SHAMapSyncFilter.html
2021-03-12 22:34:28 +00:00

303 lines
15 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::SHAMapSyncFilter 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&amp;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&amp;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_1SHAMapSyncFilter.html">SHAMapSyncFilter</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classripple_1_1SHAMapSyncFilter-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ripple::SHAMapSyncFilter Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for ripple::SHAMapSyncFilter:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1SHAMapSyncFilter__inherit__graph.png" border="0" usemap="#ripple_1_1SHAMapSyncFilter_inherit__map" alt="Inheritance graph"/></div>
<map name="ripple_1_1SHAMapSyncFilter_inherit__map" id="ripple_1_1SHAMapSyncFilter_inherit__map">
<area shape="rect" title=" " alt="" coords="5,85,189,112"/>
<area shape="rect" href="classripple_1_1AccountStateSF.html" title=" " alt="" coords="257,5,425,32"/>
<area shape="rect" href="classripple_1_1ConsensusTransSetSF.html" title=" " alt="" coords="237,56,444,83"/>
<area shape="rect" href="structripple_1_1tests_1_1FetchPack__test_1_1TestFilter.html" title=" " alt="" coords="255,107,426,149"/>
<area shape="rect" href="classripple_1_1TransactionStateSF.html" title=" " alt="" coords="245,173,436,200"/>
</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-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a7b90a29145ea826ab4d8f2e467623b9e"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1SHAMapSyncFilter.html#a7b90a29145ea826ab4d8f2e467623b9e">~SHAMapSyncFilter</a> ()=default</td></tr>
<tr class="separator:a7b90a29145ea826ab4d8f2e467623b9e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a21d04df23bfa6803bc1d0d427efd5c17"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1SHAMapSyncFilter.html#a21d04df23bfa6803bc1d0d427efd5c17">SHAMapSyncFilter</a> ()=default</td></tr>
<tr class="separator:a21d04df23bfa6803bc1d0d427efd5c17"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af364008075f3ad8287e5cbe138b5e4d6"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1SHAMapSyncFilter.html#af364008075f3ad8287e5cbe138b5e4d6">SHAMapSyncFilter</a> (<a class="el" href="classripple_1_1SHAMapSyncFilter.html">SHAMapSyncFilter</a> const &amp;)=delete</td></tr>
<tr class="separator:af364008075f3ad8287e5cbe138b5e4d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a772cb041257b294a6d9641fc1aab0f03"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1SHAMapSyncFilter.html">SHAMapSyncFilter</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1SHAMapSyncFilter.html#a772cb041257b294a6d9641fc1aab0f03">operator=</a> (<a class="el" href="classripple_1_1SHAMapSyncFilter.html">SHAMapSyncFilter</a> const &amp;)=delete</td></tr>
<tr class="separator:a772cb041257b294a6d9641fc1aab0f03"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a52d6a1cab3037707977a764d146d939f"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1SHAMapSyncFilter.html#a52d6a1cab3037707977a764d146d939f">gotNode</a> (bool fromFilter, <a class="el" href="classripple_1_1SHAMapHash.html">SHAMapHash</a> const &amp;nodeHash, <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> ledgerSeq, <a class="el" href="namespaceripple.html#ab1f2184bb5938b5508798cd47a561a21">Blob</a> &amp;&amp;nodeData, <a class="el" href="namespaceripple.html#ae0356b1de00f841c554c830be509dd58">SHAMapNodeType</a> type) const =0</td></tr>
<tr class="separator:a52d6a1cab3037707977a764d146d939f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aab30f4bd0cd629af0cb5a7f53afb7fb4"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>&lt; <a class="el" href="namespaceripple.html#ab1f2184bb5938b5508798cd47a561a21">Blob</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1SHAMapSyncFilter.html#aab30f4bd0cd629af0cb5a7f53afb7fb4">getNode</a> (<a class="el" href="classripple_1_1SHAMapHash.html">SHAMapHash</a> const &amp;nodeHash) const =0</td></tr>
<tr class="separator:aab30f4bd0cd629af0cb5a7f53afb7fb4"><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 class="definition">Definition at line <a class="el" href="SHAMapSyncFilter_8h_source.html#l00030">30</a> of file <a class="el" href="SHAMapSyncFilter_8h_source.html">SHAMapSyncFilter.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a7b90a29145ea826ab4d8f2e467623b9e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7b90a29145ea826ab4d8f2e467623b9e">&#9670;&nbsp;</a></span>~SHAMapSyncFilter()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual ripple::SHAMapSyncFilter::~SHAMapSyncFilter </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>
<a id="a21d04df23bfa6803bc1d0d427efd5c17"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a21d04df23bfa6803bc1d0d427efd5c17">&#9670;&nbsp;</a></span>SHAMapSyncFilter() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ripple::SHAMapSyncFilter::SHAMapSyncFilter </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="af364008075f3ad8287e5cbe138b5e4d6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af364008075f3ad8287e5cbe138b5e4d6">&#9670;&nbsp;</a></span>SHAMapSyncFilter() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ripple::SHAMapSyncFilter::SHAMapSyncFilter </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1SHAMapSyncFilter.html">SHAMapSyncFilter</a> const &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a772cb041257b294a6d9641fc1aab0f03"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a772cb041257b294a6d9641fc1aab0f03">&#9670;&nbsp;</a></span>operator=()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1SHAMapSyncFilter.html">SHAMapSyncFilter</a>&amp; ripple::SHAMapSyncFilter::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1SHAMapSyncFilter.html">SHAMapSyncFilter</a> const &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a52d6a1cab3037707977a764d146d939f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a52d6a1cab3037707977a764d146d939f">&#9670;&nbsp;</a></span>gotNode()</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::SHAMapSyncFilter::gotNode </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>fromFilter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classripple_1_1SHAMapHash.html">SHAMapHash</a> const &amp;&#160;</td>
<td class="paramname"><em>nodeHash</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>ledgerSeq</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceripple.html#ab1f2184bb5938b5508798cd47a561a21">Blob</a> &amp;&amp;&#160;</td>
<td class="paramname"><em>nodeData</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceripple.html#ae0356b1de00f841c554c830be509dd58">SHAMapNodeType</a>&#160;</td>
<td class="paramname"><em>type</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="structripple_1_1tests_1_1FetchPack__test_1_1TestFilter.html#aa6a241d7643364a55da15bc015fa1d24">ripple::tests::FetchPack_test::TestFilter</a>, <a class="el" href="classripple_1_1ConsensusTransSetSF.html#a2b798f085908dd3630ee497e21401018">ripple::ConsensusTransSetSF</a>, <a class="el" href="classripple_1_1AccountStateSF.html#a65c0d95f27ac37c25f70915e3704ff71">ripple::AccountStateSF</a>, and <a class="el" href="classripple_1_1TransactionStateSF.html#a2f879e777a9a6adfd8b680ff3048d0eb">ripple::TransactionStateSF</a>.</p>
</div>
</div>
<a id="aab30f4bd0cd629af0cb5a7f53afb7fb4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aab30f4bd0cd629af0cb5a7f53afb7fb4">&#9670;&nbsp;</a></span>getNode()</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>&lt;<a class="el" href="namespaceripple.html#ab1f2184bb5938b5508798cd47a561a21">Blob</a>&gt; ripple::SHAMapSyncFilter::getNode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1SHAMapHash.html">SHAMapHash</a> const &amp;&#160;</td>
<td class="paramname"><em>nodeHash</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="structripple_1_1tests_1_1FetchPack__test_1_1TestFilter.html#a1689d506385e83eac57724296aee5ac7">ripple::tests::FetchPack_test::TestFilter</a>, <a class="el" href="classripple_1_1ConsensusTransSetSF.html#a2ff174d8c863ae309b98af42cf52a6c2">ripple::ConsensusTransSetSF</a>, <a class="el" href="classripple_1_1AccountStateSF.html#a1d7287ca2601f5afbb881b6ed1d1e5fb">ripple::AccountStateSF</a>, and <a class="el" href="classripple_1_1TransactionStateSF.html#ac1820e2e81c8a10726d1d3b6e85632bf">ripple::TransactionStateSF</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>