forked from XRPLF/rippled
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathAccountStateSF_8h_source.html
152 lines (150 loc) · 17.8 KB
/
AccountStateSF_8h_source.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
<!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: AccountStateSF.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">AccountStateSF.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_ACCOUNTSTATESF_H_INCLUDED</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define RIPPLE_APP_LEDGER_ACCOUNTSTATESF_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/ledger/AbstractFetchPackContainer.h></span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <ripple/nodestore/Database.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">// This class is only needed on add functions</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment">// sync filter for account state nodes during ledger sync</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="classripple_1_1AccountStateSF.html"> 31</a></span> <span class="keyword">class </span><a class="code" href="classripple_1_1AccountStateSF.html">AccountStateSF</a> : <span class="keyword">public</span> <a class="code" href="classripple_1_1SHAMapSyncFilter.html">SHAMapSyncFilter</a></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> {</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="classripple_1_1AccountStateSF.html#a1390ee25ddfc2103e72bde80f8274bbf"> 34</a></span>  <a class="code" href="classripple_1_1AccountStateSF.html#a1390ee25ddfc2103e72bde80f8274bbf">AccountStateSF</a>(<a class="code" href="classripple_1_1NodeStore_1_1Database.html">NodeStore::Database</a>& db, <a class="code" href="classripple_1_1AbstractFetchPackContainer.html">AbstractFetchPackContainer</a>& fp)</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  : <a class="code" href="classripple_1_1AccountStateSF.html#a618515a74a2be0ac02fc5833cf0202a0">db_</a>(db), <a class="code" href="classripple_1_1AccountStateSF.html#add03ea06017b0e9ff263ee9e4e26a1ab">fp_</a>(fp)</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  {</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  }</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>  <span class="keywordtype">void</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <a class="code" href="classripple_1_1AccountStateSF.html#a65c0d95f27ac37c25f70915e3704ff71">gotNode</a>(</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keywordtype">bool</span> fromFilter,</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <a class="code" href="classripple_1_1SHAMapHash.html">SHAMapHash</a> <span class="keyword">const</span>& nodeHash,</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</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="l00044"></a><span class="lineno"> 44</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/container/vector.html">Blob</a>&& nodeData,</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <a class="code" href="namespaceripple.html#ae0356b1de00f841c554c830be509dd58">SHAMapNodeType</a> type) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  </div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional<Blob></a></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <a class="code" href="classripple_1_1AccountStateSF.html#a1d7287ca2601f5afbb881b6ed1d1e5fb">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="l00049"></a><span class="lineno"> 49</span>  </div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="keyword">private</span>:</div>
<div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="classripple_1_1AccountStateSF.html#a618515a74a2be0ac02fc5833cf0202a0"> 51</a></span>  <a class="code" href="classripple_1_1NodeStore_1_1Database.html">NodeStore::Database</a>& <a class="code" href="classripple_1_1AccountStateSF.html#a618515a74a2be0ac02fc5833cf0202a0">db_</a>;</div>
<div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="classripple_1_1AccountStateSF.html#add03ea06017b0e9ff263ee9e4e26a1ab"> 52</a></span>  <a class="code" href="classripple_1_1AbstractFetchPackContainer.html">AbstractFetchPackContainer</a>& <a class="code" href="classripple_1_1AccountStateSF.html#add03ea06017b0e9ff263ee9e4e26a1ab">fp_</a>;</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> };</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  </div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> } <span class="comment">// namespace ripple</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  </div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="aclassripple_1_1NodeStore_1_1Database_html"><div class="ttname"><a href="classripple_1_1NodeStore_1_1Database.html">ripple::NodeStore::Database</a></div><div class="ttdoc">Persistency layer for NodeObject.</div><div class="ttdef"><b>Definition:</b> <a href="Database_8h_source.html#l00052">Database.h:52</a></div></div>
<div class="ttc" id="aclassripple_1_1AccountStateSF_html_a1390ee25ddfc2103e72bde80f8274bbf"><div class="ttname"><a href="classripple_1_1AccountStateSF.html#a1390ee25ddfc2103e72bde80f8274bbf">ripple::AccountStateSF::AccountStateSF</a></div><div class="ttdeci">AccountStateSF(NodeStore::Database &db, AbstractFetchPackContainer &fp)</div><div class="ttdef"><b>Definition:</b> <a href="AccountStateSF_8h_source.html#l00034">AccountStateSF.h:34</a></div></div>
<div class="ttc" id="aclassripple_1_1AccountStateSF_html_a1d7287ca2601f5afbb881b6ed1d1e5fb"><div class="ttname"><a href="classripple_1_1AccountStateSF.html#a1d7287ca2601f5afbb881b6ed1d1e5fb">ripple::AccountStateSF::getNode</a></div><div class="ttdeci">std::optional< Blob > getNode(SHAMapHash const &nodeHash) const override</div><div class="ttdef"><b>Definition:</b> <a href="AccountStateSF_8cpp_source.html#l00037">AccountStateSF.cpp:37</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="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#l00127">SHAMapTreeNode.h:127</a></div></div>
<div class="ttc" id="aclassripple_1_1AccountStateSF_html_add03ea06017b0e9ff263ee9e4e26a1ab"><div class="ttname"><a href="classripple_1_1AccountStateSF.html#add03ea06017b0e9ff263ee9e4e26a1ab">ripple::AccountStateSF::fp_</a></div><div class="ttdeci">AbstractFetchPackContainer & fp_</div><div class="ttdef"><b>Definition:</b> <a href="AccountStateSF_8h_source.html#l00052">AccountStateSF.h:52</a></div></div>
<div class="ttc" id="aclassripple_1_1AccountStateSF_html"><div class="ttname"><a href="classripple_1_1AccountStateSF.html">ripple::AccountStateSF</a></div><div class="ttdef"><b>Definition:</b> <a href="AccountStateSF_8h_source.html#l00031">AccountStateSF.h:31</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#l00048">SHAMapTreeNode.h:48</a></div></div>
<div class="ttc" id="aclassripple_1_1AbstractFetchPackContainer_html"><div class="ttname"><a href="classripple_1_1AbstractFetchPackContainer.html">ripple::AbstractFetchPackContainer</a></div><div class="ttdoc">An interface facilitating retrieval of fetch packs without an application or ledgermaster object.</div><div class="ttdef"><b>Definition:</b> <a href="AbstractFetchPackContainer_8h_source.html#l00032">AbstractFetchPackContainer.h:32</a></div></div>
<div class="ttc" id="aclassripple_1_1AccountStateSF_html_a65c0d95f27ac37c25f70915e3704ff71"><div class="ttname"><a href="classripple_1_1AccountStateSF.html#a65c0d95f27ac37c25f70915e3704ff71">ripple::AccountStateSF::gotNode</a></div><div class="ttdeci">void gotNode(bool fromFilter, SHAMapHash const &nodeHash, std::uint32_t ledgerSeq, Blob &&nodeData, SHAMapNodeType type) const override</div><div class="ttdef"><b>Definition:</b> <a href="AccountStateSF_8cpp_source.html#l00025">AccountStateSF.cpp:25</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_1AccountStateSF_html_a618515a74a2be0ac02fc5833cf0202a0"><div class="ttname"><a href="classripple_1_1AccountStateSF.html#a618515a74a2be0ac02fc5833cf0202a0">ripple::AccountStateSF::db_</a></div><div class="ttdeci">NodeStore::Database & db_</div><div class="ttdef"><b>Definition:</b> <a href="AccountStateSF_8h_source.html#l00051">AccountStateSF.h:51</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="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="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>
<!-- 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>