ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-12-02 17:06:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

deploy: 020b285808

Browse Source
This commit is contained in:
nbougalis
2020-04-15 21:15:02 +00:00
commit 4ad595bf18
12373 changed files with 1478990 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

633
classripple_1_1NodeStore_1_1Backend.html Normal file
View File

@@ -0,0 +1,633 @@
<!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: ripple::NodeStore::Backend 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 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="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_1Backend.html">Backend</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classripple_1_1NodeStore_1_1Backend-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ripple::NodeStore::Backend Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>A backend used for the <a class="el" href="namespaceripple_1_1NodeStore.html">NodeStore</a>.
<a href="classripple_1_1NodeStore_1_1Backend.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for ripple::NodeStore::Backend:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1NodeStore_1_1Backend__inherit__graph.png" border="0" usemap="#ripple_1_1NodeStore_1_1Backend_inherit__map" alt="Inheritance graph"/></div>
<map name="ripple_1_1NodeStore_1_1Backend_inherit__map" id="ripple_1_1NodeStore_1_1Backend_inherit__map">
<area shape="rect" title="A backend used for the NodeStore." alt="" coords="5,71,148,112"/>
<area shape="rect" href="classripple_1_1NodeStore_1_1MemoryBackend.html" title=" " alt="" coords="196,5,339,47"/>
<area shape="rect" href="classripple_1_1NodeStore_1_1NuDBBackend.html" title=" " alt="" coords="196,71,339,112"/>
<area shape="rect" href="classripple_1_1NodeStore_1_1NullBackend.html" title=" " alt="" coords="196,136,339,177"/>
</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 name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a7be1490e873f0a4956e4dd9effc9061b"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1Backend.html#a7be1490e873f0a4956e4dd9effc9061b">~Backend</a> ()=default</td></tr>
<tr class="memdesc:a7be1490e873f0a4956e4dd9effc9061b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroy the backend. <a href="classripple_1_1NodeStore_1_1Backend.html#a7be1490e873f0a4956e4dd9effc9061b">More...</a><br /></td></tr>
<tr class="separator:a7be1490e873f0a4956e4dd9effc9061b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a206d540c4b8359c598f2309c5ee194bd"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1Backend.html#a206d540c4b8359c598f2309c5ee194bd">getName</a> ()=0</td></tr>
<tr class="memdesc:a206d540c4b8359c598f2309c5ee194bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the human-readable name of this backend. <a href="classripple_1_1NodeStore_1_1Backend.html#a206d540c4b8359c598f2309c5ee194bd">More...</a><br /></td></tr>
<tr class="separator:a206d540c4b8359c598f2309c5ee194bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a586356a9f6050201be9d184bc3fd2c83"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1Backend.html#a586356a9f6050201be9d184bc3fd2c83">open</a> (bool createIfMissing=true)=0</td></tr>
<tr class="memdesc:a586356a9f6050201be9d184bc3fd2c83"><td class="mdescLeft">&#160;</td><td class="mdescRight">Open the backend. <a href="classripple_1_1NodeStore_1_1Backend.html#a586356a9f6050201be9d184bc3fd2c83">More...</a><br /></td></tr>
<tr class="separator:a586356a9f6050201be9d184bc3fd2c83"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6b13f9a9bbf0bf6470648f4910a92dd0"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1Backend.html#a6b13f9a9bbf0bf6470648f4910a92dd0">close</a> ()=0</td></tr>
<tr class="memdesc:a6b13f9a9bbf0bf6470648f4910a92dd0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Close the backend. <a href="classripple_1_1NodeStore_1_1Backend.html#a6b13f9a9bbf0bf6470648f4910a92dd0">More...</a><br /></td></tr>
<tr class="separator:a6b13f9a9bbf0bf6470648f4910a92dd0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7d3224e43e89dc098962b986d70e9833"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceripple_1_1NodeStore.html#af127c2e4fc73b5d35647147ef45b350c">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1Backend.html#a7d3224e43e89dc098962b986d70e9833">fetch</a> (void const *key, <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; <a class="el" href="classripple_1_1NodeObject.html">NodeObject</a> &gt; *pObject)=0</td></tr>
<tr class="memdesc:a7d3224e43e89dc098962b986d70e9833"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fetch a single object. <a href="classripple_1_1NodeStore_1_1Backend.html#a7d3224e43e89dc098962b986d70e9833">More...</a><br /></td></tr>
<tr class="separator:a7d3224e43e89dc098962b986d70e9833"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a26ec003b54dcceb03af5de57ddb5e545"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1Backend.html#a26ec003b54dcceb03af5de57ddb5e545">canFetchBatch</a> ()=0</td></tr>
<tr class="memdesc:a26ec003b54dcceb03af5de57ddb5e545"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return <code>true</code> if batch fetches are optimized. <a href="classripple_1_1NodeStore_1_1Backend.html#a26ec003b54dcceb03af5de57ddb5e545">More...</a><br /></td></tr>
<tr class="separator:a26ec003b54dcceb03af5de57ddb5e545"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae5c85e156a44b8b13040ecafab65976a"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a>&lt; <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; <a class="el" href="classripple_1_1NodeObject.html">NodeObject</a> &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1Backend.html#ae5c85e156a44b8b13040ecafab65976a">fetchBatch</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> n, void const *const *keys)=0</td></tr>
<tr class="memdesc:ae5c85e156a44b8b13040ecafab65976a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fetch a batch synchronously. <a href="classripple_1_1NodeStore_1_1Backend.html#ae5c85e156a44b8b13040ecafab65976a">More...</a><br /></td></tr>
<tr class="separator:ae5c85e156a44b8b13040ecafab65976a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8862f8d96713c985c3169e57cbb260c2"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1Backend.html#a8862f8d96713c985c3169e57cbb260c2">store</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; <a class="el" href="classripple_1_1NodeObject.html">NodeObject</a> &gt; const &amp;object)=0</td></tr>
<tr class="memdesc:a8862f8d96713c985c3169e57cbb260c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Store a single object. <a href="classripple_1_1NodeStore_1_1Backend.html#a8862f8d96713c985c3169e57cbb260c2">More...</a><br /></td></tr>
<tr class="separator:a8862f8d96713c985c3169e57cbb260c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acb1f22b4101841e695477646c95376a7"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1Backend.html#acb1f22b4101841e695477646c95376a7">storeBatch</a> (<a class="el" href="namespaceripple_1_1NodeStore.html#a2035849d05d9a48d9069f810a5eeda41">Batch</a> const &amp;batch)=0</td></tr>
<tr class="memdesc:acb1f22b4101841e695477646c95376a7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Store a group of objects. <a href="classripple_1_1NodeStore_1_1Backend.html#acb1f22b4101841e695477646c95376a7">More...</a><br /></td></tr>
<tr class="separator:acb1f22b4101841e695477646c95376a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a70721d2adc758a808d2536eee864df52"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1Backend.html#a70721d2adc758a808d2536eee864df52">for_each</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/utility/functional/function.html">std::function</a>&lt; void(<a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; <a class="el" href="classripple_1_1NodeObject.html">NodeObject</a> &gt;)&gt; f)=0</td></tr>
<tr class="memdesc:a70721d2adc758a808d2536eee864df52"><td class="mdescLeft">&#160;</td><td class="mdescRight">Visit every object in the database This is usually called during import. <a href="classripple_1_1NodeStore_1_1Backend.html#a70721d2adc758a808d2536eee864df52">More...</a><br /></td></tr>
<tr class="separator:a70721d2adc758a808d2536eee864df52"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac4d7008b7a616ce05568da3e96a204ec"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1Backend.html#ac4d7008b7a616ce05568da3e96a204ec">getWriteLoad</a> ()=0</td></tr>
<tr class="memdesc:ac4d7008b7a616ce05568da3e96a204ec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Estimate the number of write operations pending. <a href="classripple_1_1NodeStore_1_1Backend.html#ac4d7008b7a616ce05568da3e96a204ec">More...</a><br /></td></tr>
<tr class="separator:ac4d7008b7a616ce05568da3e96a204ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a898be5251e9216eb21938e3083c2d1ef"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1Backend.html#a898be5251e9216eb21938e3083c2d1ef">setDeletePath</a> ()=0</td></tr>
<tr class="memdesc:a898be5251e9216eb21938e3083c2d1ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Remove contents on disk upon destruction. <a href="classripple_1_1NodeStore_1_1Backend.html#a898be5251e9216eb21938e3083c2d1ef">More...</a><br /></td></tr>
<tr class="separator:a898be5251e9216eb21938e3083c2d1ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad2c3057545b73aee8e671f127b0ae084"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1Backend.html#ad2c3057545b73aee8e671f127b0ae084">verify</a> ()=0</td></tr>
<tr class="memdesc:ad2c3057545b73aee8e671f127b0ae084"><td class="mdescLeft">&#160;</td><td class="mdescRight">Perform consistency checks on database. <a href="classripple_1_1NodeStore_1_1Backend.html#ad2c3057545b73aee8e671f127b0ae084">More...</a><br /></td></tr>
<tr class="separator:ad2c3057545b73aee8e671f127b0ae084"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a915130d326c2e63209accb8af09cf8b4"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1Backend.html#a915130d326c2e63209accb8af09cf8b4">fdRequired</a> () const =0</td></tr>
<tr class="memdesc:a915130d326c2e63209accb8af09cf8b4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the number of file descriptors the backend expects to need. <a href="classripple_1_1NodeStore_1_1Backend.html#a915130d326c2e63209accb8af09cf8b4">More...</a><br /></td></tr>
<tr class="separator:a915130d326c2e63209accb8af09cf8b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab07382d1cbb7d39fe7aacdbc17654861"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1Backend.html#ab07382d1cbb7d39fe7aacdbc17654861">backed</a> () const</td></tr>
<tr class="memdesc:ab07382d1cbb7d39fe7aacdbc17654861"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if the backend uses permanent storage. <a href="classripple_1_1NodeStore_1_1Backend.html#ab07382d1cbb7d39fe7aacdbc17654861">More...</a><br /></td></tr>
<tr class="separator:ab07382d1cbb7d39fe7aacdbc17654861"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A backend used for the <a class="el" href="namespaceripple_1_1NodeStore.html">NodeStore</a>. </p>
<p>The <a class="el" href="namespaceripple_1_1NodeStore.html">NodeStore</a> uses a swappable backend so that other database systems can be tried. Different databases may offer various features such as improved performance, fault tolerant or distributed storage, or all in-memory operation.</p>
<p>A given instance of a backend is fixed to a particular key size. </p>
<p class="definition">Definition at line <a class="el" href="Backend_8h_source.html#l00037">37</a> of file <a class="el" href="Backend_8h_source.html">Backend.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a7be1490e873f0a4956e4dd9effc9061b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7be1490e873f0a4956e4dd9effc9061b">&#9670;&nbsp;</a></span>~Backend()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual ripple::NodeStore::Backend::~Backend </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">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroy the backend. </p>
<p>All open files are closed and flushed. If there are batched writes or other tasks scheduled, they will be completed before this call returns. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a206d540c4b8359c598f2309c5ee194bd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a206d540c4b8359c598f2309c5ee194bd">&#9670;&nbsp;</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">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> ripple::NodeStore::Backend::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">pure 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>Implemented in <a class="el" href="classripple_1_1NodeStore_1_1MemoryBackend.html#a6c8bde126310dfbe7837ebdcc43b3bd2">ripple::NodeStore::MemoryBackend</a>, <a class="el" href="classripple_1_1NodeStore_1_1NuDBBackend.html#a973bd1539e909dcc515980e7b6f61f3d">ripple::NodeStore::NuDBBackend</a>, and <a class="el" href="classripple_1_1NodeStore_1_1NullBackend.html#a89c46335dae32bdda3cc2cd0d2558abf">ripple::NodeStore::NullBackend</a>.</p>
</div>
</div>
<a id="a586356a9f6050201be9d184bc3fd2c83"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a586356a9f6050201be9d184bc3fd2c83">&#9670;&nbsp;</a></span>open()</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&#160;</td>
<td class="paramname"><em>createIfMissing</em> = <code>true</code></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure 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>Implemented in <a class="el" href="classripple_1_1NodeStore_1_1MemoryBackend.html#a4e5920f4c51902aef93021277aa8ab37">ripple::NodeStore::MemoryBackend</a>, <a class="el" href="classripple_1_1NodeStore_1_1NuDBBackend.html#a2160cbce008b1fd13e1797d81d989128">ripple::NodeStore::NuDBBackend</a>, and <a class="el" href="classripple_1_1NodeStore_1_1NullBackend.html#a0b2c45caa5842849382a198b28687c8e">ripple::NodeStore::NullBackend</a>.</p>
</div>
</div>
<a id="a6b13f9a9bbf0bf6470648f4910a92dd0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6b13f9a9bbf0bf6470648f4910a92dd0">&#9670;&nbsp;</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">virtual void ripple::NodeStore::Backend::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">pure 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>Implemented in <a class="el" href="classripple_1_1NodeStore_1_1NuDBBackend.html#a336d7fe747c73366bec1cf42c5e05b67">ripple::NodeStore::NuDBBackend</a>, <a class="el" href="classripple_1_1NodeStore_1_1MemoryBackend.html#a0a629815bc2dfa046866f0b28dea0887">ripple::NodeStore::MemoryBackend</a>, and <a class="el" href="classripple_1_1NodeStore_1_1NullBackend.html#a0269121f17ab29c92a5df0d2a035dd47">ripple::NodeStore::NullBackend</a>.</p>
</div>
</div>
<a id="a7d3224e43e89dc098962b986d70e9833"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7d3224e43e89dc098962b986d70e9833">&#9670;&nbsp;</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">virtual <a class="el" href="namespaceripple_1_1NodeStore.html#af127c2e4fc73b5d35647147ef45b350c">Status</a> ripple::NodeStore::Backend::fetch </td>
<td>(</td>
<td class="paramtype">void const *&#160;</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>&lt; <a class="el" href="classripple_1_1NodeObject.html">NodeObject</a> &gt; *&#160;</td>
<td class="paramname"><em>pObject</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure 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>Implemented in <a class="el" href="classripple_1_1NodeStore_1_1MemoryBackend.html#ad1c41ea346dc8b8202fd05f67349735c">ripple::NodeStore::MemoryBackend</a>, <a class="el" href="classripple_1_1NodeStore_1_1NuDBBackend.html#a1b03edf356922e780fe41987476f1f6a">ripple::NodeStore::NuDBBackend</a>, and <a class="el" href="classripple_1_1NodeStore_1_1NullBackend.html#a1dc8a4f932bb50366f9f967e5c35cb3a">ripple::NodeStore::NullBackend</a>.</p>
</div>
</div>
<a id="a26ec003b54dcceb03af5de57ddb5e545"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a26ec003b54dcceb03af5de57ddb5e545">&#9670;&nbsp;</a></span>canFetchBatch()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool ripple::NodeStore::Backend::canFetchBatch </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return <code>true</code> if batch fetches are optimized. </p>
<p>Implemented in <a class="el" href="classripple_1_1NodeStore_1_1NuDBBackend.html#a727c895f6364eeaa8e524c1eb456f5df">ripple::NodeStore::NuDBBackend</a>, <a class="el" href="classripple_1_1NodeStore_1_1MemoryBackend.html#a99df01b9966c50d586f55f841d7226b6">ripple::NodeStore::MemoryBackend</a>, and <a class="el" href="classripple_1_1NodeStore_1_1NullBackend.html#a131e97c3f271a6433b8c70802b1d134b">ripple::NodeStore::NullBackend</a>.</p>
</div>
</div>
<a id="ae5c85e156a44b8b13040ecafab65976a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae5c85e156a44b8b13040ecafab65976a">&#9670;&nbsp;</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">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a>&lt;<a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt;<a class="el" href="classripple_1_1NodeObject.html">NodeObject</a>&gt; &gt; ripple::NodeStore::Backend::fetchBatch </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a>&#160;</td>
<td class="paramname"><em>n</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void const *const *&#160;</td>
<td class="paramname"><em>keys</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Fetch a batch synchronously. </p>
<p>Implemented in <a class="el" href="classripple_1_1NodeStore_1_1NuDBBackend.html#a2e04de763e8f9767b4404605e4f8e749">ripple::NodeStore::NuDBBackend</a>, <a class="el" href="classripple_1_1NodeStore_1_1MemoryBackend.html#a695be0ff463e8135f7b117f5d37c269d">ripple::NodeStore::MemoryBackend</a>, and <a class="el" href="classripple_1_1NodeStore_1_1NullBackend.html#a9357907a24a837c8c59ef5edc8f7b4b8">ripple::NodeStore::NullBackend</a>.</p>
</div>
</div>
<a id="a8862f8d96713c985c3169e57cbb260c2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8862f8d96713c985c3169e57cbb260c2">&#9670;&nbsp;</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">virtual void ripple::NodeStore::Backend::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>&lt; <a class="el" href="classripple_1_1NodeObject.html">NodeObject</a> &gt; const &amp;&#160;</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">pure 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>Implemented in <a class="el" href="classripple_1_1NodeStore_1_1MemoryBackend.html#a40130939ef641571abf616a970d63957">ripple::NodeStore::MemoryBackend</a>, <a class="el" href="classripple_1_1NodeStore_1_1NullBackend.html#ad3d41ab83222e39efd5aaebf39160df8">ripple::NodeStore::NullBackend</a>, and <a class="el" href="classripple_1_1NodeStore_1_1NuDBBackend.html#a00c5d2a5073f3318fc0e52f255a1c212">ripple::NodeStore::NuDBBackend</a>.</p>
</div>
</div>
<a id="acb1f22b4101841e695477646c95376a7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acb1f22b4101841e695477646c95376a7">&#9670;&nbsp;</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">virtual void ripple::NodeStore::Backend::storeBatch </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceripple_1_1NodeStore.html#a2035849d05d9a48d9069f810a5eeda41">Batch</a> const &amp;&#160;</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">pure 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_1Backend.html#a8862f8d96713c985c3169e57cbb260c2">store</a>. </dd></dl>
<p>Implemented in <a class="el" href="classripple_1_1NodeStore_1_1NuDBBackend.html#a4e9abc2a44a3501131709dcd6d5c509a">ripple::NodeStore::NuDBBackend</a>, <a class="el" href="classripple_1_1NodeStore_1_1MemoryBackend.html#ab677b7560cd27c159ad78e1412513d5f">ripple::NodeStore::MemoryBackend</a>, and <a class="el" href="classripple_1_1NodeStore_1_1NullBackend.html#ac3d735a9706df0a50c08a2a737ebeb3d">ripple::NodeStore::NullBackend</a>.</p>
</div>
</div>
<a id="a70721d2adc758a808d2536eee864df52"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a70721d2adc758a808d2536eee864df52">&#9670;&nbsp;</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">virtual void ripple::NodeStore::Backend::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>&lt; void(<a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; <a class="el" href="classripple_1_1NodeObject.html">NodeObject</a> &gt;)&gt;&#160;</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">pure 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>Implemented in <a class="el" href="classripple_1_1NodeStore_1_1NuDBBackend.html#abaf0ba251ee000601135df13dd885dca">ripple::NodeStore::NuDBBackend</a>, <a class="el" href="classripple_1_1NodeStore_1_1MemoryBackend.html#aa6f448cbec37beaa817905fe441c511c">ripple::NodeStore::MemoryBackend</a>, and <a class="el" href="classripple_1_1NodeStore_1_1NullBackend.html#a7c5e9d556473e233e8db639f2b9f550a">ripple::NodeStore::NullBackend</a>.</p>
</div>
</div>
<a id="ac4d7008b7a616ce05568da3e96a204ec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac4d7008b7a616ce05568da3e96a204ec">&#9670;&nbsp;</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">virtual int ripple::NodeStore::Backend::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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Estimate the number of write operations pending. </p>
<p>Implemented in <a class="el" href="classripple_1_1NodeStore_1_1NuDBBackend.html#adf8b3a8b6f911845a8323cc00c0aeff0">ripple::NodeStore::NuDBBackend</a>, <a class="el" href="classripple_1_1NodeStore_1_1MemoryBackend.html#ab56c3ec0fd054251bfe27125a9092973">ripple::NodeStore::MemoryBackend</a>, and <a class="el" href="classripple_1_1NodeStore_1_1NullBackend.html#a05d79b53d646319b916a2cb5f664196b">ripple::NodeStore::NullBackend</a>.</p>
</div>
</div>
<a id="a898be5251e9216eb21938e3083c2d1ef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a898be5251e9216eb21938e3083c2d1ef">&#9670;&nbsp;</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">virtual void ripple::NodeStore::Backend::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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Remove contents on disk upon destruction. </p>
<p>Implemented in <a class="el" href="classripple_1_1NodeStore_1_1NuDBBackend.html#ae6cf1bca8633f03532a5836b959adc60">ripple::NodeStore::NuDBBackend</a>, <a class="el" href="classripple_1_1NodeStore_1_1MemoryBackend.html#ac0e6ebc55d43139af9a26254ed736609">ripple::NodeStore::MemoryBackend</a>, and <a class="el" href="classripple_1_1NodeStore_1_1NullBackend.html#a2fea9ffddc47915211a29fac6404fb0e">ripple::NodeStore::NullBackend</a>.</p>
</div>
</div>
<a id="ad2c3057545b73aee8e671f127b0ae084"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad2c3057545b73aee8e671f127b0ae084">&#9670;&nbsp;</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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Perform consistency checks on database. </p>
<p>Implemented in <a class="el" href="classripple_1_1NodeStore_1_1NuDBBackend.html#ab012b4ff123427bc35a5d4ac4c6269c0">ripple::NodeStore::NuDBBackend</a>, <a class="el" href="classripple_1_1NodeStore_1_1MemoryBackend.html#afdb01acdec79cb170a57136e4dcc6e89">ripple::NodeStore::MemoryBackend</a>, and <a class="el" href="classripple_1_1NodeStore_1_1NullBackend.html#a63fb9ed5cfcd1285e0780e19c161a248">ripple::NodeStore::NullBackend</a>.</p>
</div>
</div>
<a id="a915130d326c2e63209accb8af09cf8b4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a915130d326c2e63209accb8af09cf8b4">&#9670;&nbsp;</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">virtual int ripple::NodeStore::Backend::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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the number of file descriptors the backend expects to need. </p>
<p>Implemented in <a class="el" href="classripple_1_1NodeStore_1_1NuDBBackend.html#a80ceb104dfe540399ddb1fe8d43111ac">ripple::NodeStore::NuDBBackend</a>, <a class="el" href="classripple_1_1NodeStore_1_1MemoryBackend.html#ad11105242d588bfd1c07bf7d3d729790">ripple::NodeStore::MemoryBackend</a>, and <a class="el" href="classripple_1_1NodeStore_1_1NullBackend.html#a13cce6549b2f525223a86a053d257e50">ripple::NodeStore::NullBackend</a>.</p>
</div>
</div>
<a id="ab07382d1cbb7d39fe7aacdbc17654861"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab07382d1cbb7d39fe7aacdbc17654861">&#9670;&nbsp;</a></span>backed()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ripple::NodeStore::Backend::backed </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if the backend uses permanent storage. </p>
<p class="definition">Definition at line <a class="el" href="Backend_8h_source.html#l00120">120</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 &#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>