mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-20 11:05:54 +00:00
795 lines
43 KiB
HTML
795 lines
43 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" 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: ripple::NodeStore::NullBackend Class Reference</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&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&dn=expat.txt MIT */
|
|
$(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">
|
|
<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="namespaceripple.html">ripple</a></li><li class="navelem"><a class="el" href="namespaceripple_1_1NodeStore.html">NodeStore</a></li><li class="navelem"><a class="el" href="classripple_1_1NodeStore_1_1NullBackend.html">NullBackend</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="classripple_1_1NodeStore_1_1NullBackend-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">ripple::NodeStore::NullBackend Class Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="dynheader">
|
|
Inheritance diagram for ripple::NodeStore::NullBackend:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classripple_1_1NodeStore_1_1NullBackend__inherit__graph.png" border="0" usemap="#aripple_1_1NodeStore_1_1NullBackend_inherit__map" alt="Inheritance graph"/></div>
|
|
<map name="aripple_1_1NodeStore_1_1NullBackend_inherit__map" id="aripple_1_1NodeStore_1_1NullBackend_inherit__map">
|
|
<area shape="rect" title=" " alt="" coords="5,93,148,133"/>
|
|
<area shape="rect" href="classripple_1_1NodeStore_1_1Backend.html" title="A backend used for the NodeStore." alt="" coords="5,5,148,45"/>
|
|
<area shape="poly" title=" " alt="" coords="79,59,79,93,74,93,74,59"/>
|
|
</map>
|
|
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
|
|
<div class="dynheader">
|
|
Collaboration diagram for ripple::NodeStore::NullBackend:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classripple_1_1NodeStore_1_1NullBackend__coll__graph.png" border="0" usemap="#aripple_1_1NodeStore_1_1NullBackend_coll__map" alt="Collaboration graph"/></div>
|
|
<map name="aripple_1_1NodeStore_1_1NullBackend_coll__map" id="aripple_1_1NodeStore_1_1NullBackend_coll__map">
|
|
<area shape="rect" title=" " alt="" coords="5,93,148,133"/>
|
|
<area shape="rect" href="classripple_1_1NodeStore_1_1Backend.html" title="A backend used for the NodeStore." alt="" coords="5,5,148,45"/>
|
|
<area shape="poly" title=" " alt="" coords="79,59,79,93,74,93,74,59"/>
|
|
</map>
|
|
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:aab527918053781c631f7f37667d75a99" id="r_aab527918053781c631f7f37667d75a99"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1NullBackend.html#aab527918053781c631f7f37667d75a99">NullBackend</a> ()=default</td></tr>
|
|
<tr class="separator:aab527918053781c631f7f37667d75a99"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abd909e2be8247d702aa74de2c363f5c6" id="r_abd909e2be8247d702aa74de2c363f5c6"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1NullBackend.html#abd909e2be8247d702aa74de2c363f5c6">~NullBackend</a> ()=default</td></tr>
|
|
<tr class="separator:abd909e2be8247d702aa74de2c363f5c6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a89c46335dae32bdda3cc2cd0d2558abf" id="r_a89c46335dae32bdda3cc2cd0d2558abf"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1NullBackend.html#a89c46335dae32bdda3cc2cd0d2558abf">getName</a> () override</td></tr>
|
|
<tr class="memdesc:a89c46335dae32bdda3cc2cd0d2558abf"><td class="mdescLeft"> </td><td class="mdescRight">Get the human-readable name of this backend. <br /></td></tr>
|
|
<tr class="separator:a89c46335dae32bdda3cc2cd0d2558abf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0b2c45caa5842849382a198b28687c8e" id="r_a0b2c45caa5842849382a198b28687c8e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1NullBackend.html#a0b2c45caa5842849382a198b28687c8e">open</a> (bool createIfMissing) override</td></tr>
|
|
<tr class="memdesc:a0b2c45caa5842849382a198b28687c8e"><td class="mdescLeft"> </td><td class="mdescRight">Open the backend. <br /></td></tr>
|
|
<tr class="separator:a0b2c45caa5842849382a198b28687c8e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a06edcc6548cdcac4785c1de9c3a1662f" id="r_a06edcc6548cdcac4785c1de9c3a1662f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1NullBackend.html#a06edcc6548cdcac4785c1de9c3a1662f">isOpen</a> () override</td></tr>
|
|
<tr class="memdesc:a06edcc6548cdcac4785c1de9c3a1662f"><td class="mdescLeft"> </td><td class="mdescRight">Returns true is the database is open. <br /></td></tr>
|
|
<tr class="separator:a06edcc6548cdcac4785c1de9c3a1662f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0269121f17ab29c92a5df0d2a035dd47" id="r_a0269121f17ab29c92a5df0d2a035dd47"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1NullBackend.html#a0269121f17ab29c92a5df0d2a035dd47">close</a> () override</td></tr>
|
|
<tr class="memdesc:a0269121f17ab29c92a5df0d2a035dd47"><td class="mdescLeft"> </td><td class="mdescRight">Close the backend. <br /></td></tr>
|
|
<tr class="separator:a0269121f17ab29c92a5df0d2a035dd47"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1dc8a4f932bb50366f9f967e5c35cb3a" id="r_a1dc8a4f932bb50366f9f967e5c35cb3a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple_1_1NodeStore.html#af127c2e4fc73b5d35647147ef45b350c">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1NullBackend.html#a1dc8a4f932bb50366f9f967e5c35cb3a">fetch</a> (void const *, <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>< <a class="el" href="classripple_1_1NodeObject.html">NodeObject</a> > *) override</td></tr>
|
|
<tr class="memdesc:a1dc8a4f932bb50366f9f967e5c35cb3a"><td class="mdescLeft"> </td><td class="mdescRight">Fetch a single object. <br /></td></tr>
|
|
<tr class="separator:a1dc8a4f932bb50366f9f967e5c35cb3a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a780a94041c6b9f059f9c33e5d5780c2a" id="r_a780a94041c6b9f059f9c33e5d5780c2a"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</a>< <a class="elRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a>< <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>< <a class="el" href="classripple_1_1NodeObject.html">NodeObject</a> > >, <a class="el" href="namespaceripple_1_1NodeStore.html#af127c2e4fc73b5d35647147ef45b350c">Status</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1NullBackend.html#a780a94041c6b9f059f9c33e5d5780c2a">fetchBatch</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a>< <a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> const * > const &hashes) override</td></tr>
|
|
<tr class="memdesc:a780a94041c6b9f059f9c33e5d5780c2a"><td class="mdescLeft"> </td><td class="mdescRight">Fetch a batch synchronously. <br /></td></tr>
|
|
<tr class="separator:a780a94041c6b9f059f9c33e5d5780c2a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad3d41ab83222e39efd5aaebf39160df8" id="r_ad3d41ab83222e39efd5aaebf39160df8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1NullBackend.html#ad3d41ab83222e39efd5aaebf39160df8">store</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>< <a class="el" href="classripple_1_1NodeObject.html">NodeObject</a> > const &object) override</td></tr>
|
|
<tr class="memdesc:ad3d41ab83222e39efd5aaebf39160df8"><td class="mdescLeft"> </td><td class="mdescRight">Store a single object. <br /></td></tr>
|
|
<tr class="separator:ad3d41ab83222e39efd5aaebf39160df8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac3d735a9706df0a50c08a2a737ebeb3d" id="r_ac3d735a9706df0a50c08a2a737ebeb3d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1NullBackend.html#ac3d735a9706df0a50c08a2a737ebeb3d">storeBatch</a> (<a class="el" href="namespaceripple_1_1NodeStore.html#ae0e4b79f8eb3ffa0bf8fcaf848643202">Batch</a> const &<a class="el" href="namespaceripple.html#ad5143ceada01141772ae4aab984f94bdad265aed699f7409ac0ec6fe07ee9cb11">batch</a>) override</td></tr>
|
|
<tr class="memdesc:ac3d735a9706df0a50c08a2a737ebeb3d"><td class="mdescLeft"> </td><td class="mdescRight">Store a group of objects. <br /></td></tr>
|
|
<tr class="separator:ac3d735a9706df0a50c08a2a737ebeb3d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a48f53c890d50d72621ebaa72cba3214f" id="r_a48f53c890d50d72621ebaa72cba3214f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1NullBackend.html#a48f53c890d50d72621ebaa72cba3214f">sync</a> () override</td></tr>
|
|
<tr class="separator:a48f53c890d50d72621ebaa72cba3214f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7c5e9d556473e233e8db639f2b9f550a" id="r_a7c5e9d556473e233e8db639f2b9f550a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1NullBackend.html#a7c5e9d556473e233e8db639f2b9f550a">for_each</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/utility/functional/function.html">std::function</a>< void(<a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>< <a class="el" href="classripple_1_1NodeObject.html">NodeObject</a> >)> f) override</td></tr>
|
|
<tr class="memdesc:a7c5e9d556473e233e8db639f2b9f550a"><td class="mdescLeft"> </td><td class="mdescRight">Visit every object in the database This is usually called during import. <br /></td></tr>
|
|
<tr class="separator:a7c5e9d556473e233e8db639f2b9f550a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a05d79b53d646319b916a2cb5f664196b" id="r_a05d79b53d646319b916a2cb5f664196b"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1NullBackend.html#a05d79b53d646319b916a2cb5f664196b">getWriteLoad</a> () override</td></tr>
|
|
<tr class="memdesc:a05d79b53d646319b916a2cb5f664196b"><td class="mdescLeft"> </td><td class="mdescRight">Estimate the number of write operations pending. <br /></td></tr>
|
|
<tr class="separator:a05d79b53d646319b916a2cb5f664196b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2fea9ffddc47915211a29fac6404fb0e" id="r_a2fea9ffddc47915211a29fac6404fb0e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1NullBackend.html#a2fea9ffddc47915211a29fac6404fb0e">setDeletePath</a> () override</td></tr>
|
|
<tr class="memdesc:a2fea9ffddc47915211a29fac6404fb0e"><td class="mdescLeft"> </td><td class="mdescRight">Remove contents on disk upon destruction. <br /></td></tr>
|
|
<tr class="separator:a2fea9ffddc47915211a29fac6404fb0e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a13cce6549b2f525223a86a053d257e50" id="r_a13cce6549b2f525223a86a053d257e50"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1NullBackend.html#a13cce6549b2f525223a86a053d257e50">fdRequired</a> () const override</td></tr>
|
|
<tr class="memdesc:a13cce6549b2f525223a86a053d257e50"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of file descriptors the backend expects to need. <br /></td></tr>
|
|
<tr class="separator:a13cce6549b2f525223a86a053d257e50"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6471a9de444ac0df7c1dd102efa95854" id="r_a6471a9de444ac0df7c1dd102efa95854"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>< <a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1Backend.html#a6471a9de444ac0df7c1dd102efa95854">getBlockSize</a> () const</td></tr>
|
|
<tr class="memdesc:a6471a9de444ac0df7c1dd102efa95854"><td class="mdescLeft"> </td><td class="mdescRight">Get the block size for backends that support it. <br /></td></tr>
|
|
<tr class="separator:a6471a9de444ac0df7c1dd102efa95854"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae4e7c931c5382d31d877c6f7162dd21e" id="r_ae4e7c931c5382d31d877c6f7162dd21e"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1Backend.html#ae4e7c931c5382d31d877c6f7162dd21e">open</a> (bool createIfMissing, uint64_t appType, uint64_t uid, uint64_t salt)</td></tr>
|
|
<tr class="memdesc:ae4e7c931c5382d31d877c6f7162dd21e"><td class="mdescLeft"> </td><td class="mdescRight">Open the backend. <br /></td></tr>
|
|
<tr class="separator:ae4e7c931c5382d31d877c6f7162dd21e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afea5371bd4d7824d96f28700fa831f33" id="r_afea5371bd4d7824d96f28700fa831f33"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1Backend.html#afea5371bd4d7824d96f28700fa831f33">verify</a> ()</td></tr>
|
|
<tr class="memdesc:afea5371bd4d7824d96f28700fa831f33"><td class="mdescLeft"> </td><td class="mdescRight">Perform consistency checks on database. <br /></td></tr>
|
|
<tr class="separator:afea5371bd4d7824d96f28700fa831f33"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock">
|
|
<p class="definition">Definition at line <a class="el" href="NullFactory_8cpp_source.html#l00009">9</a> of file <a class="el" href="NullFactory_8cpp_source.html">NullFactory.cpp</a>.</p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="aab527918053781c631f7f37667d75a99" name="aab527918053781c631f7f37667d75a99"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aab527918053781c631f7f37667d75a99">◆ </a></span>NullBackend()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ripple::NodeStore::NullBackend::NullBackend </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">default</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abd909e2be8247d702aa74de2c363f5c6" name="abd909e2be8247d702aa74de2c363f5c6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abd909e2be8247d702aa74de2c363f5c6">◆ </a></span>~NullBackend()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ripple::NodeStore::NullBackend::~NullBackend </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">default</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a89c46335dae32bdda3cc2cd0d2558abf" name="a89c46335dae32bdda3cc2cd0d2558abf"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a89c46335dae32bdda3cc2cd0d2558abf">◆ </a></span>getName()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> ripple::NodeStore::NullBackend::getName </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the human-readable name of this backend. </p>
|
|
<p>This is used for diagnostic output. </p>
|
|
|
|
<p>Implements <a class="el" href="classripple_1_1NodeStore_1_1Backend.html#a206d540c4b8359c598f2309c5ee194bd">ripple::NodeStore::Backend</a>.</p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="NullFactory_8cpp_source.html#l00017">17</a> of file <a class="el" href="NullFactory_8cpp_source.html">NullFactory.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0b2c45caa5842849382a198b28687c8e" name="a0b2c45caa5842849382a198b28687c8e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0b2c45caa5842849382a198b28687c8e">◆ </a></span>open() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ripple::NodeStore::NullBackend::open </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>createIfMissing</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Open the backend. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">createIfMissing</td><td>Create the database files if necessary. This allows the caller to catch exceptions. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Implements <a class="el" href="classripple_1_1NodeStore_1_1Backend.html#a586356a9f6050201be9d184bc3fd2c83">ripple::NodeStore::Backend</a>.</p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="NullFactory_8cpp_source.html#l00023">23</a> of file <a class="el" href="NullFactory_8cpp_source.html">NullFactory.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a06edcc6548cdcac4785c1de9c3a1662f" name="a06edcc6548cdcac4785c1de9c3a1662f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a06edcc6548cdcac4785c1de9c3a1662f">◆ </a></span>isOpen()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool ripple::NodeStore::NullBackend::isOpen </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns true is the database is open. </p>
|
|
|
|
<p>Implements <a class="el" href="classripple_1_1NodeStore_1_1Backend.html#acd6ac096e54166098107227a8d168044">ripple::NodeStore::Backend</a>.</p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="NullFactory_8cpp_source.html#l00028">28</a> of file <a class="el" href="NullFactory_8cpp_source.html">NullFactory.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0269121f17ab29c92a5df0d2a035dd47" name="a0269121f17ab29c92a5df0d2a035dd47"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0269121f17ab29c92a5df0d2a035dd47">◆ </a></span>close()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ripple::NodeStore::NullBackend::close </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Close the backend. </p>
|
|
<p>This allows the caller to catch exceptions. </p>
|
|
|
|
<p>Implements <a class="el" href="classripple_1_1NodeStore_1_1Backend.html#a6b13f9a9bbf0bf6470648f4910a92dd0">ripple::NodeStore::Backend</a>.</p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="NullFactory_8cpp_source.html#l00034">34</a> of file <a class="el" href="NullFactory_8cpp_source.html">NullFactory.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1dc8a4f932bb50366f9f967e5c35cb3a" name="a1dc8a4f932bb50366f9f967e5c35cb3a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1dc8a4f932bb50366f9f967e5c35cb3a">◆ </a></span>fetch()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="namespaceripple_1_1NodeStore.html#af127c2e4fc73b5d35647147ef45b350c">Status</a> ripple::NodeStore::NullBackend::fetch </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void const * </td>
|
|
<td class="paramname"><em>key</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>< <a class="el" href="classripple_1_1NodeObject.html">NodeObject</a> > * </td>
|
|
<td class="paramname"><em>pObject</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Fetch a single object. </p>
|
|
<p>If the object is not found or an error is encountered, the result will indicate the condition. </p><dl class="section note"><dt>Note</dt><dd>This will be called concurrently. </dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">key</td><td>A pointer to the key data. </td></tr>
|
|
<tr><td class="paramname">pObject</td><td>[out] The created object if successful. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The result of the operation. </dd></dl>
|
|
|
|
<p>Implements <a class="el" href="classripple_1_1NodeStore_1_1Backend.html#a7d3224e43e89dc098962b986d70e9833">ripple::NodeStore::Backend</a>.</p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="NullFactory_8cpp_source.html#l00039">39</a> of file <a class="el" href="NullFactory_8cpp_source.html">NullFactory.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a780a94041c6b9f059f9c33e5d5780c2a" name="a780a94041c6b9f059f9c33e5d5780c2a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a780a94041c6b9f059f9c33e5d5780c2a">◆ </a></span>fetchBatch()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</a>< <a class="elRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a>< <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>< <a class="el" href="classripple_1_1NodeObject.html">NodeObject</a> > >, <a class="el" href="namespaceripple_1_1NodeStore.html#af127c2e4fc73b5d35647147ef45b350c">Status</a> > ripple::NodeStore::NullBackend::fetchBatch </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a>< <a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> const * > const & </td>
|
|
<td class="paramname"><em>hashes</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Fetch a batch synchronously. </p>
|
|
|
|
<p>Implements <a class="el" href="classripple_1_1NodeStore_1_1Backend.html#a9a651edcf0faf1fd93b105d0286015d9">ripple::NodeStore::Backend</a>.</p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="NullFactory_8cpp_source.html#l00045">45</a> of file <a class="el" href="NullFactory_8cpp_source.html">NullFactory.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad3d41ab83222e39efd5aaebf39160df8" name="ad3d41ab83222e39efd5aaebf39160df8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad3d41ab83222e39efd5aaebf39160df8">◆ </a></span>store()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ripple::NodeStore::NullBackend::store </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>< <a class="el" href="classripple_1_1NodeObject.html">NodeObject</a> > const & </td>
|
|
<td class="paramname"><em>object</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Store a single object. </p>
|
|
<p>Depending on the implementation this may happen immediately or deferred using a scheduled task. </p><dl class="section note"><dt>Note</dt><dd>This will be called concurrently. </dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">object</td><td>The object to store. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Implements <a class="el" href="classripple_1_1NodeStore_1_1Backend.html#a8862f8d96713c985c3169e57cbb260c2">ripple::NodeStore::Backend</a>.</p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="NullFactory_8cpp_source.html#l00051">51</a> of file <a class="el" href="NullFactory_8cpp_source.html">NullFactory.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac3d735a9706df0a50c08a2a737ebeb3d" name="ac3d735a9706df0a50c08a2a737ebeb3d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac3d735a9706df0a50c08a2a737ebeb3d">◆ </a></span>storeBatch()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ripple::NodeStore::NullBackend::storeBatch </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespaceripple_1_1NodeStore.html#ae0e4b79f8eb3ffa0bf8fcaf848643202">Batch</a> const & </td>
|
|
<td class="paramname"><em>batch</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Store a group of objects. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>This function will not be called concurrently with itself or <a class="el" href="classripple_1_1NodeStore_1_1NullBackend.html#ad3d41ab83222e39efd5aaebf39160df8">store</a>. </dd></dl>
|
|
|
|
<p>Implements <a class="el" href="classripple_1_1NodeStore_1_1Backend.html#acb1f22b4101841e695477646c95376a7">ripple::NodeStore::Backend</a>.</p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="NullFactory_8cpp_source.html#l00056">56</a> of file <a class="el" href="NullFactory_8cpp_source.html">NullFactory.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a48f53c890d50d72621ebaa72cba3214f" name="a48f53c890d50d72621ebaa72cba3214f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a48f53c890d50d72621ebaa72cba3214f">◆ </a></span>sync()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ripple::NodeStore::NullBackend::sync </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Implements <a class="el" href="classripple_1_1NodeStore_1_1Backend.html#a0756bdfe06dcb0382b47e23b39813394">ripple::NodeStore::Backend</a>.</p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="NullFactory_8cpp_source.html#l00061">61</a> of file <a class="el" href="NullFactory_8cpp_source.html">NullFactory.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7c5e9d556473e233e8db639f2b9f550a" name="a7c5e9d556473e233e8db639f2b9f550a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7c5e9d556473e233e8db639f2b9f550a">◆ </a></span>for_each()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ripple::NodeStore::NullBackend::for_each </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/functional/function.html">std::function</a>< void(<a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>< <a class="el" href="classripple_1_1NodeObject.html">NodeObject</a> >)> </td>
|
|
<td class="paramname"><em>f</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Visit every object in the database This is usually called during import. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>This routine will not be called concurrently with itself or other methods. </dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd>import </dd></dl>
|
|
|
|
<p>Implements <a class="el" href="classripple_1_1NodeStore_1_1Backend.html#a70721d2adc758a808d2536eee864df52">ripple::NodeStore::Backend</a>.</p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="NullFactory_8cpp_source.html#l00066">66</a> of file <a class="el" href="NullFactory_8cpp_source.html">NullFactory.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a05d79b53d646319b916a2cb5f664196b" name="a05d79b53d646319b916a2cb5f664196b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a05d79b53d646319b916a2cb5f664196b">◆ </a></span>getWriteLoad()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int ripple::NodeStore::NullBackend::getWriteLoad </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Estimate the number of write operations pending. </p>
|
|
|
|
<p>Implements <a class="el" href="classripple_1_1NodeStore_1_1Backend.html#ac4d7008b7a616ce05568da3e96a204ec">ripple::NodeStore::Backend</a>.</p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="NullFactory_8cpp_source.html#l00071">71</a> of file <a class="el" href="NullFactory_8cpp_source.html">NullFactory.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2fea9ffddc47915211a29fac6404fb0e" name="a2fea9ffddc47915211a29fac6404fb0e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2fea9ffddc47915211a29fac6404fb0e">◆ </a></span>setDeletePath()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ripple::NodeStore::NullBackend::setDeletePath </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Remove contents on disk upon destruction. </p>
|
|
|
|
<p>Implements <a class="el" href="classripple_1_1NodeStore_1_1Backend.html#a898be5251e9216eb21938e3083c2d1ef">ripple::NodeStore::Backend</a>.</p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="NullFactory_8cpp_source.html#l00077">77</a> of file <a class="el" href="NullFactory_8cpp_source.html">NullFactory.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a13cce6549b2f525223a86a053d257e50" name="a13cce6549b2f525223a86a053d257e50"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a13cce6549b2f525223a86a053d257e50">◆ </a></span>fdRequired()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int ripple::NodeStore::NullBackend::fdRequired </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the number of file descriptors the backend expects to need. </p>
|
|
|
|
<p>Implements <a class="el" href="classripple_1_1NodeStore_1_1Backend.html#a915130d326c2e63209accb8af09cf8b4">ripple::NodeStore::Backend</a>.</p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="NullFactory_8cpp_source.html#l00083">83</a> of file <a class="el" href="NullFactory_8cpp_source.html">NullFactory.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6471a9de444ac0df7c1dd102efa95854" name="a6471a9de444ac0df7c1dd102efa95854"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6471a9de444ac0df7c1dd102efa95854">◆ </a></span>getBlockSize()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>< <a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> > ripple::NodeStore::Backend::getBlockSize </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the block size for backends that support it. </p>
|
|
|
|
<p>Reimplemented in <a class="el" href="classripple_1_1NodeStore_1_1NuDBBackend.html#a7ecb3aaf359d9d5159ed350873f4de9e">ripple::NodeStore::NuDBBackend</a>.</p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Backend_8h_source.html#l00040">40</a> of file <a class="el" href="Backend_8h_source.html">Backend.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae4e7c931c5382d31d877c6f7162dd21e" name="ae4e7c931c5382d31d877c6f7162dd21e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae4e7c931c5382d31d877c6f7162dd21e">◆ </a></span>open() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void ripple::NodeStore::Backend::open </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>createIfMissing</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint64_t </td>
|
|
<td class="paramname"><em>appType</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint64_t </td>
|
|
<td class="paramname"><em>uid</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint64_t </td>
|
|
<td class="paramname"><em>salt</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Open the backend. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">createIfMissing</td><td>Create the database files if necessary. </td></tr>
|
|
<tr><td class="paramname">appType</td><td>Deterministic appType used to create a backend. </td></tr>
|
|
<tr><td class="paramname">uid</td><td>Deterministic uid used to create a backend. </td></tr>
|
|
<tr><td class="paramname">salt</td><td>Deterministic salt used to create a backend. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname"><a class="elRef" href="http://en.cppreference.com/w/cpp/error/runtime_error.html">std::runtime_error</a></td><td>is function is called not for NuDB backend. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="classripple_1_1NodeStore_1_1NuDBBackend.html#a9e494839a2dcf789bb6cdc300ad65931">ripple::NodeStore::NuDBBackend</a>.</p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Backend_8h_source.html#l00065">65</a> of file <a class="el" href="Backend_8h_source.html">Backend.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afea5371bd4d7824d96f28700fa831f33" name="afea5371bd4d7824d96f28700fa831f33"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afea5371bd4d7824d96f28700fa831f33">◆ </a></span>verify()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void ripple::NodeStore::Backend::verify </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Perform consistency checks on database. </p>
|
|
<p>This method is implemented only by <a class="el" href="classripple_1_1NodeStore_1_1NuDBBackend.html">NuDBBackend</a>. It is not yet called anywhere, but it might be a good idea to one day call it at startup to avert a crash. </p>
|
|
|
|
<p>Reimplemented in <a class="el" href="classripple_1_1NodeStore_1_1NuDBBackend.html#ab012b4ff123427bc35a5d4ac4c6269c0">ripple::NodeStore::NuDBBackend</a>.</p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Backend_8h_source.html#l00136">136</a> of file <a class="el" href="Backend_8h_source.html">Backend.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <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>
|