mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-24 04:55:52 +00:00
929 lines
52 KiB
HTML
929 lines
52 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">
|
|
<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::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 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&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&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_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="#ripple_1_1NodeStore_1_1MemoryBackend_inherit__map" alt="Inheritance graph"/></div>
|
|
<map name="ripple_1_1NodeStore_1_1MemoryBackend_inherit__map" id="ripple_1_1NodeStore_1_1MemoryBackend_inherit__map">
|
|
<area shape="rect" title=" " alt="" coords="5,95,148,136"/>
|
|
<area shape="rect" href="classripple_1_1NodeStore_1_1Backend.html" title="A backend used for the NodeStore." alt="" coords="5,5,148,47"/>
|
|
</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="#ripple_1_1NodeStore_1_1MemoryBackend_coll__map" alt="Collaboration graph"/></div>
|
|
<map name="ripple_1_1NodeStore_1_1MemoryBackend_coll__map" id="ripple_1_1NodeStore_1_1MemoryBackend_coll__map">
|
|
<area shape="rect" title=" " alt="" coords="1836,100,1979,141"/>
|
|
<area shape="rect" href="classripple_1_1NodeStore_1_1Backend.html" title="A backend used for the NodeStore." alt="" coords="1588,5,1731,47"/>
|
|
<area shape="rect" href="structripple_1_1NodeStore_1_1MemoryDB.html" title=" " alt="" coords="1588,71,1731,112"/>
|
|
<area shape="rect" href="http://en.cppreference.com/w/cpp/thread/mutex.html" title="STL class." alt="" coords="1335,105,1427,131"/>
|
|
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/map.html" title=" " alt="" coords="1275,25,1488,81"/>
|
|
<area shape="rect" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html" title=" " alt="" coords="991,73,1161,115"/>
|
|
<area shape="rect" href="classripple_1_1NodeObject.html" title="A simple object that the Ledger uses to store entries." alt="" coords="764,95,907,122"/>
|
|
<area shape="rect" href="classripple_1_1CountedObject.html" title=" " alt="" coords="503,81,665,123"/>
|
|
<area shape="rect" href="classripple_1_1base__uint.html" title="Integers of any length that is a multiple of 32-bits." alt="" coords="513,16,655,57"/>
|
|
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/array.html" title=" " alt="" coords="221,16,389,57"/>
|
|
<area shape="rect" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="5,23,108,50"/>
|
|
<area shape="rect" href="http://en.cppreference.com/w/cpp/types/size_t.html" title=" " alt="" coords="261,126,349,153"/>
|
|
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/vector.html" title="STL class." alt="" coords="519,210,649,237"/>
|
|
<area shape="rect" title=" " alt="" coords="286,210,325,237"/>
|
|
<area shape="rect" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title="STL class." alt="" coords="1616,137,1703,163"/>
|
|
<area shape="rect" href="classbeast_1_1Journal.html" title="A generic endpoint for log messages." alt="" coords="1604,187,1715,214"/>
|
|
<area shape="rect" href="classbeast_1_1Journal_1_1Sink.html" title="Abstraction for the underlying message destination." alt="" coords="1308,187,1455,214"/>
|
|
</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: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"><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"><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. <a href="classripple_1_1NodeStore_1_1MemoryBackend.html#a6c8bde126310dfbe7837ebdcc43b3bd2">More...</a><br /></td></tr>
|
|
<tr class="separator:a6c8bde126310dfbe7837ebdcc43b3bd2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4e5920f4c51902aef93021277aa8ab37"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1MemoryBackend.html#a4e5920f4c51902aef93021277aa8ab37">open</a> (bool createIfMissing) override</td></tr>
|
|
<tr class="memdesc:a4e5920f4c51902aef93021277aa8ab37"><td class="mdescLeft"> </td><td class="mdescRight">Open the backend. <a href="classripple_1_1NodeStore_1_1MemoryBackend.html#a4e5920f4c51902aef93021277aa8ab37">More...</a><br /></td></tr>
|
|
<tr class="separator:a4e5920f4c51902aef93021277aa8ab37"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem: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. <a href="classripple_1_1NodeStore_1_1MemoryBackend.html#ada78f1edc055747acbcd9b0da846d743">More...</a><br /></td></tr>
|
|
<tr class="separator:ada78f1edc055747acbcd9b0da846d743"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem: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. <a href="classripple_1_1NodeStore_1_1MemoryBackend.html#a0a629815bc2dfa046866f0b28dea0887">More...</a><br /></td></tr>
|
|
<tr class="separator:a0a629815bc2dfa046866f0b28dea0887"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem: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. <a href="classripple_1_1NodeStore_1_1MemoryBackend.html#ad1c41ea346dc8b8202fd05f67349735c">More...</a><br /></td></tr>
|
|
<tr class="separator:ad1c41ea346dc8b8202fd05f67349735c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aebb40decbb0e49b7a24e5b4845dddfd1"><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#aebb40decbb0e49b7a24e5b4845dddfd1">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:aebb40decbb0e49b7a24e5b4845dddfd1"><td class="mdescLeft"> </td><td class="mdescRight">Fetch a batch synchronously. <a href="classripple_1_1NodeStore_1_1MemoryBackend.html#aebb40decbb0e49b7a24e5b4845dddfd1">More...</a><br /></td></tr>
|
|
<tr class="separator:aebb40decbb0e49b7a24e5b4845dddfd1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem: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. <a href="classripple_1_1NodeStore_1_1MemoryBackend.html#a40130939ef641571abf616a970d63957">More...</a><br /></td></tr>
|
|
<tr class="separator:a40130939ef641571abf616a970d63957"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem: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 &batch) override</td></tr>
|
|
<tr class="memdesc:ab677b7560cd27c159ad78e1412513d5f"><td class="mdescLeft"> </td><td class="mdescRight">Store a group of objects. <a href="classripple_1_1NodeStore_1_1MemoryBackend.html#ab677b7560cd27c159ad78e1412513d5f">More...</a><br /></td></tr>
|
|
<tr class="separator:ab677b7560cd27c159ad78e1412513d5f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem: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"><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. <a href="classripple_1_1NodeStore_1_1MemoryBackend.html#aa6f448cbec37beaa817905fe441c511c">More...</a><br /></td></tr>
|
|
<tr class="separator:aa6f448cbec37beaa817905fe441c511c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem: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. <a href="classripple_1_1NodeStore_1_1MemoryBackend.html#ab56c3ec0fd054251bfe27125a9092973">More...</a><br /></td></tr>
|
|
<tr class="separator:ab56c3ec0fd054251bfe27125a9092973"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem: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. <a href="classripple_1_1NodeStore_1_1MemoryBackend.html#ac0e6ebc55d43139af9a26254ed736609">More...</a><br /></td></tr>
|
|
<tr class="separator:ac0e6ebc55d43139af9a26254ed736609"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem: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. <a href="classripple_1_1NodeStore_1_1MemoryBackend.html#ad11105242d588bfd1c07bf7d3d729790">More...</a><br /></td></tr>
|
|
<tr class="separator:ad11105242d588bfd1c07bf7d3d729790"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem: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. <a href="classripple_1_1NodeStore_1_1Backend.html#ae4e7c931c5382d31d877c6f7162dd21e">More...</a><br /></td></tr>
|
|
<tr class="separator:ae4e7c931c5382d31d877c6f7162dd21e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem: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. <a href="classripple_1_1NodeStore_1_1Backend.html#afea5371bd4d7824d96f28700fa831f33">More...</a><br /></td></tr>
|
|
<tr class="separator:afea5371bd4d7824d96f28700fa831f33"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afd4e55baccdaf56f34ae3c77191932a6"><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="el" href="structripple_1_1NodeStore_1_1Backend_1_1Counters.html">Counters</a>< <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint64_t</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1Backend.html#afd4e55baccdaf56f34ae3c77191932a6">counters</a> () const</td></tr>
|
|
<tr class="memdesc:afd4e55baccdaf56f34ae3c77191932a6"><td class="mdescLeft"> </td><td class="mdescRight">Returns read and write stats. <a href="classripple_1_1NodeStore_1_1Backend.html#afd4e55baccdaf56f34ae3c77191932a6">More...</a><br /></td></tr>
|
|
<tr class="separator:afd4e55baccdaf56f34ae3c77191932a6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-types"></a>
|
|
Private Types</h2></td></tr>
|
|
<tr class="memitem: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 name="pri-attribs"></a>
|
|
Private Attributes</h2></td></tr>
|
|
<tr class="memitem: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:a1550890e583617e4e792a9baacdd259a"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classbeast_1_1Journal.html">beast::Journal</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1MemoryBackend.html#a1550890e583617e4e792a9baacdd259a">journal_</a></td></tr>
|
|
<tr class="separator:a1550890e583617e4e792a9baacdd259a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem: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#l00079">79</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"></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#l00082">82</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"></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#l00089">89</a> of file <a class="el" href="MemoryFactory_8cpp_source.html">MemoryFactory.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="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#l00100">100</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"></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#l00106">106</a> of file <a class="el" href="MemoryFactory_8cpp_source.html">MemoryFactory.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4e5920f4c51902aef93021277aa8ab37"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4e5920f4c51902aef93021277aa8ab37">◆ </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#l00112">112</a> of file <a class="el" href="MemoryFactory_8cpp_source.html">MemoryFactory.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="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#l00118">118</a> of file <a class="el" href="MemoryFactory_8cpp_source.html">MemoryFactory.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="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#l00124">124</a> of file <a class="el" href="MemoryFactory_8cpp_source.html">MemoryFactory.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="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#l00132">132</a> of file <a class="el" href="MemoryFactory_8cpp_source.html">MemoryFactory.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aebb40decbb0e49b7a24e5b4845dddfd1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aebb40decbb0e49b7a24e5b4845dddfd1">◆ </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#aa772cdcdfaae28944eac29473bc3931a">ripple::NodeStore::Backend</a>.</p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="MemoryFactory_8cpp_source.html#l00150">150</a> of file <a class="el" href="MemoryFactory_8cpp_source.html">MemoryFactory.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="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#l00168">168</a> of file <a class="el" href="MemoryFactory_8cpp_source.html">MemoryFactory.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="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#l00176">176</a> of file <a class="el" href="MemoryFactory_8cpp_source.html">MemoryFactory.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="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#l00183">183</a> of file <a class="el" href="MemoryFactory_8cpp_source.html">MemoryFactory.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="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#l00188">188</a> of file <a class="el" href="MemoryFactory_8cpp_source.html">MemoryFactory.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="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#l00196">196</a> of file <a class="el" href="MemoryFactory_8cpp_source.html">MemoryFactory.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="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#l00202">202</a> of file <a class="el" href="MemoryFactory_8cpp_source.html">MemoryFactory.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="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#l00207">207</a> of file <a class="el" href="MemoryFactory_8cpp_source.html">MemoryFactory.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="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" title="STL class.">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#l00099">99</a> of file <a class="el" href="Backend_8h_source.html">Backend.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="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#l00170">170</a> of file <a class="el" href="Backend_8h_source.html">Backend.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afd4e55baccdaf56f34ae3c77191932a6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afd4e55baccdaf56f34ae3c77191932a6">◆ </a></span>counters()</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="el" href="structripple_1_1NodeStore_1_1Backend_1_1Counters.html">Counters</a><<a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint64_t</a>> > ripple::NodeStore::Backend::counters </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>Returns read and write stats. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>The Counters struct is specific to and only used by CassandraBackend. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Backend_8h_source.html#l00184">184</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"></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#l00084">84</a> of file <a class="el" href="MemoryFactory_8cpp_source.html">MemoryFactory.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1550890e583617e4e792a9baacdd259a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1550890e583617e4e792a9baacdd259a">◆ </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">const <a class="el" href="classbeast_1_1Journal.html">beast::Journal</a> 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#l00085">85</a> of file <a class="el" href="MemoryFactory_8cpp_source.html">MemoryFactory.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="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#l00086">86</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="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.17
|
|
</small></address>
|
|
</body>
|
|
</html>
|