forked from XRPLF/rippled
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathBackend_8h_source.html
236 lines (234 loc) · 37.4 KB
/
Backend_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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
<!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: Backend.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_ceb6d1bc218d15504336f945ff1322da.html">nodestore</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">Backend.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_NODESTORE_BACKEND_H_INCLUDED</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define RIPPLE_NODESTORE_BACKEND_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/nodestore/Types.h></span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/atomic.html">atomic</a>></span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/cstdint.html">cstdint</a>></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> <span class="keyword">namespace </span>NodeStore {</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  </div>
<div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="classripple_1_1NodeStore_1_1Backend.html"> 39</a></span> <span class="keyword">class </span><a class="code" href="classripple_1_1NodeStore_1_1Backend.html">Backend</a></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="keyword">public</span>:</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keyword">template</span> <<span class="keyword">typename</span> T></div>
<div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="structripple_1_1NodeStore_1_1Backend_1_1Counters.html"> 43</a></span>  <span class="keyword">struct </span><a class="code" href="structripple_1_1NodeStore_1_1Backend_1_1Counters.html">Counters</a></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  {</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <a class="code" href="structripple_1_1NodeStore_1_1Backend_1_1Counters.html#a39b84060d6f028afdb1b742436cbbcdd">Counters</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <a class="code" href="structripple_1_1NodeStore_1_1Backend_1_1Counters.html#a39b84060d6f028afdb1b742436cbbcdd">Counters</a>(<a class="code" href="structripple_1_1NodeStore_1_1Backend_1_1Counters.html">Counters</a> <span class="keyword">const</span>&) = <span class="keywordflow">default</span>;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  </div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keyword">template</span> <<span class="keyword">typename</span> U></div>
<div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="structripple_1_1NodeStore_1_1Backend_1_1Counters.html#a4d9e96c8ce2f414933f1dc7a5963c9ca"> 49</a></span>  <a class="code" href="structripple_1_1NodeStore_1_1Backend_1_1Counters.html#a4d9e96c8ce2f414933f1dc7a5963c9ca">Counters</a>(<a class="code" href="structripple_1_1NodeStore_1_1Backend_1_1Counters.html">Counters<U></a> <span class="keyword">const</span>& other)</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  : <a class="code" href="structripple_1_1NodeStore_1_1Backend_1_1Counters.html#a1d1f54135ed181b67fda19d6cb2309bf">writeDurationUs</a>(other.<a class="code" href="structripple_1_1NodeStore_1_1Backend_1_1Counters.html#a1d1f54135ed181b67fda19d6cb2309bf">writeDurationUs</a>)</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  , <a class="code" href="structripple_1_1NodeStore_1_1Backend_1_1Counters.html#ac079f0914294773b686e059f80e0690e">writeRetries</a>(other.<a class="code" href="structripple_1_1NodeStore_1_1Backend_1_1Counters.html#ac079f0914294773b686e059f80e0690e">writeRetries</a>)</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  , <a class="code" href="structripple_1_1NodeStore_1_1Backend_1_1Counters.html#a99ac1f0201c18f8789be466de3107d1e">writesDelayed</a>(other.<a class="code" href="structripple_1_1NodeStore_1_1Backend_1_1Counters.html#a99ac1f0201c18f8789be466de3107d1e">writesDelayed</a>)</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  , <a class="code" href="structripple_1_1NodeStore_1_1Backend_1_1Counters.html#a01d74b4c124a43c3aa2bdac5d5d77481">readRetries</a>(other.<a class="code" href="structripple_1_1NodeStore_1_1Backend_1_1Counters.html#a01d74b4c124a43c3aa2bdac5d5d77481">readRetries</a>)</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  , <a class="code" href="structripple_1_1NodeStore_1_1Backend_1_1Counters.html#ab702bb6ba8602c6516b801fa348953cd">readErrors</a>(other.<a class="code" href="structripple_1_1NodeStore_1_1Backend_1_1Counters.html#ab702bb6ba8602c6516b801fa348953cd">readErrors</a>)</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</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>  </div>
<div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="structripple_1_1NodeStore_1_1Backend_1_1Counters.html#a1d1f54135ed181b67fda19d6cb2309bf"> 58</a></span>  T <a class="code" href="structripple_1_1NodeStore_1_1Backend_1_1Counters.html#a1d1f54135ed181b67fda19d6cb2309bf">writeDurationUs</a> = {};</div>
<div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="structripple_1_1NodeStore_1_1Backend_1_1Counters.html#ac079f0914294773b686e059f80e0690e"> 59</a></span>  T <a class="code" href="structripple_1_1NodeStore_1_1Backend_1_1Counters.html#ac079f0914294773b686e059f80e0690e">writeRetries</a> = {};</div>
<div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="structripple_1_1NodeStore_1_1Backend_1_1Counters.html#a99ac1f0201c18f8789be466de3107d1e"> 60</a></span>  T <a class="code" href="structripple_1_1NodeStore_1_1Backend_1_1Counters.html#a99ac1f0201c18f8789be466de3107d1e">writesDelayed</a> = {};</div>
<div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="structripple_1_1NodeStore_1_1Backend_1_1Counters.html#a01d74b4c124a43c3aa2bdac5d5d77481"> 61</a></span>  T <a class="code" href="structripple_1_1NodeStore_1_1Backend_1_1Counters.html#a01d74b4c124a43c3aa2bdac5d5d77481">readRetries</a> = {};</div>
<div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="structripple_1_1NodeStore_1_1Backend_1_1Counters.html#ab702bb6ba8602c6516b801fa348953cd"> 62</a></span>  T <a class="code" href="structripple_1_1NodeStore_1_1Backend_1_1Counters.html#ab702bb6ba8602c6516b801fa348953cd">readErrors</a> = {};</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  };</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  </div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keyword">virtual</span> <a class="code" href="classripple_1_1NodeStore_1_1Backend.html#a7be1490e873f0a4956e4dd9effc9061b">~Backend</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  </div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keyword">virtual</span> <a class="codeRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <a class="code" href="classripple_1_1NodeStore_1_1Backend.html#a206d540c4b8359c598f2309c5ee194bd">getName</a>() = 0;</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  </div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <a class="code" href="classripple_1_1NodeStore_1_1Backend.html#a586356a9f6050201be9d184bc3fd2c83">open</a>(<span class="keywordtype">bool</span> createIfMissing = <span class="keyword">true</span>) = 0;</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  </div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span></div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <a class="code" href="classripple_1_1NodeStore_1_1Backend.html#acd6ac096e54166098107227a8d168044">isOpen</a>() = 0;</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  </div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span></div>
<div class="line"><a name="l00099"></a><span class="lineno"><a class="line" href="classripple_1_1NodeStore_1_1Backend.html#ae4e7c931c5382d31d877c6f7162dd21e"> 99</a></span>  <a class="code" href="classripple_1_1NodeStore_1_1Backend.html#ae4e7c931c5382d31d877c6f7162dd21e">open</a>(<span class="keywordtype">bool</span> createIfMissing, uint64_t appType, uint64_t uid, uint64_t salt)</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  {</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  Throw<std::runtime_error>(</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="stringliteral">"Deterministic appType/uid/salt not supported by backend "</span> +</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <a class="code" href="classripple_1_1NodeStore_1_1Backend.html#a206d540c4b8359c598f2309c5ee194bd">getName</a>());</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  }</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  </div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span></div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <a class="code" href="classripple_1_1NodeStore_1_1Backend.html#a6b13f9a9bbf0bf6470648f4910a92dd0">close</a>() = 0;</div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  </div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  <span class="keyword">virtual</span> <a class="code" href="namespaceripple_1_1NodeStore.html#af127c2e4fc73b5d35647147ef45b350c">Status</a></div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <a class="code" href="classripple_1_1NodeStore_1_1Backend.html#a7d3224e43e89dc098962b986d70e9833">fetch</a>(<span class="keywordtype">void</span> <span class="keyword">const</span>* key, <a class="codeRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr<NodeObject></a>* pObject) = 0;</div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  </div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  <span class="keyword">virtual</span> <a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair<std::vector<std::shared_ptr<NodeObject></a>>, <a class="code" href="namespaceripple_1_1NodeStore.html#af127c2e4fc73b5d35647147ef45b350c">Status</a>></div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  <a class="code" href="classripple_1_1NodeStore_1_1Backend.html#aa772cdcdfaae28944eac29473bc3931a">fetchBatch</a>(<a class="codeRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector<uint256 const*></a> <span class="keyword">const</span>& hashes) = 0;</div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  </div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span></div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  <a class="code" href="classripple_1_1NodeStore_1_1Backend.html#a8862f8d96713c985c3169e57cbb260c2">store</a>(<a class="codeRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr<NodeObject></a> <span class="keyword">const</span>& <span class="keywordtype">object</span>) = 0;</div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  </div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span></div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  <a class="code" href="classripple_1_1NodeStore_1_1Backend.html#acb1f22b4101841e695477646c95376a7">storeBatch</a>(<a class="codeRef" href="http://en.cppreference.com/w/cpp/container/vector.html">Batch</a> <span class="keyword">const</span>& batch) = 0;</div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  </div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span></div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  <a class="code" href="classripple_1_1NodeStore_1_1Backend.html#a0756bdfe06dcb0382b47e23b39813394">sync</a>() = 0;</div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  </div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span></div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  <a class="code" href="classripple_1_1NodeStore_1_1Backend.html#a70721d2adc758a808d2536eee864df52">for_each</a>(<a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/functional/function.html">std::function</a><<span class="keywordtype">void</span>(<a class="codeRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr<NodeObject></a>)> f) = 0;</div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  </div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  <span class="keyword">virtual</span> <span class="keywordtype">int</span></div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  <a class="code" href="classripple_1_1NodeStore_1_1Backend.html#ac4d7008b7a616ce05568da3e96a204ec">getWriteLoad</a>() = 0;</div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  </div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span></div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  <a class="code" href="classripple_1_1NodeStore_1_1Backend.html#a898be5251e9216eb21938e3083c2d1ef">setDeletePath</a>() = 0;</div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  </div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span></div>
<div class="line"><a name="l00170"></a><span class="lineno"><a class="line" href="classripple_1_1NodeStore_1_1Backend.html#afea5371bd4d7824d96f28700fa831f33"> 170</a></span>  <a class="code" href="classripple_1_1NodeStore_1_1Backend.html#afea5371bd4d7824d96f28700fa831f33">verify</a>()</div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span>  {</div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span>  }</div>
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span>  </div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span>  <span class="keyword">virtual</span> <span class="keywordtype">int</span></div>
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span>  <a class="code" href="classripple_1_1NodeStore_1_1Backend.html#a915130d326c2e63209accb8af09cf8b4">fdRequired</a>() <span class="keyword">const</span> = 0;</div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span>  </div>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span>  <span class="keyword">virtual</span> <a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional<Counters<std::uint64_t></a>></div>
<div class="line"><a name="l00184"></a><span class="lineno"><a class="line" href="classripple_1_1NodeStore_1_1Backend.html#afd4e55baccdaf56f34ae3c77191932a6"> 184</a></span>  <a class="code" href="classripple_1_1NodeStore_1_1Backend.html#afd4e55baccdaf56f34ae3c77191932a6">counters</a>()<span class="keyword"> const</span></div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span> <span class="keyword"> </span>{</div>
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span>  <span class="keywordflow">return</span> std::nullopt;</div>
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span>  }</div>
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span> };</div>
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span>  </div>
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span> } <span class="comment">// namespace NodeStore</span></div>
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span> } <span class="comment">// namespace ripple</span></div>
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span>  </div>
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span> <span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="abasic_string_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a></div><div class="ttdoc">STL class.</div></div>
<div class="ttc" id="ashared_ptr_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr< NodeObject ></a></div></div>
<div class="ttc" id="aclassripple_1_1NodeStore_1_1Backend_html_ac4d7008b7a616ce05568da3e96a204ec"><div class="ttname"><a href="classripple_1_1NodeStore_1_1Backend.html#ac4d7008b7a616ce05568da3e96a204ec">ripple::NodeStore::Backend::getWriteLoad</a></div><div class="ttdeci">virtual int getWriteLoad()=0</div><div class="ttdoc">Estimate the number of write operations pending.</div></div>
<div class="ttc" id="apair_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</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</a></div><div class="ttdoc">STL class.</div></div>
<div class="ttc" id="aclassripple_1_1NodeStore_1_1Backend_html_a0756bdfe06dcb0382b47e23b39813394"><div class="ttname"><a href="classripple_1_1NodeStore_1_1Backend.html#a0756bdfe06dcb0382b47e23b39813394">ripple::NodeStore::Backend::sync</a></div><div class="ttdeci">virtual void sync()=0</div></div>
<div class="ttc" id="afunction_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/utility/functional/function.html">std::function</a></div></div>
<div class="ttc" id="aclassripple_1_1NodeStore_1_1Backend_html_afea5371bd4d7824d96f28700fa831f33"><div class="ttname"><a href="classripple_1_1NodeStore_1_1Backend.html#afea5371bd4d7824d96f28700fa831f33">ripple::NodeStore::Backend::verify</a></div><div class="ttdeci">virtual void verify()</div><div class="ttdoc">Perform consistency checks on database.</div><div class="ttdef"><b>Definition:</b> <a href="Backend_8h_source.html#l00170">Backend.h:170</a></div></div>
<div class="ttc" id="aclassripple_1_1NodeStore_1_1Backend_html_a8862f8d96713c985c3169e57cbb260c2"><div class="ttname"><a href="classripple_1_1NodeStore_1_1Backend.html#a8862f8d96713c985c3169e57cbb260c2">ripple::NodeStore::Backend::store</a></div><div class="ttdeci">virtual void store(std::shared_ptr< NodeObject > const &object)=0</div><div class="ttdoc">Store a single object.</div></div>
<div class="ttc" id="astructripple_1_1NodeStore_1_1Backend_1_1Counters_html_a39b84060d6f028afdb1b742436cbbcdd"><div class="ttname"><a href="structripple_1_1NodeStore_1_1Backend_1_1Counters.html#a39b84060d6f028afdb1b742436cbbcdd">ripple::NodeStore::Backend::Counters::Counters</a></div><div class="ttdeci">Counters()=default</div></div>
<div class="ttc" id="aclassripple_1_1NodeStore_1_1Backend_html_a6b13f9a9bbf0bf6470648f4910a92dd0"><div class="ttname"><a href="classripple_1_1NodeStore_1_1Backend.html#a6b13f9a9bbf0bf6470648f4910a92dd0">ripple::NodeStore::Backend::close</a></div><div class="ttdeci">virtual void close()=0</div><div class="ttdoc">Close the backend.</div></div>
<div class="ttc" id="aclassripple_1_1NodeStore_1_1Backend_html_a70721d2adc758a808d2536eee864df52"><div class="ttname"><a href="classripple_1_1NodeStore_1_1Backend.html#a70721d2adc758a808d2536eee864df52">ripple::NodeStore::Backend::for_each</a></div><div class="ttdeci">virtual void for_each(std::function< void(std::shared_ptr< NodeObject >)> f)=0</div><div class="ttdoc">Visit every object in the database This is usually called during import.</div></div>
<div class="ttc" id="aclassripple_1_1NodeStore_1_1Backend_html_afd4e55baccdaf56f34ae3c77191932a6"><div class="ttname"><a href="classripple_1_1NodeStore_1_1Backend.html#afd4e55baccdaf56f34ae3c77191932a6">ripple::NodeStore::Backend::counters</a></div><div class="ttdeci">virtual std::optional< Counters< std::uint64_t > > counters() const</div><div class="ttdoc">Returns read and write stats.</div><div class="ttdef"><b>Definition:</b> <a href="Backend_8h_source.html#l00184">Backend.h:184</a></div></div>
<div class="ttc" id="astructripple_1_1NodeStore_1_1Backend_1_1Counters_html_a4d9e96c8ce2f414933f1dc7a5963c9ca"><div class="ttname"><a href="structripple_1_1NodeStore_1_1Backend_1_1Counters.html#a4d9e96c8ce2f414933f1dc7a5963c9ca">ripple::NodeStore::Backend::Counters::Counters</a></div><div class="ttdeci">Counters(Counters< U > const &other)</div><div class="ttdef"><b>Definition:</b> <a href="Backend_8h_source.html#l00049">Backend.h:49</a></div></div>
<div class="ttc" id="aclassripple_1_1NodeStore_1_1Backend_html_a7be1490e873f0a4956e4dd9effc9061b"><div class="ttname"><a href="classripple_1_1NodeStore_1_1Backend.html#a7be1490e873f0a4956e4dd9effc9061b">ripple::NodeStore::Backend::~Backend</a></div><div class="ttdeci">virtual ~Backend()=default</div><div class="ttdoc">Destroy the backend.</div></div>
<div class="ttc" id="astructripple_1_1NodeStore_1_1Backend_1_1Counters_html_ab702bb6ba8602c6516b801fa348953cd"><div class="ttname"><a href="structripple_1_1NodeStore_1_1Backend_1_1Counters.html#ab702bb6ba8602c6516b801fa348953cd">ripple::NodeStore::Backend::Counters::readErrors</a></div><div class="ttdeci">T readErrors</div><div class="ttdef"><b>Definition:</b> <a href="Backend_8h_source.html#l00062">Backend.h:62</a></div></div>
<div class="ttc" id="aclassripple_1_1NodeStore_1_1Backend_html_aa772cdcdfaae28944eac29473bc3931a"><div class="ttname"><a href="classripple_1_1NodeStore_1_1Backend.html#aa772cdcdfaae28944eac29473bc3931a">ripple::NodeStore::Backend::fetchBatch</a></div><div class="ttdeci">virtual std::pair< std::vector< std::shared_ptr< NodeObject > >, Status > fetchBatch(std::vector< uint256 const * > const &hashes)=0</div><div class="ttdoc">Fetch a batch synchronously.</div></div>
<div class="ttc" id="acstdint_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/cstdint.html">cstdint</a></div></div>
<div class="ttc" id="aatomic_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/atomic.html">atomic</a></div></div>
<div class="ttc" id="aclassripple_1_1NodeStore_1_1Backend_html_acd6ac096e54166098107227a8d168044"><div class="ttname"><a href="classripple_1_1NodeStore_1_1Backend.html#acd6ac096e54166098107227a8d168044">ripple::NodeStore::Backend::isOpen</a></div><div class="ttdeci">virtual bool isOpen()=0</div><div class="ttdoc">Returns true is the database is open.</div></div>
<div class="ttc" id="astructripple_1_1NodeStore_1_1Backend_1_1Counters_html_a99ac1f0201c18f8789be466de3107d1e"><div class="ttname"><a href="structripple_1_1NodeStore_1_1Backend_1_1Counters.html#a99ac1f0201c18f8789be466de3107d1e">ripple::NodeStore::Backend::Counters::writesDelayed</a></div><div class="ttdeci">T writesDelayed</div><div class="ttdef"><b>Definition:</b> <a href="Backend_8h_source.html#l00060">Backend.h:60</a></div></div>
<div class="ttc" id="anamespaceripple_1_1NodeStore_html_af127c2e4fc73b5d35647147ef45b350c"><div class="ttname"><a href="namespaceripple_1_1NodeStore.html#af127c2e4fc73b5d35647147ef45b350c">ripple::NodeStore::Status</a></div><div class="ttdeci">Status</div><div class="ttdoc">Return codes from Backend operations.</div><div class="ttdef"><b>Definition:</b> <a href="nodestore_2Types_8h_source.html#l00044">nodestore/Types.h:44</a></div></div>
<div class="ttc" id="aclassripple_1_1NodeStore_1_1Backend_html_a898be5251e9216eb21938e3083c2d1ef"><div class="ttname"><a href="classripple_1_1NodeStore_1_1Backend.html#a898be5251e9216eb21938e3083c2d1ef">ripple::NodeStore::Backend::setDeletePath</a></div><div class="ttdeci">virtual void setDeletePath()=0</div><div class="ttdoc">Remove contents on disk upon destruction.</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_1NodeStore_1_1Backend_html_a915130d326c2e63209accb8af09cf8b4"><div class="ttname"><a href="classripple_1_1NodeStore_1_1Backend.html#a915130d326c2e63209accb8af09cf8b4">ripple::NodeStore::Backend::fdRequired</a></div><div class="ttdeci">virtual int fdRequired() const =0</div><div class="ttdoc">Returns the number of file descriptors the backend expects to need.</div></div>
<div class="ttc" id="aclassripple_1_1NodeStore_1_1Backend_html_a206d540c4b8359c598f2309c5ee194bd"><div class="ttname"><a href="classripple_1_1NodeStore_1_1Backend.html#a206d540c4b8359c598f2309c5ee194bd">ripple::NodeStore::Backend::getName</a></div><div class="ttdeci">virtual std::string getName()=0</div><div class="ttdoc">Get the human-readable name of this backend.</div></div>
<div class="ttc" id="aclassripple_1_1NodeStore_1_1Backend_html_ae4e7c931c5382d31d877c6f7162dd21e"><div class="ttname"><a href="classripple_1_1NodeStore_1_1Backend.html#ae4e7c931c5382d31d877c6f7162dd21e">ripple::NodeStore::Backend::open</a></div><div class="ttdeci">virtual void open(bool createIfMissing, uint64_t appType, uint64_t uid, uint64_t salt)</div><div class="ttdoc">Open the backend.</div><div class="ttdef"><b>Definition:</b> <a href="Backend_8h_source.html#l00099">Backend.h:99</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="astructripple_1_1NodeStore_1_1Backend_1_1Counters_html_a01d74b4c124a43c3aa2bdac5d5d77481"><div class="ttname"><a href="structripple_1_1NodeStore_1_1Backend_1_1Counters.html#a01d74b4c124a43c3aa2bdac5d5d77481">ripple::NodeStore::Backend::Counters::readRetries</a></div><div class="ttdeci">T readRetries</div><div class="ttdef"><b>Definition:</b> <a href="Backend_8h_source.html#l00061">Backend.h:61</a></div></div>
<div class="ttc" id="aclassripple_1_1NodeStore_1_1Backend_html_acb1f22b4101841e695477646c95376a7"><div class="ttname"><a href="classripple_1_1NodeStore_1_1Backend.html#acb1f22b4101841e695477646c95376a7">ripple::NodeStore::Backend::storeBatch</a></div><div class="ttdeci">virtual void storeBatch(Batch const &batch)=0</div><div class="ttdoc">Store a group of objects.</div></div>
<div class="ttc" id="aclassripple_1_1NodeStore_1_1Backend_html_a586356a9f6050201be9d184bc3fd2c83"><div class="ttname"><a href="classripple_1_1NodeStore_1_1Backend.html#a586356a9f6050201be9d184bc3fd2c83">ripple::NodeStore::Backend::open</a></div><div class="ttdeci">virtual void open(bool createIfMissing=true)=0</div><div class="ttdoc">Open the backend.</div></div>
<div class="ttc" id="aclassripple_1_1NodeStore_1_1Backend_html_a7d3224e43e89dc098962b986d70e9833"><div class="ttname"><a href="classripple_1_1NodeStore_1_1Backend.html#a7d3224e43e89dc098962b986d70e9833">ripple::NodeStore::Backend::fetch</a></div><div class="ttdeci">virtual Status fetch(void const *key, std::shared_ptr< NodeObject > *pObject)=0</div><div class="ttdoc">Fetch a single object.</div></div>
<div class="ttc" id="astructripple_1_1NodeStore_1_1Backend_1_1Counters_html_a1d1f54135ed181b67fda19d6cb2309bf"><div class="ttname"><a href="structripple_1_1NodeStore_1_1Backend_1_1Counters.html#a1d1f54135ed181b67fda19d6cb2309bf">ripple::NodeStore::Backend::Counters::writeDurationUs</a></div><div class="ttdeci">T writeDurationUs</div><div class="ttdef"><b>Definition:</b> <a href="Backend_8h_source.html#l00058">Backend.h:58</a></div></div>
<div class="ttc" id="astructripple_1_1NodeStore_1_1Backend_1_1Counters_html_ac079f0914294773b686e059f80e0690e"><div class="ttname"><a href="structripple_1_1NodeStore_1_1Backend_1_1Counters.html#ac079f0914294773b686e059f80e0690e">ripple::NodeStore::Backend::Counters::writeRetries</a></div><div class="ttdeci">T writeRetries</div><div class="ttdef"><b>Definition:</b> <a href="Backend_8h_source.html#l00059">Backend.h:59</a></div></div>
<div class="ttc" id="aclassripple_1_1NodeStore_1_1Backend_html"><div class="ttname"><a href="classripple_1_1NodeStore_1_1Backend.html">ripple::NodeStore::Backend</a></div><div class="ttdoc">A backend used for the NodeStore.</div><div class="ttdef"><b>Definition:</b> <a href="Backend_8h_source.html#l00039">Backend.h:39</a></div></div>
<div class="ttc" id="astructripple_1_1NodeStore_1_1Backend_1_1Counters_html"><div class="ttname"><a href="structripple_1_1NodeStore_1_1Backend_1_1Counters.html">ripple::NodeStore::Backend::Counters</a></div><div class="ttdef"><b>Definition:</b> <a href="Backend_8h_source.html#l00043">Backend.h:43</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>