ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-21 11:35:53 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
46ee4c24ed9df242fb7d6619b767b57e366ee028
rippled/Backend_8h_source.html
manojsdoshi 46ee4c24ed deploy: c11037fd27
2021-01-21 18:53:50 +00:00

217 lines
33 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<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&amp;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&amp;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>&#160;<span class="comment">//------------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<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>&#160;<span class="comment"> Copyright (c) 2012, 2013 Ripple Labs Inc.</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<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>&#160;<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>&#160;<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>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> THE SOFTWARE IS PROVIDED &quot;AS IS&quot; AND THE AUTHOR DISCLAIMS ALL WARRANTIES</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<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>&#160;<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>&#160;<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>&#160;<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>&#160;<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>&#160;<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>&#160;<span class="comment">*/</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment">//==============================================================================</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#ifndef RIPPLE_NODESTORE_BACKEND_H_INCLUDED</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#define RIPPLE_NODESTORE_BACKEND_H_INCLUDED</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &lt;ripple/nodestore/Types.h&gt;</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/atomic.html">atomic</a>&gt;</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/cstdint.html">cstdint</a>&gt;</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; </div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<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>&#160;<span class="keyword">namespace </span>NodeStore {</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; </div>
<div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="classripple_1_1NodeStore_1_1Backend.html"> 39</a></span>&#160;<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>&#160;{</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="structripple_1_1NodeStore_1_1Backend_1_1Counters.html"> 42</a></span>&#160; <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="l00043"></a><span class="lineno"> 43</span>&#160; {</div>
<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="structripple_1_1NodeStore_1_1Backend_1_1Counters.html#a1f88b82f8b14259ed47f4ef33b033a8b"> 44</a></span>&#160; <a class="codeRef" href="http://en.cppreference.com/w/cpp/atomic/atomic.html">std::atomic&lt;std::uint64_t&gt;</a> <a class="code" href="structripple_1_1NodeStore_1_1Backend_1_1Counters.html#a1f88b82f8b14259ed47f4ef33b033a8b">writeDurationUs</a>{0};</div>
<div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="structripple_1_1NodeStore_1_1Backend_1_1Counters.html#aa16709a06383948663d5c86ec5423316"> 45</a></span>&#160; <a class="codeRef" href="http://en.cppreference.com/w/cpp/atomic/atomic.html">std::atomic&lt;std::uint64_t&gt;</a> <a class="code" href="structripple_1_1NodeStore_1_1Backend_1_1Counters.html#aa16709a06383948663d5c86ec5423316">writeRetries</a>{0};</div>
<div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="structripple_1_1NodeStore_1_1Backend_1_1Counters.html#a9d5d5516a793f9cc7477ae25761190eb"> 46</a></span>&#160; <a class="codeRef" href="http://en.cppreference.com/w/cpp/atomic/atomic.html">std::atomic&lt;std::uint64_t&gt;</a> <a class="code" href="structripple_1_1NodeStore_1_1Backend_1_1Counters.html#a9d5d5516a793f9cc7477ae25761190eb">writesDelayed</a>{0};</div>
<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="structripple_1_1NodeStore_1_1Backend_1_1Counters.html#aae4de1420925914dbef6557c4fd523b5"> 47</a></span>&#160; <a class="codeRef" href="http://en.cppreference.com/w/cpp/atomic/atomic.html">std::atomic&lt;std::uint64_t&gt;</a> <a class="code" href="structripple_1_1NodeStore_1_1Backend_1_1Counters.html#aae4de1420925914dbef6557c4fd523b5">readRetries</a>{0};</div>
<div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="structripple_1_1NodeStore_1_1Backend_1_1Counters.html#a471dff5dc604c437f24bdff0df7a1415"> 48</a></span>&#160; <a class="codeRef" href="http://en.cppreference.com/w/cpp/atomic/atomic.html">std::atomic&lt;std::uint64_t&gt;</a> <a class="code" href="structripple_1_1NodeStore_1_1Backend_1_1Counters.html#a471dff5dc604c437f24bdff0df7a1415">readErrors</a>{0};</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; };</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; </div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <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="l00058"></a><span class="lineno"> 58</span>&#160; </div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <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="l00063"></a><span class="lineno"> 63</span>&#160; <a class="code" href="classripple_1_1NodeStore_1_1Backend.html#a206d540c4b8359c598f2309c5ee194bd">getName</a>() = 0;</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; </div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <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="l00071"></a><span class="lineno"> 71</span>&#160; </div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; <a class="code" href="classripple_1_1NodeStore_1_1Backend.html#acd6ac096e54166098107227a8d168044">isOpen</a>() = 0;</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; </div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <a class="code" href="classripple_1_1NodeStore_1_1Backend.html#a6b13f9a9bbf0bf6470648f4910a92dd0">close</a>() = 0;</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; </div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; <span class="keyword">virtual</span> <a class="code" href="namespaceripple_1_1NodeStore.html#af127c2e4fc73b5d35647147ef45b350c">Status</a></div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; <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&lt;NodeObject&gt;</a>* pObject) = 0;</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; </div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span></div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; <a class="code" href="classripple_1_1NodeStore_1_1Backend.html#a26ec003b54dcceb03af5de57ddb5e545">canFetchBatch</a>() = 0;</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; </div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; <span class="keyword">virtual</span> <a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair&lt;std::vector&lt;std::shared_ptr&lt;NodeObject&gt;</a>&gt;, <a class="code" href="namespaceripple_1_1NodeStore.html#af127c2e4fc73b5d35647147ef45b350c">Status</a>&gt;</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; <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&lt;uint256 const*&gt;</a> <span class="keyword">const</span>&amp; hashes) = 0;</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; </div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span></div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; <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&lt;NodeObject&gt;</a> <span class="keyword">const</span>&amp; <span class="keywordtype">object</span>) = 0;</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; </div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span></div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; <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>&amp; batch) = 0;</div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; </div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span></div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; <a class="code" href="classripple_1_1NodeStore_1_1Backend.html#a0756bdfe06dcb0382b47e23b39813394">sync</a>() = 0;</div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; </div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span></div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; <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>&lt;<span class="keywordtype">void</span>(<a class="codeRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr&lt;NodeObject&gt;</a>)&gt; f) = 0;</div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; </div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">int</span></div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160; <a class="code" href="classripple_1_1NodeStore_1_1Backend.html#ac4d7008b7a616ce05568da3e96a204ec">getWriteLoad</a>() = 0;</div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160; </div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span></div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160; <a class="code" href="classripple_1_1NodeStore_1_1Backend.html#a898be5251e9216eb21938e3083c2d1ef">setDeletePath</a>() = 0;</div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160; </div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span></div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160; <a class="code" href="classripple_1_1NodeStore_1_1Backend.html#ad2c3057545b73aee8e671f127b0ae084">verify</a>() = 0;</div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160; </div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">int</span></div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160; <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="l00145"></a><span class="lineno"> 145</span>&#160; </div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160; <span class="keyword">virtual</span> Counters <span class="keyword">const</span>&amp;</div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160; <a class="code" href="classripple_1_1NodeStore_1_1Backend.html#a41f97b0e74956987f2954caa609d2af4">counters</a>() <span class="keyword">const</span> = 0;</div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160; </div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160; <span class="keywordtype">bool</span></div>
<div class="line"><a name="l00151"></a><span class="lineno"><a class="line" href="classripple_1_1NodeStore_1_1Backend.html#ab07382d1cbb7d39fe7aacdbc17654861"> 151</a></span>&#160; <a class="code" href="classripple_1_1NodeStore_1_1Backend.html#ab07382d1cbb7d39fe7aacdbc17654861">backed</a>()<span class="keyword"> const</span></div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>&#160;<span class="keyword"> </span>{</div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classripple_1_1NodeStore_1_1Backend.html#a915130d326c2e63209accb8af09cf8b4">fdRequired</a>();</div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>&#160; }</div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>&#160;};</div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>&#160; </div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span>&#160;} <span class="comment">// namespace NodeStore</span></div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>&#160;} <span class="comment">// namespace ripple</span></div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span>&#160; </div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span>&#160;<span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="astructripple_1_1NodeStore_1_1Backend_1_1Counters_html_aa16709a06383948663d5c86ec5423316"><div class="ttname"><a href="structripple_1_1NodeStore_1_1Backend_1_1Counters.html#aa16709a06383948663d5c86ec5423316">ripple::NodeStore::Backend::Counters::writeRetries</a></div><div class="ttdeci">std::atomic&lt; std::uint64_t &gt; writeRetries</div><div class="ttdef"><b>Definition:</b> <a href="Backend_8h_source.html#l00045">Backend.h:45</a></div></div>
<div class="ttc" id="aclassripple_1_1NodeStore_1_1Backend_html_ab07382d1cbb7d39fe7aacdbc17654861"><div class="ttname"><a href="classripple_1_1NodeStore_1_1Backend.html#ab07382d1cbb7d39fe7aacdbc17654861">ripple::NodeStore::Backend::backed</a></div><div class="ttdeci">bool backed() const</div><div class="ttdoc">Returns true if the backend uses permanent storage.</div><div class="ttdef"><b>Definition:</b> <a href="Backend_8h_source.html#l00151">Backend.h:151</a></div></div>
<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&lt; NodeObject &gt;</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_a41f97b0e74956987f2954caa609d2af4"><div class="ttname"><a href="classripple_1_1NodeStore_1_1Backend.html#a41f97b0e74956987f2954caa609d2af4">ripple::NodeStore::Backend::counters</a></div><div class="ttdeci">virtual Counters const &amp; counters() const =0</div></div>
<div class="ttc" id="astructripple_1_1NodeStore_1_1Backend_1_1Counters_html_aae4de1420925914dbef6557c4fd523b5"><div class="ttname"><a href="structripple_1_1NodeStore_1_1Backend_1_1Counters.html#aae4de1420925914dbef6557c4fd523b5">ripple::NodeStore::Backend::Counters::readRetries</a></div><div class="ttdeci">std::atomic&lt; std::uint64_t &gt; readRetries</div><div class="ttdef"><b>Definition:</b> <a href="Backend_8h_source.html#l00047">Backend.h:47</a></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_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&lt; NodeObject &gt; const &amp;object)=0</div><div class="ttdoc">Store a single object.</div></div>
<div class="ttc" id="astructripple_1_1NodeStore_1_1Backend_1_1Counters_html_a9d5d5516a793f9cc7477ae25761190eb"><div class="ttname"><a href="structripple_1_1NodeStore_1_1Backend_1_1Counters.html#a9d5d5516a793f9cc7477ae25761190eb">ripple::NodeStore::Backend::Counters::writesDelayed</a></div><div class="ttdeci">std::atomic&lt; std::uint64_t &gt; writesDelayed</div><div class="ttdef"><b>Definition:</b> <a href="Backend_8h_source.html#l00046">Backend.h:46</a></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&lt; void(std::shared_ptr&lt; NodeObject &gt;)&gt; f)=0</div><div class="ttdoc">Visit every object in the database This is usually called during import.</div></div>
<div class="ttc" id="astructripple_1_1NodeStore_1_1Backend_1_1Counters_html_a1f88b82f8b14259ed47f4ef33b033a8b"><div class="ttname"><a href="structripple_1_1NodeStore_1_1Backend_1_1Counters.html#a1f88b82f8b14259ed47f4ef33b033a8b">ripple::NodeStore::Backend::Counters::writeDurationUs</a></div><div class="ttdeci">std::atomic&lt; std::uint64_t &gt; writeDurationUs</div><div class="ttdef"><b>Definition:</b> <a href="Backend_8h_source.html#l00044">Backend.h:44</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="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&lt; std::vector&lt; std::shared_ptr&lt; NodeObject &gt; &gt;, Status &gt; fetchBatch(std::vector&lt; uint256 const * &gt; const &amp;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="astructripple_1_1NodeStore_1_1Backend_1_1Counters_html_a471dff5dc604c437f24bdff0df7a1415"><div class="ttname"><a href="structripple_1_1NodeStore_1_1Backend_1_1Counters.html#a471dff5dc604c437f24bdff0df7a1415">ripple::NodeStore::Backend::Counters::readErrors</a></div><div class="ttdeci">std::atomic&lt; std::uint64_t &gt; readErrors</div><div class="ttdef"><b>Definition:</b> <a href="Backend_8h_source.html#l00048">Backend.h:48</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="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_a26ec003b54dcceb03af5de57ddb5e545"><div class="ttname"><a href="classripple_1_1NodeStore_1_1Backend.html#a26ec003b54dcceb03af5de57ddb5e545">ripple::NodeStore::Backend::canFetchBatch</a></div><div class="ttdeci">virtual bool canFetchBatch()=0</div><div class="ttdoc">Return true if batch fetches are optimized.</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 &amp;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_ad2c3057545b73aee8e671f127b0ae084"><div class="ttname"><a href="classripple_1_1NodeStore_1_1Backend.html#ad2c3057545b73aee8e671f127b0ae084">ripple::NodeStore::Backend::verify</a></div><div class="ttdeci">virtual void verify()=0</div><div class="ttdoc">Perform consistency checks on database.</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&lt; NodeObject &gt; *pObject)=0</div><div class="ttdoc">Fetch a single object.</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#l00042">Backend.h:42</a></div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink