mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-21 11:35:53 +00:00
158 lines
19 KiB
HTML
158 lines
19 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: 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 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="dir_df9c78dcf3f59a33b12284f95992a64b.html">ripple</a></li><li class="navelem"><a class="el" href="dir_9f69212e4c6e2ca9ec5ab59cd7b6275c.html">app</a></li><li class="navelem"><a class="el" href="dir_796f40347441ba166e244d2eadcd4ae1.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 name="l00001"></a><span class="lineno"> 1</span> <span class="comment">//------------------------------------------------------------------------------</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> This file is part of rippled: https://github.com/ripple/rippled</span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> Copyright (c) 2012, 2013 Ripple Labs Inc.</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> Permission to use, copy, modify, and/or distribute this software for any</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> purpose with or without fee is hereby granted, provided that the above</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> copyright notice and this permission notice appear in all copies.</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF</span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES</span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF</span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">//==============================================================================</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  </div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#ifndef RIPPLE_APP_LEDGER_CONSENSUSTRANSSETSF_H_INCLUDED</span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define RIPPLE_APP_LEDGER_CONSENSUSTRANSSETSF_H_INCLUDED</span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  </div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <ripple/app/main/Application.h></span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <ripple/basics/TaggedCache.h></span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <ripple/shamap/SHAMapSyncFilter.h></span></div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  </div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">namespace </span><a class="code" href="namespaceripple.html">ripple</a> {</div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  </div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment">// Sync filters allow low-level SHAMapSync code to interact correctly with</span></div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment">// higher-level structures such as caches and transaction stores</span></div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  </div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment">// This class is needed on both add and check functions</span></div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment">// sync filter for transaction sets during consensus building</span></div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="classripple_1_1ConsensusTransSetSF.html"> 34</a></span> <span class="keyword">class </span><a class="code" href="classripple_1_1ConsensusTransSetSF.html">ConsensusTransSetSF</a> : <span class="keyword">public</span> <a class="code" href="classripple_1_1SHAMapSyncFilter.html">SHAMapSyncFilter</a></div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> {</div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="classripple_1_1ConsensusTransSetSF.html#afa7da1afe727fb1de9c5ccf92fb1117c"> 37</a></span>  <span class="keyword">using</span> <a class="code" href="classripple_1_1TaggedCache.html">NodeCache</a> = <a class="code" href="classripple_1_1TaggedCache.html">TaggedCache<SHAMapHash, Blob></a>;</div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  </div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <a class="code" href="classripple_1_1ConsensusTransSetSF.html#a92257a72ef2a13a88e6d9ff0b1e5d8b1">ConsensusTransSetSF</a>(<a class="code" href="classripple_1_1Application.html">Application</a>& app, <a class="code" href="classripple_1_1TaggedCache.html">NodeCache</a>& nodeCache);</div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  </div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="comment">// Note that the nodeData is overwritten by this call</span></div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keywordtype">void</span></div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <a class="code" href="classripple_1_1ConsensusTransSetSF.html#a5adada4d5978317086a821a3d2e60832">gotNode</a>(</div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keywordtype">bool</span> fromFilter,</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <a class="code" href="classripple_1_1SHAMapHash.html">SHAMapHash</a> <span class="keyword">const</span>& nodeHash,</div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> ledgerSeq,</div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/container/vector.html">Blob</a>&& nodeData,</div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <a class="code" href="classripple_1_1SHAMapAbstractNode.html#a6cdeae87f96a46b976f2e70e985d4b0f">SHAMapTreeNode::TNType</a> type) <span class="keyword">const override</span>;</div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  </div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  boost::optional<Blob></div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <a class="code" href="classripple_1_1ConsensusTransSetSF.html#a312ca1779784b81d78feda410a1a3fee">getNode</a>(<a class="code" href="classripple_1_1SHAMapHash.html">SHAMapHash</a> <span class="keyword">const</span>& nodeHash) <span class="keyword">const override</span>;</div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  </div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="classripple_1_1ConsensusTransSetSF.html#a4452e5832ea436deb816e9f8752906a4"> 54</a></span>  <a class="code" href="classripple_1_1Application.html">Application</a>& <a class="code" href="classripple_1_1ConsensusTransSetSF.html#a4452e5832ea436deb816e9f8752906a4">app_</a>;</div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="classripple_1_1ConsensusTransSetSF.html#afa9ba058f1afc651ebc2b6711f255316"> 55</a></span>  <a class="code" href="classripple_1_1TaggedCache.html">NodeCache</a>& <a class="code" href="classripple_1_1ConsensusTransSetSF.html#afa9ba058f1afc651ebc2b6711f255316">m_nodeCache</a>;</div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="classripple_1_1ConsensusTransSetSF.html#a80c5bb356fb7c15666aaeec5f9196fcc"> 56</a></span>  <a class="code" href="classbeast_1_1Journal.html">beast::Journal</a> <span class="keyword">const</span> <a class="code" href="classripple_1_1ConsensusTransSetSF.html#a80c5bb356fb7c15666aaeec5f9196fcc">j_</a>;</div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> };</div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  </div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> } <span class="comment">// namespace ripple</span></div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  </div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="preprocessor">#endif</span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<div class="ttc" id="aclassripple_1_1ConsensusTransSetSF_html_a5adada4d5978317086a821a3d2e60832"><div class="ttname"><a href="classripple_1_1ConsensusTransSetSF.html#a5adada4d5978317086a821a3d2e60832">ripple::ConsensusTransSetSF::gotNode</a></div><div class="ttdeci">void gotNode(bool fromFilter, SHAMapHash const &nodeHash, std::uint32_t ledgerSeq, Blob &&nodeData, SHAMapTreeNode::TNType type) const override</div><div class="ttdef"><b>Definition:</b> <a href="ConsensusTransSetSF_8cpp_source.html#l00039">ConsensusTransSetSF.cpp:39</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:94</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1TaggedCache_html"><div class="ttname"><a href="classripple_1_1TaggedCache.html">ripple::TaggedCache< SHAMapHash, Blob ></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< unsigned char ></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 & m_nodeCache</div><div class="ttdef"><b>Definition:</b> <a href="ConsensusTransSetSF_8h_source.html#l00055">ConsensusTransSetSF.h:55</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1ConsensusTransSetSF_html_a312ca1779784b81d78feda410a1a3fee"><div class="ttname"><a href="classripple_1_1ConsensusTransSetSF.html#a312ca1779784b81d78feda410a1a3fee">ripple::ConsensusTransSetSF::getNode</a></div><div class="ttdeci">boost::optional< Blob > getNode(SHAMapHash const &nodeHash) const override</div><div class="ttdef"><b>Definition:</b> <a href="ConsensusTransSetSF_8cpp_source.html#l00078">ConsensusTransSetSF.cpp:78</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="SHAMapTreeNode_8h_source.html#l00043">SHAMapTreeNode.h:43</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#l00034">ConsensusTransSetSF.h:34</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 & app_</div><div class="ttdef"><b>Definition:</b> <a href="ConsensusTransSetSF_8h_source.html#l00054">ConsensusTransSetSF.h:54</a></div></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#l00058">Journal.h:58</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="aclassripple_1_1SHAMapAbstractNode_html_a6cdeae87f96a46b976f2e70e985d4b0f"><div class="ttname"><a href="classripple_1_1SHAMapAbstractNode.html#a6cdeae87f96a46b976f2e70e985d4b0f">ripple::SHAMapAbstractNode::TNType</a></div><div class="ttdeci">TNType</div><div class="ttdef"><b>Definition:</b> <a href="SHAMapTreeNode_8h_source.html#l00125">SHAMapTreeNode.h:125</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="RCLCensorshipDetector_8h_source.html#l00029">RCLCensorshipDetector.h:29</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#l00030">SHAMapSyncFilter.h:30</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1ConsensusTransSetSF_html_a92257a72ef2a13a88e6d9ff0b1e5d8b1"><div class="ttname"><a href="classripple_1_1ConsensusTransSetSF.html#a92257a72ef2a13a88e6d9ff0b1e5d8b1">ripple::ConsensusTransSetSF::ConsensusTransSetSF</a></div><div class="ttdeci">ConsensusTransSetSF(Application &app, NodeCache &nodeCache)</div><div class="ttdef"><b>Definition:</b> <a href="ConsensusTransSetSF_8cpp_source.html#l00033">ConsensusTransSetSF.cpp:33</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1ConsensusTransSetSF_html_a80c5bb356fb7c15666aaeec5f9196fcc"><div class="ttname"><a href="classripple_1_1ConsensusTransSetSF.html#a80c5bb356fb7c15666aaeec5f9196fcc">ripple::ConsensusTransSetSF::j_</a></div><div class="ttdeci">const beast::Journal j_</div><div class="ttdef"><b>Definition:</b> <a href="ConsensusTransSetSF_8h_source.html#l00056">ConsensusTransSetSF.h:56</a></div></div>
|
|
<!-- 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>
|