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

152 lines
16 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: ConsensusTransSetSF.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_a62226f9e3a6c7c5a3be455e2f87ae01.html">xrpld</a></li><li class="navelem"><a class="el" href="dir_c69db3203fa08a9ff994909ba6ee9783.html">app</a></li><li class="navelem"><a class="el" href="dir_7899ad0c658a3b97a951171682eee0fc.html">ledger</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">ConsensusTransSetSF.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_APP_LEDGER_CONSENSUSTRANSSETSF_H_INCLUDED</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define XRPL_APP_LEDGER_CONSENSUSTRANSSETSF_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;xrpld/app/main/Application.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;xrpl/basics/TaggedCache.h&gt;</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include &lt;xrpl/shamap/SHAMapSyncFilter.h&gt;</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</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="namespaceripple.html">ripple</a> {</div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment">// Sync filters allow low-level SHAMapSync code to interact correctly with</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment">// higher-level structures such as caches and transaction stores</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> </div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment">// This class is needed on both add and check functions</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment">// sync filter for transaction sets during consensus building</span></div>
<div class="foldopen" id="foldopen00016" data-start="{" data-end="};">
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"><a class="line" href="classripple_1_1ConsensusTransSetSF.html"> 16</a></span><span class="keyword">class </span><a class="code hl_class" href="classripple_1_1ConsensusTransSetSF.html">ConsensusTransSetSF</a> : <span class="keyword">public</span> <a class="code hl_class" href="classripple_1_1SHAMapSyncFilter.html">SHAMapSyncFilter</a></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span>{</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"><a class="line" href="classripple_1_1ConsensusTransSetSF.html#afa7da1afe727fb1de9c5ccf92fb1117c"> 19</a></span> <span class="keyword">using </span><a class="code hl_class" href="classripple_1_1TaggedCache.html">NodeCache</a> = <a class="code hl_class" href="classripple_1_1TaggedCache.html">TaggedCache&lt;SHAMapHash, Blob&gt;</a>;</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> <a class="code hl_class" href="classripple_1_1ConsensusTransSetSF.html">ConsensusTransSetSF</a>(<a class="code hl_class" href="classripple_1_1Application.html">Application</a>&amp; app, <a class="code hl_class" href="classripple_1_1TaggedCache.html">NodeCache</a>&amp; nodeCache);</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> <span class="comment">// Note that the nodeData is overwritten by this call</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> <span class="keywordtype">void</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> <a class="code hl_function" href="classripple_1_1ConsensusTransSetSF.html#a2b798f085908dd3630ee497e21401018">gotNode</a>(</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> <span class="keywordtype">bool</span> fromFilter,</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> <a class="code hl_class" href="classripple_1_1SHAMapHash.html">SHAMapHash</a> <span class="keyword">const</span>&amp; nodeHash,</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</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="l00029" name="l00029"></a><span class="lineno"> 29</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="l00030" name="l00030"></a><span class="lineno"> 30</span> <a class="code hl_enumeration" href="namespaceripple.html#ae0356b1de00f841c554c830be509dd58">SHAMapNodeType</a> type) <span class="keyword">const override</span>;</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</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="l00033" name="l00033"></a><span class="lineno"> 33</span> <a class="code hl_function" href="classripple_1_1ConsensusTransSetSF.html#a2ff174d8c863ae309b98af42cf52a6c2">getNode</a>(<a class="code hl_class" href="classripple_1_1SHAMapHash.html">SHAMapHash</a> <span class="keyword">const</span>&amp; nodeHash) <span class="keyword">const override</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="keyword">private</span>:</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"><a class="line" href="classripple_1_1ConsensusTransSetSF.html#a4452e5832ea436deb816e9f8752906a4"> 36</a></span> <a class="code hl_class" href="classripple_1_1Application.html">Application</a>&amp; <a class="code hl_variable" href="classripple_1_1ConsensusTransSetSF.html#a4452e5832ea436deb816e9f8752906a4">app_</a>;</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"><a class="line" href="classripple_1_1ConsensusTransSetSF.html#afa9ba058f1afc651ebc2b6711f255316"> 37</a></span> <a class="code hl_class" href="classripple_1_1TaggedCache.html">NodeCache</a>&amp; <a class="code hl_variable" href="classripple_1_1ConsensusTransSetSF.html#afa9ba058f1afc651ebc2b6711f255316">m_nodeCache</a>;</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"><a class="line" href="classripple_1_1ConsensusTransSetSF.html#a51c07f97494100710dfe0b1d469dc5e7"> 38</a></span> <a class="code hl_class" href="classbeast_1_1Journal.html">beast::Journal</a> <span class="keyword">const</span> <a class="code hl_variable" href="classripple_1_1ConsensusTransSetSF.html#a51c07f97494100710dfe0b1d469dc5e7">j_</a>;</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span>};</div>
</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> </div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span>} <span class="comment">// namespace ripple</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> </div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclassbeast_1_1Journal_html"><div class="ttname"><a href="classbeast_1_1Journal.html">beast::Journal</a></div><div class="ttdoc">A generic endpoint for log messages.</div><div class="ttdef"><b>Definition</b> <a href="Journal_8h_source.html#l00040">Journal.h:41</a></div></div>
<div class="ttc" id="aclassripple_1_1Application_html"><div class="ttname"><a href="classripple_1_1Application.html">ripple::Application</a></div><div class="ttdef"><b>Definition</b> <a href="Application_8h_source.html#l00094">Application.h:95</a></div></div>
<div class="ttc" id="aclassripple_1_1ConsensusTransSetSF_html"><div class="ttname"><a href="classripple_1_1ConsensusTransSetSF.html">ripple::ConsensusTransSetSF</a></div><div class="ttdef"><b>Definition</b> <a href="ConsensusTransSetSF_8h_source.html#l00016">ConsensusTransSetSF.h:17</a></div></div>
<div class="ttc" id="aclassripple_1_1ConsensusTransSetSF_html_a2b798f085908dd3630ee497e21401018"><div class="ttname"><a href="classripple_1_1ConsensusTransSetSF.html#a2b798f085908dd3630ee497e21401018">ripple::ConsensusTransSetSF::gotNode</a></div><div class="ttdeci">void gotNode(bool fromFilter, SHAMapHash const &amp;nodeHash, std::uint32_t ledgerSeq, Blob &amp;&amp;nodeData, SHAMapNodeType type) const override</div><div class="ttdef"><b>Definition</b> <a href="ConsensusTransSetSF_8cpp_source.html#l00020">ConsensusTransSetSF.cpp:20</a></div></div>
<div class="ttc" id="aclassripple_1_1ConsensusTransSetSF_html_a2ff174d8c863ae309b98af42cf52a6c2"><div class="ttname"><a href="classripple_1_1ConsensusTransSetSF.html#a2ff174d8c863ae309b98af42cf52a6c2">ripple::ConsensusTransSetSF::getNode</a></div><div class="ttdeci">std::optional&lt; Blob &gt; getNode(SHAMapHash const &amp;nodeHash) const override</div><div class="ttdef"><b>Definition</b> <a href="ConsensusTransSetSF_8cpp_source.html#l00063">ConsensusTransSetSF.cpp:63</a></div></div>
<div class="ttc" id="aclassripple_1_1ConsensusTransSetSF_html_a4452e5832ea436deb816e9f8752906a4"><div class="ttname"><a href="classripple_1_1ConsensusTransSetSF.html#a4452e5832ea436deb816e9f8752906a4">ripple::ConsensusTransSetSF::app_</a></div><div class="ttdeci">Application &amp; app_</div><div class="ttdef"><b>Definition</b> <a href="ConsensusTransSetSF_8h_source.html#l00036">ConsensusTransSetSF.h:36</a></div></div>
<div class="ttc" id="aclassripple_1_1ConsensusTransSetSF_html_a51c07f97494100710dfe0b1d469dc5e7"><div class="ttname"><a href="classripple_1_1ConsensusTransSetSF.html#a51c07f97494100710dfe0b1d469dc5e7">ripple::ConsensusTransSetSF::j_</a></div><div class="ttdeci">beast::Journal const j_</div><div class="ttdef"><b>Definition</b> <a href="ConsensusTransSetSF_8h_source.html#l00038">ConsensusTransSetSF.h:38</a></div></div>
<div class="ttc" id="aclassripple_1_1ConsensusTransSetSF_html_afa9ba058f1afc651ebc2b6711f255316"><div class="ttname"><a href="classripple_1_1ConsensusTransSetSF.html#afa9ba058f1afc651ebc2b6711f255316">ripple::ConsensusTransSetSF::m_nodeCache</a></div><div class="ttdeci">NodeCache &amp; m_nodeCache</div><div class="ttdef"><b>Definition</b> <a href="ConsensusTransSetSF_8h_source.html#l00037">ConsensusTransSetSF.h:37</a></div></div>
<div class="ttc" id="aclassripple_1_1SHAMapHash_html"><div class="ttname"><a href="classripple_1_1SHAMapHash.html">ripple::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="aclassripple_1_1SHAMapSyncFilter_html"><div class="ttname"><a href="classripple_1_1SHAMapSyncFilter.html">ripple::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="aclassripple_1_1TaggedCache_html"><div class="ttname"><a href="classripple_1_1TaggedCache.html">ripple::TaggedCache&lt; SHAMapHash, Blob &gt;</a></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="anamespaceripple_html"><div class="ttname"><a href="namespaceripple.html">ripple</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="anamespaceripple_html_ae0356b1de00f841c554c830be509dd58"><div class="ttname"><a href="namespaceripple.html#ae0356b1de00f841c554c830be509dd58">ripple::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/utility/optional.html">std::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