ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2026-02-04 05:55:25 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
b9ef07fc10ff9ab5d7eebb9ef057e335fa5786a7
rippled/Backend_8h_source.html
bthomee a661b19a31 deploy: 1eb0fdac65
2025-12-11 08:55:10 -08:00

208 lines
28 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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: 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 id="projectrow">
<td id="projectalign">
<div id="projectname">rippled
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_0103a8ad82dcc2c51f5cde661b4b5cb7.html">xrpl</a></li><li class="navelem"><a class="el" href="dir_e1b4f750ea5d02d697bca882e10403c3.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 id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#ifndef XRPL_NODESTORE_BACKEND_H_INCLUDED</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define XRPL_NODESTORE_BACKEND_H_INCLUDED</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include &lt;xrpl/nodestore/Types.h&gt;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span> </div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/cstdint.html">cstdint</a>&gt;</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> </div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacexrpl.html">xrpl</a> {</div>
<div class="foldopen" id="foldopen00009" data-start="{" data-end="}">
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"><a class="line" href="namespacexrpl_1_1NodeStore.html"> 9</a></span><span class="keyword">namespace </span>NodeStore {</div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
<div class="foldopen" id="foldopen00020" data-start="{" data-end="};">
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"><a class="line" href="classxrpl_1_1NodeStore_1_1Backend.html"> 20</a></span><span class="keyword">class </span><a class="code hl_class" href="classxrpl_1_1NodeStore_1_1Backend.html">Backend</a></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span>{</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"><a class="line" href="classxrpl_1_1NodeStore_1_1Backend.html#a1d2da3a41f1cb6ead60f4bedb4fefd87"> 29</a></span> <span class="keyword">virtual</span> <a class="code hl_function" href="classxrpl_1_1NodeStore_1_1Backend.html#a1d2da3a41f1cb6ead60f4bedb4fefd87">~Backend</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> </div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">virtual</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"><a class="line" href="classxrpl_1_1NodeStore_1_1Backend.html#ab0d0cadf7bf1f65645c68ad46985bae1"> 35</a></span> <a class="code hl_function" href="classxrpl_1_1NodeStore_1_1Backend.html#ab0d0cadf7bf1f65645c68ad46985bae1">getName</a>() = 0;</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">virtual</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional&lt;std::size_t&gt;</a></div>
<div class="foldopen" id="foldopen00040" data-start="{" data-end="}">
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"><a class="line" href="classxrpl_1_1NodeStore_1_1Backend.html#a03727bca3d99574bb995d053d1274a39"> 40</a></span> <a class="code hl_function" href="classxrpl_1_1NodeStore_1_1Backend.html#a03727bca3d99574bb995d053d1274a39">getBlockSize</a>()<span class="keyword"> const</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <span class="keywordflow">return</span> <a class="code hl_variableRef" href="http://en.cppreference.com/w/cpp/types/is_same.html">std::nullopt</a>;</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> }</div>
</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> </div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"><a class="line" href="classxrpl_1_1NodeStore_1_1Backend.html#ab74725554c62e57565b179ff32ba97b7"> 50</a></span> <a class="code hl_function" href="classxrpl_1_1NodeStore_1_1Backend.html#ab74725554c62e57565b179ff32ba97b7">open</a>(<span class="keywordtype">bool</span> createIfMissing = <span class="keyword">true</span>) = 0;</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> </div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> <span class="keyword">virtual</span> <span class="keywordtype">bool</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"><a class="line" href="classxrpl_1_1NodeStore_1_1Backend.html#ac8c332abc18b08b7236f953e348bc465"> 55</a></span> <a class="code hl_function" href="classxrpl_1_1NodeStore_1_1Backend.html#ac8c332abc18b08b7236f953e348bc465">isOpen</a>() = 0;</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> </div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span></div>
<div class="foldopen" id="foldopen00065" data-start="{" data-end="}">
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"><a class="line" href="classxrpl_1_1NodeStore_1_1Backend.html#ae97a50318c8c6bc82ec741f8ba8f7184"> 65</a></span> <a class="code hl_function" href="classxrpl_1_1NodeStore_1_1Backend.html#ae97a50318c8c6bc82ec741f8ba8f7184">open</a>(<span class="keywordtype">bool</span> createIfMissing, uint64_t appType, uint64_t uid, uint64_t salt)</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> {</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> Throw&lt;std::runtime_error&gt;(</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> <span class="stringliteral">&quot;Deterministic appType/uid/salt not supported by backend &quot;</span> +</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> <a class="code hl_function" href="classxrpl_1_1NodeStore_1_1Backend.html#ab0d0cadf7bf1f65645c68ad46985bae1">getName</a>());</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> }</div>
</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> </div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"><a class="line" href="classxrpl_1_1NodeStore_1_1Backend.html#a42bd89985d561b8c13172fab5a5f256a"> 76</a></span> <a class="code hl_function" href="classxrpl_1_1NodeStore_1_1Backend.html#a42bd89985d561b8c13172fab5a5f256a">close</a>() = 0;</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> </div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> <span class="keyword">virtual</span> <a class="code hl_enumeration" href="namespacexrpl_1_1NodeStore.html#a4883b8bc797bf7591fde489676a6e96b">Status</a></div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"><a class="line" href="classxrpl_1_1NodeStore_1_1Backend.html#abb0dc12089b483131bd7b988e82ffcdd"> 87</a></span> <a class="code hl_function" href="classxrpl_1_1NodeStore_1_1Backend.html#abb0dc12089b483131bd7b988e82ffcdd">fetch</a>(<span class="keywordtype">void</span> <span class="keyword">const</span>* key, <a class="code hl_classRef" 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 id="l00088" name="l00088"></a><span class="lineno"> 88</span> </div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> <span class="keyword">virtual</span> <a class="code hl_classRef" 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 hl_enumeration" href="namespacexrpl_1_1NodeStore.html#a4883b8bc797bf7591fde489676a6e96b">Status</a>&gt;</div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"><a class="line" href="classxrpl_1_1NodeStore_1_1Backend.html#a0fce7a2ea5cd207d0632cbb5f97f8764"> 91</a></span> <a class="code hl_function" href="classxrpl_1_1NodeStore_1_1Backend.html#a0fce7a2ea5cd207d0632cbb5f97f8764">fetchBatch</a>(<a class="code hl_classRef" 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 id="l00092" name="l00092"></a><span class="lineno"> 92</span> </div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span></div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"><a class="line" href="classxrpl_1_1NodeStore_1_1Backend.html#a5b4aac007f8393e75549f71e52c51868"> 100</a></span> <a class="code hl_function" href="classxrpl_1_1NodeStore_1_1Backend.html#a5b4aac007f8393e75549f71e52c51868">store</a>(<a class="code hl_classRef" 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 id="l00101" name="l00101"></a><span class="lineno"> 101</span> </div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span></div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"><a class="line" href="classxrpl_1_1NodeStore_1_1Backend.html#ae527fa046484dbc48064d61e9956664e"> 107</a></span> <a class="code hl_function" href="classxrpl_1_1NodeStore_1_1Backend.html#ae527fa046484dbc48064d61e9956664e">storeBatch</a>(<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/container/vector.html">Batch</a> <span class="keyword">const</span>&amp; <a class="code hl_enumvalue" href="namespacexrpl.html#ac599741e6d4066bada11df4c7e8ad30aad265aed699f7409ac0ec6fe07ee9cb11">batch</a>) = 0;</div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span> </div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span></div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"><a class="line" href="classxrpl_1_1NodeStore_1_1Backend.html#aad656e6d9710007cb230cbe86a65c760"> 110</a></span> <a class="code hl_function" href="classxrpl_1_1NodeStore_1_1Backend.html#aad656e6d9710007cb230cbe86a65c760">sync</a>() = 0;</div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span> </div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span></div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"><a class="line" href="classxrpl_1_1NodeStore_1_1Backend.html#a79cf71fb84fe29a64a9897a6705912d6"> 119</a></span> <a class="code hl_function" href="classxrpl_1_1NodeStore_1_1Backend.html#a79cf71fb84fe29a64a9897a6705912d6">for_each</a>(<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/functional/function.html">std::function</a>&lt;<span class="keywordtype">void</span>(<a class="code hl_classRef" 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 id="l00120" name="l00120"></a><span class="lineno"> 120</span> </div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span> <span class="keyword">virtual</span> <span class="keywordtype">int</span></div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"><a class="line" href="classxrpl_1_1NodeStore_1_1Backend.html#a245a960f24d10138b38271a2c92ea5c4"> 123</a></span> <a class="code hl_function" href="classxrpl_1_1NodeStore_1_1Backend.html#a245a960f24d10138b38271a2c92ea5c4">getWriteLoad</a>() = 0;</div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span> </div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span></div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"><a class="line" href="classxrpl_1_1NodeStore_1_1Backend.html#af5099be6d791817eba64797664363c55"> 127</a></span> <a class="code hl_function" href="classxrpl_1_1NodeStore_1_1Backend.html#af5099be6d791817eba64797664363c55">setDeletePath</a>() = 0;</div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span> </div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span></div>
<div class="foldopen" id="foldopen00136" data-start="{" data-end="}">
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"><a class="line" href="classxrpl_1_1NodeStore_1_1Backend.html#ae0c574b83f9dfbfd6e90798f5de3a215"> 136</a></span> <a class="code hl_function" href="classxrpl_1_1NodeStore_1_1Backend.html#ae0c574b83f9dfbfd6e90798f5de3a215">verify</a>()</div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span> {</div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span> }</div>
</div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span> </div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno"> 141</span> <span class="keyword">virtual</span> <span class="keywordtype">int</span></div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno"><a class="line" href="classxrpl_1_1NodeStore_1_1Backend.html#a3a3220c42e3758a8b14f4206e2c81a9e"> 142</a></span> <a class="code hl_function" href="classxrpl_1_1NodeStore_1_1Backend.html#a3a3220c42e3758a8b14f4206e2c81a9e">fdRequired</a>() <span class="keyword">const</span> = 0;</div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno"> 143</span>};</div>
</div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno"> 144</span> </div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno"> 145</span>} <span class="comment">// namespace NodeStore</span></div>
</div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno"> 146</span>} <span class="comment">// namespace xrpl</span></div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno"> 147</span> </div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno"> 148</span><span class="preprocessor">#endif</span></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>
<div class="ttc" id="aclassxrpl_1_1NodeStore_1_1Backend_html"><div class="ttname"><a href="classxrpl_1_1NodeStore_1_1Backend.html">xrpl::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#l00020">Backend.h:21</a></div></div>
<div class="ttc" id="aclassxrpl_1_1NodeStore_1_1Backend_html_a03727bca3d99574bb995d053d1274a39"><div class="ttname"><a href="classxrpl_1_1NodeStore_1_1Backend.html#a03727bca3d99574bb995d053d1274a39">xrpl::NodeStore::Backend::getBlockSize</a></div><div class="ttdeci">virtual std::optional&lt; std::size_t &gt; getBlockSize() const</div><div class="ttdoc">Get the block size for backends that support it.</div><div class="ttdef"><b>Definition</b> <a href="Backend_8h_source.html#l00040">Backend.h:40</a></div></div>
<div class="ttc" id="aclassxrpl_1_1NodeStore_1_1Backend_html_a0fce7a2ea5cd207d0632cbb5f97f8764"><div class="ttname"><a href="classxrpl_1_1NodeStore_1_1Backend.html#a0fce7a2ea5cd207d0632cbb5f97f8764">xrpl::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="aclassxrpl_1_1NodeStore_1_1Backend_html_a1d2da3a41f1cb6ead60f4bedb4fefd87"><div class="ttname"><a href="classxrpl_1_1NodeStore_1_1Backend.html#a1d2da3a41f1cb6ead60f4bedb4fefd87">xrpl::NodeStore::Backend::~Backend</a></div><div class="ttdeci">virtual ~Backend()=default</div><div class="ttdoc">Destroy the backend.</div></div>
<div class="ttc" id="aclassxrpl_1_1NodeStore_1_1Backend_html_a245a960f24d10138b38271a2c92ea5c4"><div class="ttname"><a href="classxrpl_1_1NodeStore_1_1Backend.html#a245a960f24d10138b38271a2c92ea5c4">xrpl::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="aclassxrpl_1_1NodeStore_1_1Backend_html_a3a3220c42e3758a8b14f4206e2c81a9e"><div class="ttname"><a href="classxrpl_1_1NodeStore_1_1Backend.html#a3a3220c42e3758a8b14f4206e2c81a9e">xrpl::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="aclassxrpl_1_1NodeStore_1_1Backend_html_a42bd89985d561b8c13172fab5a5f256a"><div class="ttname"><a href="classxrpl_1_1NodeStore_1_1Backend.html#a42bd89985d561b8c13172fab5a5f256a">xrpl::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="aclassxrpl_1_1NodeStore_1_1Backend_html_a5b4aac007f8393e75549f71e52c51868"><div class="ttname"><a href="classxrpl_1_1NodeStore_1_1Backend.html#a5b4aac007f8393e75549f71e52c51868">xrpl::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="aclassxrpl_1_1NodeStore_1_1Backend_html_a79cf71fb84fe29a64a9897a6705912d6"><div class="ttname"><a href="classxrpl_1_1NodeStore_1_1Backend.html#a79cf71fb84fe29a64a9897a6705912d6">xrpl::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="aclassxrpl_1_1NodeStore_1_1Backend_html_aad656e6d9710007cb230cbe86a65c760"><div class="ttname"><a href="classxrpl_1_1NodeStore_1_1Backend.html#aad656e6d9710007cb230cbe86a65c760">xrpl::NodeStore::Backend::sync</a></div><div class="ttdeci">virtual void sync()=0</div></div>
<div class="ttc" id="aclassxrpl_1_1NodeStore_1_1Backend_html_ab0d0cadf7bf1f65645c68ad46985bae1"><div class="ttname"><a href="classxrpl_1_1NodeStore_1_1Backend.html#ab0d0cadf7bf1f65645c68ad46985bae1">xrpl::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="aclassxrpl_1_1NodeStore_1_1Backend_html_ab74725554c62e57565b179ff32ba97b7"><div class="ttname"><a href="classxrpl_1_1NodeStore_1_1Backend.html#ab74725554c62e57565b179ff32ba97b7">xrpl::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="aclassxrpl_1_1NodeStore_1_1Backend_html_abb0dc12089b483131bd7b988e82ffcdd"><div class="ttname"><a href="classxrpl_1_1NodeStore_1_1Backend.html#abb0dc12089b483131bd7b988e82ffcdd">xrpl::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="aclassxrpl_1_1NodeStore_1_1Backend_html_ac8c332abc18b08b7236f953e348bc465"><div class="ttname"><a href="classxrpl_1_1NodeStore_1_1Backend.html#ac8c332abc18b08b7236f953e348bc465">xrpl::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="aclassxrpl_1_1NodeStore_1_1Backend_html_ae0c574b83f9dfbfd6e90798f5de3a215"><div class="ttname"><a href="classxrpl_1_1NodeStore_1_1Backend.html#ae0c574b83f9dfbfd6e90798f5de3a215">xrpl::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#l00136">Backend.h:136</a></div></div>
<div class="ttc" id="aclassxrpl_1_1NodeStore_1_1Backend_html_ae527fa046484dbc48064d61e9956664e"><div class="ttname"><a href="classxrpl_1_1NodeStore_1_1Backend.html#ae527fa046484dbc48064d61e9956664e">xrpl::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="aclassxrpl_1_1NodeStore_1_1Backend_html_ae97a50318c8c6bc82ec741f8ba8f7184"><div class="ttname"><a href="classxrpl_1_1NodeStore_1_1Backend.html#ae97a50318c8c6bc82ec741f8ba8f7184">xrpl::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#l00065">Backend.h:65</a></div></div>
<div class="ttc" id="aclassxrpl_1_1NodeStore_1_1Backend_html_af5099be6d791817eba64797664363c55"><div class="ttname"><a href="classxrpl_1_1NodeStore_1_1Backend.html#af5099be6d791817eba64797664363c55">xrpl::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="acstdint_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/cstdint.html">cstdint</a></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="ais_same_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/types/is_same.html">std::is_same_v</a></div><div class="ttdeci">T is_same_v</div></div>
<div class="ttc" id="anamespacexrpl_1_1NodeStore_html_a4883b8bc797bf7591fde489676a6e96b"><div class="ttname"><a href="namespacexrpl_1_1NodeStore.html#a4883b8bc797bf7591fde489676a6e96b">xrpl::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#l00025">nodestore/Types.h:25</a></div></div>
<div class="ttc" id="anamespacexrpl_html"><div class="ttname"><a href="namespacexrpl.html">xrpl</a></div><div class="ttdoc">Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.</div><div class="ttdef"><b>Definition</b> <a href="algorithm_8h_source.html#l00006">algorithm.h:6</a></div></div>
<div class="ttc" id="anamespacexrpl_html_ac599741e6d4066bada11df4c7e8ad30aad265aed699f7409ac0ec6fe07ee9cb11"><div class="ttname"><a href="namespacexrpl.html#ac599741e6d4066bada11df4c7e8ad30aad265aed699f7409ac0ec6fe07ee9cb11">xrpl::HashPrefix::batch</a></div><div class="ttdeci">@ batch</div><div class="ttdoc">Batch.</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="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="ashared_ptr_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</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>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink