ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2026-02-03 13:35:25 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
b9ef07fc10ff9ab5d7eebb9ef057e335fa5786a7
rippled/SHAMapSyncFilter_8h_source.html
bthomee a661b19a31 deploy: 1eb0fdac65
2025-12-11 08:55:10 -08:00

140 lines
14 KiB
HTML
Raw 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: SHAMapSyncFilter.h Source File</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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<!-- 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="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_0103a8ad82dcc2c51f5cde661b4b5cb7.html">xrpl</a></li><li class="navelem"><a class="el" href="dir_292da32077129148230df7f03daa34af.html">shamap</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">SHAMapSyncFilter.h</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#ifndef XRPL_SHAMAP_SHAMAPSYNCFILTER_H_INCLUDED</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define XRPL_SHAMAP_SHAMAPSYNCFILTER_H_INCLUDED</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include &lt;xrpl/shamap/SHAMapTreeNode.h&gt;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span> </div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/optional.html">optional</a>&gt;</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> </div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacexrpl.html">xrpl</a> {</div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
<div class="foldopen" id="foldopen00011" data-start="{" data-end="};">
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"><a class="line" href="classxrpl_1_1SHAMapSyncFilter.html"> 11</a></span><span class="keyword">class </span><a class="code hl_class" href="classxrpl_1_1SHAMapSyncFilter.html">SHAMapSyncFilter</a></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span>{</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"><a class="line" href="classxrpl_1_1SHAMapSyncFilter.html#af7858ccab3e6aaf27ac04c3c9bfd0f4b"> 14</a></span> <span class="keyword">virtual</span> <a class="code hl_function" href="classxrpl_1_1SHAMapSyncFilter.html#af7858ccab3e6aaf27ac04c3c9bfd0f4b">~SHAMapSyncFilter</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"><a class="line" href="classxrpl_1_1SHAMapSyncFilter.html#a9eaf5fec7be2af1f94ac72defe7dedc6"> 15</a></span> <a class="code hl_function" href="classxrpl_1_1SHAMapSyncFilter.html#a9eaf5fec7be2af1f94ac72defe7dedc6">SHAMapSyncFilter</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"><a class="line" href="classxrpl_1_1SHAMapSyncFilter.html#aff0622486ea3e2cdc9c5ef76936bddae"> 16</a></span> <a class="code hl_function" href="classxrpl_1_1SHAMapSyncFilter.html#aff0622486ea3e2cdc9c5ef76936bddae">SHAMapSyncFilter</a>(<a class="code hl_class" href="classxrpl_1_1SHAMapSyncFilter.html">SHAMapSyncFilter</a> <span class="keyword">const</span>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> <a class="code hl_class" href="classxrpl_1_1SHAMapSyncFilter.html">SHAMapSyncFilter</a>&amp;</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"><a class="line" href="classxrpl_1_1SHAMapSyncFilter.html#a7386fb051f030d7f2186b63bc36a7b7d"> 18</a></span> <a class="code hl_function" href="classxrpl_1_1SHAMapSyncFilter.html#a7386fb051f030d7f2186b63bc36a7b7d">operator=</a>(<a class="code hl_class" href="classxrpl_1_1SHAMapSyncFilter.html">SHAMapSyncFilter</a> <span class="keyword">const</span>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> <span class="comment">// Note that the nodeData is overwritten by this call</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"><a class="line" href="classxrpl_1_1SHAMapSyncFilter.html#ab18df4c6bafa4ab1299a37adf0c28bc0"> 22</a></span> <a class="code hl_function" href="classxrpl_1_1SHAMapSyncFilter.html#ab18df4c6bafa4ab1299a37adf0c28bc0">gotNode</a>(</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> <span class="keywordtype">bool</span> fromFilter,</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> <a class="code hl_class" href="classxrpl_1_1SHAMapHash.html">SHAMapHash</a> <span class="keyword">const</span>&amp; nodeHash,</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> ledgerSeq,</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/container/vector.html">Blob</a>&amp;&amp; nodeData,</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> <a class="code hl_enumeration" href="namespacexrpl.html#a13201019bfaccabd85a221c9207a5255">SHAMapNodeType</a> type) <span class="keyword">const</span> = 0;</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> </div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">virtual</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional&lt;Blob&gt;</a></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"><a class="line" href="classxrpl_1_1SHAMapSyncFilter.html#a5998a2ac819c58d30b15a448d662ae20"> 30</a></span> <a class="code hl_function" href="classxrpl_1_1SHAMapSyncFilter.html#a5998a2ac819c58d30b15a448d662ae20">getNode</a>(<a class="code hl_class" href="classxrpl_1_1SHAMapHash.html">SHAMapHash</a> <span class="keyword">const</span>&amp; nodeHash) <span class="keyword">const</span> = 0;</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span>};</div>
</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span>} <span class="comment">// namespace xrpl</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> </div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclassxrpl_1_1SHAMapHash_html"><div class="ttname"><a href="classxrpl_1_1SHAMapHash.html">xrpl::SHAMapHash</a></div><div class="ttdef"><b>Definition</b> <a href="SHAMapHash_8h_source.html#l00014">SHAMapHash.h:15</a></div></div>
<div class="ttc" id="aclassxrpl_1_1SHAMapSyncFilter_html"><div class="ttname"><a href="classxrpl_1_1SHAMapSyncFilter.html">xrpl::SHAMapSyncFilter</a></div><div class="ttdef"><b>Definition</b> <a href="SHAMapSyncFilter_8h_source.html#l00011">SHAMapSyncFilter.h:12</a></div></div>
<div class="ttc" id="aclassxrpl_1_1SHAMapSyncFilter_html_a5998a2ac819c58d30b15a448d662ae20"><div class="ttname"><a href="classxrpl_1_1SHAMapSyncFilter.html#a5998a2ac819c58d30b15a448d662ae20">xrpl::SHAMapSyncFilter::getNode</a></div><div class="ttdeci">virtual std::optional&lt; Blob &gt; getNode(SHAMapHash const &amp;nodeHash) const =0</div></div>
<div class="ttc" id="aclassxrpl_1_1SHAMapSyncFilter_html_a7386fb051f030d7f2186b63bc36a7b7d"><div class="ttname"><a href="classxrpl_1_1SHAMapSyncFilter.html#a7386fb051f030d7f2186b63bc36a7b7d">xrpl::SHAMapSyncFilter::operator=</a></div><div class="ttdeci">SHAMapSyncFilter &amp; operator=(SHAMapSyncFilter const &amp;)=delete</div></div>
<div class="ttc" id="aclassxrpl_1_1SHAMapSyncFilter_html_a9eaf5fec7be2af1f94ac72defe7dedc6"><div class="ttname"><a href="classxrpl_1_1SHAMapSyncFilter.html#a9eaf5fec7be2af1f94ac72defe7dedc6">xrpl::SHAMapSyncFilter::SHAMapSyncFilter</a></div><div class="ttdeci">SHAMapSyncFilter()=default</div></div>
<div class="ttc" id="aclassxrpl_1_1SHAMapSyncFilter_html_ab18df4c6bafa4ab1299a37adf0c28bc0"><div class="ttname"><a href="classxrpl_1_1SHAMapSyncFilter.html#ab18df4c6bafa4ab1299a37adf0c28bc0">xrpl::SHAMapSyncFilter::gotNode</a></div><div class="ttdeci">virtual void gotNode(bool fromFilter, SHAMapHash const &amp;nodeHash, std::uint32_t ledgerSeq, Blob &amp;&amp;nodeData, SHAMapNodeType type) const =0</div></div>
<div class="ttc" id="aclassxrpl_1_1SHAMapSyncFilter_html_af7858ccab3e6aaf27ac04c3c9bfd0f4b"><div class="ttname"><a href="classxrpl_1_1SHAMapSyncFilter.html#af7858ccab3e6aaf27ac04c3c9bfd0f4b">xrpl::SHAMapSyncFilter::~SHAMapSyncFilter</a></div><div class="ttdeci">virtual ~SHAMapSyncFilter()=default</div></div>
<div class="ttc" id="aclassxrpl_1_1SHAMapSyncFilter_html_aff0622486ea3e2cdc9c5ef76936bddae"><div class="ttname"><a href="classxrpl_1_1SHAMapSyncFilter.html#aff0622486ea3e2cdc9c5ef76936bddae">xrpl::SHAMapSyncFilter::SHAMapSyncFilter</a></div><div class="ttdeci">SHAMapSyncFilter(SHAMapSyncFilter const &amp;)=delete</div></div>
<div class="ttc" id="ainteger_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a></div></div>
<div class="ttc" id="anamespacexrpl_html"><div class="ttname"><a href="namespacexrpl.html">xrpl</a></div><div class="ttdoc">Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.</div><div class="ttdef"><b>Definition</b> <a href="algorithm_8h_source.html#l00006">algorithm.h:6</a></div></div>
<div class="ttc" id="anamespacexrpl_html_a13201019bfaccabd85a221c9207a5255"><div class="ttname"><a href="namespacexrpl.html#a13201019bfaccabd85a221c9207a5255">xrpl::SHAMapNodeType</a></div><div class="ttdeci">SHAMapNodeType</div><div class="ttdef"><b>Definition</b> <a href="SHAMapTreeNode_8h_source.html#l00024">SHAMapTreeNode.h:24</a></div></div>
<div class="ttc" id="aoptional_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/optional.html">optional</a></div></div>
<div class="ttc" id="avector_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector&lt; unsigned char &gt;</a></div></div>
</div><!-- fragment --></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