mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-20 19:15:54 +00:00
956 lines
55 KiB
HTML
956 lines
55 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::MemoryBackend 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_1MemoryBackend.html">MemoryBackend</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pri-types">Private Types</a> |
|
|
<a href="#pri-attribs">Private Attributes</a> |
|
|
<a href="classripple_1_1NodeStore_1_1MemoryBackend-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">ripple::NodeStore::MemoryBackend Class Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="dynheader">
|
|
Inheritance diagram for ripple::NodeStore::MemoryBackend:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classripple_1_1NodeStore_1_1MemoryBackend__inherit__graph.png" border="0" usemap="#aripple_1_1NodeStore_1_1MemoryBackend_inherit__map" alt="Inheritance graph"/></div>
|
|
<map name="aripple_1_1NodeStore_1_1MemoryBackend_inherit__map" id="aripple_1_1NodeStore_1_1MemoryBackend_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::MemoryBackend:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classripple_1_1NodeStore_1_1MemoryBackend__coll__graph.png" border="0" usemap="#aripple_1_1NodeStore_1_1MemoryBackend_coll__map" alt="Collaboration graph"/></div>
|
|
<map name="aripple_1_1NodeStore_1_1MemoryBackend_coll__map" id="aripple_1_1NodeStore_1_1MemoryBackend_coll__map">
|
|
<area shape="rect" title=" " alt="" coords="1835,87,1977,127"/>
|
|
<area shape="rect" href="classripple_1_1NodeStore_1_1Backend.html" title="A backend used for the NodeStore." alt="" coords="1587,5,1729,45"/>
|
|
<area shape="poly" title=" " alt="" coords="1738,47,1812,71,1850,84,1848,89,1810,76,1736,52"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title=" " alt="" coords="1615,70,1701,95"/>
|
|
<area shape="poly" title=" " alt="" coords="1715,85,1835,97,1834,102,1715,91"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title=" " alt="" coords="1311,56,1449,96"/>
|
|
<area shape="poly" title=" " alt="" coords="1463,75,1615,79,1615,84,1463,81"/>
|
|
<area shape="rect" href="classbeast_1_1Journal.html" title="A generic endpoint for log messages." alt="" coords="1603,119,1713,145"/>
|
|
<area shape="poly" title=" " alt="" coords="1727,123,1810,115,1834,112,1835,117,1811,120,1727,128"/>
|
|
<area shape="rect" href="classbeast_1_1Journal_1_1Sink.html" title="Abstraction for the underlying message destination." alt="" coords="1307,121,1453,146"/>
|
|
<area shape="poly" title=" " alt="" coords="1467,130,1603,130,1603,135,1467,136"/>
|
|
<area shape="rect" href="structripple_1_1NodeStore_1_1MemoryDB.html" title=" " alt="" coords="1587,169,1729,209"/>
|
|
<area shape="poly" title=" " alt="" coords="1742,163,1810,141,1855,124,1857,129,1812,147,1743,168"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/thread/mutex.html" title=" " alt="" coords="1334,174,1426,199"/>
|
|
<area shape="poly" title=" " alt="" coords="1440,185,1587,186,1587,191,1440,190"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/map.html" title=" " alt="" coords="1273,223,1487,278"/>
|
|
<area shape="poly" title=" " alt="" coords="1499,222,1586,202,1587,208,1501,227"/>
|
|
<area shape="rect" href="classripple_1_1base__uint.html" title="Integers of any length that is a multiple of 32-bits." alt="" coords="513,212,655,252"/>
|
|
<area shape="poly" title=" " alt="" coords="669,230,1249,243,1273,243,1273,249,1249,248,669,236"/>
|
|
<area shape="rect" href="classripple_1_1NodeObject.html" title="A simple object that the Ledger uses to store entries." alt="" coords="764,289,907,314"/>
|
|
<area shape="poly" title=" " alt="" coords="669,253,789,286,788,291,668,258"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/size_t.html" title=" " alt="" coords="261,266,349,291"/>
|
|
<area shape="poly" title=" " alt="" coords="362,269,478,251,512,244,513,250,479,256,363,274"/>
|
|
<area shape="poly" title=" " alt="" coords="363,278,764,296,764,301,363,284"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/array.html" title=" " alt="" coords="221,177,389,217"/>
|
|
<area shape="poly" title=" " alt="" coords="403,207,513,221,513,226,403,212"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="5,185,108,210"/>
|
|
<area shape="poly" title=" " alt="" coords="122,195,221,195,221,200,122,200"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html" title=" " alt="" coords="989,265,1160,305"/>
|
|
<area shape="poly" title=" " alt="" coords="1173,271,1273,260,1274,265,1174,277"/>
|
|
<area shape="poly" title=" " alt="" coords="920,293,989,288,989,294,921,298"/>
|
|
<area shape="rect" href="classripple_1_1CountedObject.html" title=" " alt="" coords="503,400,665,440"/>
|
|
<area shape="poly" title=" " alt="" coords="649,392,664,386,745,346,810,312,812,317,747,351,666,390,651,397"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/vector.html" title=" " alt="" coords="519,350,649,375"/>
|
|
<area shape="poly" title=" " alt="" coords="661,349,739,332,801,312,803,317,741,337,662,354"/>
|
|
<area shape="rect" title=" " alt="" coords="286,350,325,375"/>
|
|
<area shape="poly" title=" " alt="" coords="338,360,519,360,519,365,338,365"/>
|
|
</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:aa0d4dfe4f3c07c9fcecbb9e4dc06138d" id="r_aa0d4dfe4f3c07c9fcecbb9e4dc06138d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1MemoryBackend.html#aa0d4dfe4f3c07c9fcecbb9e4dc06138d">MemoryBackend</a> (size_t keyBytes, <a class="el" href="classripple_1_1Section.html">Section</a> const &keyValues, <a class="el" href="classbeast_1_1Journal.html">beast::Journal</a> journal)</td></tr>
|
|
<tr class="separator:aa0d4dfe4f3c07c9fcecbb9e4dc06138d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7a3395d78b5b2cf470059c43e0d8817a" id="r_a7a3395d78b5b2cf470059c43e0d8817a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1MemoryBackend.html#a7a3395d78b5b2cf470059c43e0d8817a">~MemoryBackend</a> () override</td></tr>
|
|
<tr class="separator:a7a3395d78b5b2cf470059c43e0d8817a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6c8bde126310dfbe7837ebdcc43b3bd2" id="r_a6c8bde126310dfbe7837ebdcc43b3bd2"><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_1MemoryBackend.html#a6c8bde126310dfbe7837ebdcc43b3bd2">getName</a> () override</td></tr>
|
|
<tr class="memdesc:a6c8bde126310dfbe7837ebdcc43b3bd2"><td class="mdescLeft"> </td><td class="mdescRight">Get the human-readable name of this backend. <br /></td></tr>
|
|
<tr class="separator:a6c8bde126310dfbe7837ebdcc43b3bd2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abb497e11a012f1a4e9986f8a5886f659" id="r_abb497e11a012f1a4e9986f8a5886f659"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1MemoryBackend.html#abb497e11a012f1a4e9986f8a5886f659">open</a> (bool) override</td></tr>
|
|
<tr class="memdesc:abb497e11a012f1a4e9986f8a5886f659"><td class="mdescLeft"> </td><td class="mdescRight">Open the backend. <br /></td></tr>
|
|
<tr class="separator:abb497e11a012f1a4e9986f8a5886f659"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ada78f1edc055747acbcd9b0da846d743" id="r_ada78f1edc055747acbcd9b0da846d743"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1MemoryBackend.html#ada78f1edc055747acbcd9b0da846d743">isOpen</a> () override</td></tr>
|
|
<tr class="memdesc:ada78f1edc055747acbcd9b0da846d743"><td class="mdescLeft"> </td><td class="mdescRight">Returns true is the database is open. <br /></td></tr>
|
|
<tr class="separator:ada78f1edc055747acbcd9b0da846d743"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0a629815bc2dfa046866f0b28dea0887" id="r_a0a629815bc2dfa046866f0b28dea0887"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1MemoryBackend.html#a0a629815bc2dfa046866f0b28dea0887">close</a> () override</td></tr>
|
|
<tr class="memdesc:a0a629815bc2dfa046866f0b28dea0887"><td class="mdescLeft"> </td><td class="mdescRight">Close the backend. <br /></td></tr>
|
|
<tr class="separator:a0a629815bc2dfa046866f0b28dea0887"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad1c41ea346dc8b8202fd05f67349735c" id="r_ad1c41ea346dc8b8202fd05f67349735c"><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_1MemoryBackend.html#ad1c41ea346dc8b8202fd05f67349735c">fetch</a> (void const *key, <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> > *pObject) override</td></tr>
|
|
<tr class="memdesc:ad1c41ea346dc8b8202fd05f67349735c"><td class="mdescLeft"> </td><td class="mdescRight">Fetch a single object. <br /></td></tr>
|
|
<tr class="separator:ad1c41ea346dc8b8202fd05f67349735c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a914efe50059a9990c60e592a27bbad66" id="r_a914efe50059a9990c60e592a27bbad66"><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_1MemoryBackend.html#a914efe50059a9990c60e592a27bbad66">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:a914efe50059a9990c60e592a27bbad66"><td class="mdescLeft"> </td><td class="mdescRight">Fetch a batch synchronously. <br /></td></tr>
|
|
<tr class="separator:a914efe50059a9990c60e592a27bbad66"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a40130939ef641571abf616a970d63957" id="r_a40130939ef641571abf616a970d63957"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1MemoryBackend.html#a40130939ef641571abf616a970d63957">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:a40130939ef641571abf616a970d63957"><td class="mdescLeft"> </td><td class="mdescRight">Store a single object. <br /></td></tr>
|
|
<tr class="separator:a40130939ef641571abf616a970d63957"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab677b7560cd27c159ad78e1412513d5f" id="r_ab677b7560cd27c159ad78e1412513d5f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1MemoryBackend.html#ab677b7560cd27c159ad78e1412513d5f">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:ab677b7560cd27c159ad78e1412513d5f"><td class="mdescLeft"> </td><td class="mdescRight">Store a group of objects. <br /></td></tr>
|
|
<tr class="separator:ab677b7560cd27c159ad78e1412513d5f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7a01b5df53b3ca0487785188f98b4320" id="r_a7a01b5df53b3ca0487785188f98b4320"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1MemoryBackend.html#a7a01b5df53b3ca0487785188f98b4320">sync</a> () override</td></tr>
|
|
<tr class="separator:a7a01b5df53b3ca0487785188f98b4320"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa6f448cbec37beaa817905fe441c511c" id="r_aa6f448cbec37beaa817905fe441c511c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1MemoryBackend.html#aa6f448cbec37beaa817905fe441c511c">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:aa6f448cbec37beaa817905fe441c511c"><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:aa6f448cbec37beaa817905fe441c511c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab56c3ec0fd054251bfe27125a9092973" id="r_ab56c3ec0fd054251bfe27125a9092973"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1MemoryBackend.html#ab56c3ec0fd054251bfe27125a9092973">getWriteLoad</a> () override</td></tr>
|
|
<tr class="memdesc:ab56c3ec0fd054251bfe27125a9092973"><td class="mdescLeft"> </td><td class="mdescRight">Estimate the number of write operations pending. <br /></td></tr>
|
|
<tr class="separator:ab56c3ec0fd054251bfe27125a9092973"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac0e6ebc55d43139af9a26254ed736609" id="r_ac0e6ebc55d43139af9a26254ed736609"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1MemoryBackend.html#ac0e6ebc55d43139af9a26254ed736609">setDeletePath</a> () override</td></tr>
|
|
<tr class="memdesc:ac0e6ebc55d43139af9a26254ed736609"><td class="mdescLeft"> </td><td class="mdescRight">Remove contents on disk upon destruction. <br /></td></tr>
|
|
<tr class="separator:ac0e6ebc55d43139af9a26254ed736609"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad11105242d588bfd1c07bf7d3d729790" id="r_ad11105242d588bfd1c07bf7d3d729790"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1MemoryBackend.html#ad11105242d588bfd1c07bf7d3d729790">fdRequired</a> () const override</td></tr>
|
|
<tr class="memdesc:ad11105242d588bfd1c07bf7d3d729790"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of file descriptors the backend expects to need. <br /></td></tr>
|
|
<tr class="separator:ad11105242d588bfd1c07bf7d3d729790"><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><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-types" name="pri-types"></a>
|
|
Private Types</h2></td></tr>
|
|
<tr class="memitem:a157d4f5773b131ea06360784e967b7f0" id="r_a157d4f5773b131ea06360784e967b7f0"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1MemoryBackend.html#a157d4f5773b131ea06360784e967b7f0">Map</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/container/map.html">std::map</a>< <a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> 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> > ></td></tr>
|
|
<tr class="separator:a157d4f5773b131ea06360784e967b7f0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
|
|
Private Attributes</h2></td></tr>
|
|
<tr class="memitem:a68db5737a6a61f08b0057c6feda9a60e" id="r_a68db5737a6a61f08b0057c6feda9a60e"><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_1MemoryBackend.html#a68db5737a6a61f08b0057c6feda9a60e">name_</a></td></tr>
|
|
<tr class="separator:a68db5737a6a61f08b0057c6feda9a60e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adec6e97b302a511fc1c84e424f3da022" id="r_adec6e97b302a511fc1c84e424f3da022"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classbeast_1_1Journal.html">beast::Journal</a> const </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1MemoryBackend.html#adec6e97b302a511fc1c84e424f3da022">journal_</a></td></tr>
|
|
<tr class="separator:adec6e97b302a511fc1c84e424f3da022"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af8168c72040c7f20f427b44f9794944f" id="r_af8168c72040c7f20f427b44f9794944f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structripple_1_1NodeStore_1_1MemoryDB.html">MemoryDB</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1MemoryBackend.html#af8168c72040c7f20f427b44f9794944f">db_</a> {nullptr}</td></tr>
|
|
<tr class="separator:af8168c72040c7f20f427b44f9794944f"><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="MemoryFactory_8cpp_source.html#l00069">69</a> of file <a class="el" href="MemoryFactory_8cpp_source.html">MemoryFactory.cpp</a>.</p>
|
|
</div><h2 class="groupheader">Member Typedef Documentation</h2>
|
|
<a id="a157d4f5773b131ea06360784e967b7f0" name="a157d4f5773b131ea06360784e967b7f0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a157d4f5773b131ea06360784e967b7f0">◆ </a></span>Map</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="classripple_1_1NodeStore_1_1MemoryBackend.html#a157d4f5773b131ea06360784e967b7f0">ripple::NodeStore::MemoryBackend::Map</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/container/map.html">std::map</a><<a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> 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>> ></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="MemoryFactory_8cpp_source.html#l00072">72</a> of file <a class="el" href="MemoryFactory_8cpp_source.html">MemoryFactory.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="aa0d4dfe4f3c07c9fcecbb9e4dc06138d" name="aa0d4dfe4f3c07c9fcecbb9e4dc06138d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa0d4dfe4f3c07c9fcecbb9e4dc06138d">◆ </a></span>MemoryBackend()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ripple::NodeStore::MemoryBackend::MemoryBackend </td>
|
|
<td>(</td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>keyBytes</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1Section.html">Section</a> const & </td>
|
|
<td class="paramname"><em>keyValues</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classbeast_1_1Journal.html">beast::Journal</a> </td>
|
|
<td class="paramname"><em>journal</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="MemoryFactory_8cpp_source.html#l00079">79</a> of file <a class="el" href="MemoryFactory_8cpp_source.html">MemoryFactory.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7a3395d78b5b2cf470059c43e0d8817a" name="a7a3395d78b5b2cf470059c43e0d8817a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7a3395d78b5b2cf470059c43e0d8817a">◆ </a></span>~MemoryBackend()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ripple::NodeStore::MemoryBackend::~MemoryBackend </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> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="MemoryFactory_8cpp_source.html#l00090">90</a> of file <a class="el" href="MemoryFactory_8cpp_source.html">MemoryFactory.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a6c8bde126310dfbe7837ebdcc43b3bd2" name="a6c8bde126310dfbe7837ebdcc43b3bd2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6c8bde126310dfbe7837ebdcc43b3bd2">◆ </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::MemoryBackend::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="MemoryFactory_8cpp_source.html#l00096">96</a> of file <a class="el" href="MemoryFactory_8cpp_source.html">MemoryFactory.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abb497e11a012f1a4e9986f8a5886f659" name="abb497e11a012f1a4e9986f8a5886f659"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abb497e11a012f1a4e9986f8a5886f659">◆ </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::MemoryBackend::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="MemoryFactory_8cpp_source.html#l00102">102</a> of file <a class="el" href="MemoryFactory_8cpp_source.html">MemoryFactory.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ada78f1edc055747acbcd9b0da846d743" name="ada78f1edc055747acbcd9b0da846d743"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ada78f1edc055747acbcd9b0da846d743">◆ </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::MemoryBackend::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="MemoryFactory_8cpp_source.html#l00108">108</a> of file <a class="el" href="MemoryFactory_8cpp_source.html">MemoryFactory.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0a629815bc2dfa046866f0b28dea0887" name="a0a629815bc2dfa046866f0b28dea0887"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0a629815bc2dfa046866f0b28dea0887">◆ </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::MemoryBackend::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="MemoryFactory_8cpp_source.html#l00114">114</a> of file <a class="el" href="MemoryFactory_8cpp_source.html">MemoryFactory.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad1c41ea346dc8b8202fd05f67349735c" name="ad1c41ea346dc8b8202fd05f67349735c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad1c41ea346dc8b8202fd05f67349735c">◆ </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::MemoryBackend::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="MemoryFactory_8cpp_source.html#l00122">122</a> of file <a class="el" href="MemoryFactory_8cpp_source.html">MemoryFactory.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a914efe50059a9990c60e592a27bbad66" name="a914efe50059a9990c60e592a27bbad66"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a914efe50059a9990c60e592a27bbad66">◆ </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::MemoryBackend::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="MemoryFactory_8cpp_source.html#l00141">141</a> of file <a class="el" href="MemoryFactory_8cpp_source.html">MemoryFactory.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a40130939ef641571abf616a970d63957" name="a40130939ef641571abf616a970d63957"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a40130939ef641571abf616a970d63957">◆ </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::MemoryBackend::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="MemoryFactory_8cpp_source.html#l00159">159</a> of file <a class="el" href="MemoryFactory_8cpp_source.html">MemoryFactory.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab677b7560cd27c159ad78e1412513d5f" name="ab677b7560cd27c159ad78e1412513d5f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab677b7560cd27c159ad78e1412513d5f">◆ </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::MemoryBackend::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_1MemoryBackend.html#a40130939ef641571abf616a970d63957">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="MemoryFactory_8cpp_source.html#l00168">168</a> of file <a class="el" href="MemoryFactory_8cpp_source.html">MemoryFactory.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7a01b5df53b3ca0487785188f98b4320" name="a7a01b5df53b3ca0487785188f98b4320"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7a01b5df53b3ca0487785188f98b4320">◆ </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::MemoryBackend::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="MemoryFactory_8cpp_source.html#l00175">175</a> of file <a class="el" href="MemoryFactory_8cpp_source.html">MemoryFactory.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa6f448cbec37beaa817905fe441c511c" name="aa6f448cbec37beaa817905fe441c511c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa6f448cbec37beaa817905fe441c511c">◆ </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::MemoryBackend::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="MemoryFactory_8cpp_source.html#l00180">180</a> of file <a class="el" href="MemoryFactory_8cpp_source.html">MemoryFactory.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab56c3ec0fd054251bfe27125a9092973" name="ab56c3ec0fd054251bfe27125a9092973"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab56c3ec0fd054251bfe27125a9092973">◆ </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::MemoryBackend::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="MemoryFactory_8cpp_source.html#l00190">190</a> of file <a class="el" href="MemoryFactory_8cpp_source.html">MemoryFactory.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac0e6ebc55d43139af9a26254ed736609" name="ac0e6ebc55d43139af9a26254ed736609"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac0e6ebc55d43139af9a26254ed736609">◆ </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::MemoryBackend::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="MemoryFactory_8cpp_source.html#l00196">196</a> of file <a class="el" href="MemoryFactory_8cpp_source.html">MemoryFactory.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad11105242d588bfd1c07bf7d3d729790" name="ad11105242d588bfd1c07bf7d3d729790"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad11105242d588bfd1c07bf7d3d729790">◆ </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::MemoryBackend::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="MemoryFactory_8cpp_source.html#l00201">201</a> of file <a class="el" href="MemoryFactory_8cpp_source.html">MemoryFactory.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>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a id="a68db5737a6a61f08b0057c6feda9a60e" name="a68db5737a6a61f08b0057c6feda9a60e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a68db5737a6a61f08b0057c6feda9a60e">◆ </a></span>name_</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::MemoryBackend::name_</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="MemoryFactory_8cpp_source.html#l00074">74</a> of file <a class="el" href="MemoryFactory_8cpp_source.html">MemoryFactory.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="adec6e97b302a511fc1c84e424f3da022" name="adec6e97b302a511fc1c84e424f3da022"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adec6e97b302a511fc1c84e424f3da022">◆ </a></span>journal_</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="classbeast_1_1Journal.html">beast::Journal</a> const ripple::NodeStore::MemoryBackend::journal_</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="MemoryFactory_8cpp_source.html#l00075">75</a> of file <a class="el" href="MemoryFactory_8cpp_source.html">MemoryFactory.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af8168c72040c7f20f427b44f9794944f" name="af8168c72040c7f20f427b44f9794944f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af8168c72040c7f20f427b44f9794944f">◆ </a></span>db_</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="structripple_1_1NodeStore_1_1MemoryDB.html">MemoryDB</a>* ripple::NodeStore::MemoryBackend::db_ {nullptr}</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="MemoryFactory_8cpp_source.html#l00076">76</a> of file <a class="el" href="MemoryFactory_8cpp_source.html">MemoryFactory.cpp</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>
|