ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-26 14:05:51 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
cf1b2bc8e43a57da9a990f414c8a805026ce12ff
rippled/classripple_1_1NodeStore_1_1Factory.html
bthomee 7f0acfcddb deploy: c17676a9be
2025-03-12 22:37:33 +00:00

325 lines
18 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.5"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: ripple::NodeStore::Factory 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.5 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- 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_1Factory.html">Factory</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classripple_1_1NodeStore_1_1Factory-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::NodeStore::Factory Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
</div><!--header-->
<div class="contents">
<p>Base class for backend factories.
<a href="classripple_1_1NodeStore_1_1Factory.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="Factory_8h_source.html">Factory.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ripple::NodeStore::Factory:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1NodeStore_1_1Factory__inherit__graph.png" border="0" usemap="#aripple_1_1NodeStore_1_1Factory_inherit__map" alt="Inheritance graph"/></div>
<map name="aripple_1_1NodeStore_1_1Factory_inherit__map" id="aripple_1_1NodeStore_1_1Factory_inherit__map">
<area shape="rect" title="Base class for backend factories." alt="" coords="5,69,148,109"/>
<area shape="rect" href="classripple_1_1NodeStore_1_1MemoryFactory.html" title=" " alt="" coords="196,5,339,45"/>
<area shape="rect" href="classripple_1_1NodeStore_1_1NuDBFactory.html" title=" " alt="" coords="196,69,339,109"/>
<area shape="rect" href="classripple_1_1NodeStore_1_1NullFactory.html" title=" " alt="" coords="196,133,339,173"/>
</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:a408ef44b2fd5eeba4a790ae3b4db1d60"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1Factory.html#a408ef44b2fd5eeba4a790ae3b4db1d60">~Factory</a> ()=default</td></tr>
<tr class="separator:a408ef44b2fd5eeba4a790ae3b4db1d60"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a31f0b64f00ea5caba4a992494382e827"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1Factory.html#a31f0b64f00ea5caba4a992494382e827">getName</a> () const =0</td></tr>
<tr class="memdesc:a31f0b64f00ea5caba4a992494382e827"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve the name of this factory. <a href="classripple_1_1NodeStore_1_1Factory.html#a31f0b64f00ea5caba4a992494382e827">More...</a><br /></td></tr>
<tr class="separator:a31f0b64f00ea5caba4a992494382e827"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab09ead0fbc88a5b1624cfefc6c9e4f7c"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/unique_ptr.html">std::unique_ptr</a>&lt; <a class="el" href="classripple_1_1NodeStore_1_1Backend.html">Backend</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1Factory.html#ab09ead0fbc88a5b1624cfefc6c9e4f7c">createInstance</a> (size_t keyBytes, <a class="el" href="classripple_1_1Section.html">Section</a> const &amp;parameters, <a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> <a class="el" href="namespaceripple.html#a1b38e742ac7fe4c3a80a397e06b83dcbaa62741f39e8a8d667ccccd0642c08746">burstSize</a>, <a class="el" href="classripple_1_1NodeStore_1_1Scheduler.html">Scheduler</a> &amp;scheduler, <a class="el" href="classbeast_1_1Journal.html">beast::Journal</a> journal)=0</td></tr>
<tr class="memdesc:ab09ead0fbc88a5b1624cfefc6c9e4f7c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create an instance of this factory's backend. <a href="classripple_1_1NodeStore_1_1Factory.html#ab09ead0fbc88a5b1624cfefc6c9e4f7c">More...</a><br /></td></tr>
<tr class="separator:ab09ead0fbc88a5b1624cfefc6c9e4f7c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a881d753bb4f6017085271c3e16db2714"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/unique_ptr.html">std::unique_ptr</a>&lt; <a class="el" href="classripple_1_1NodeStore_1_1Backend.html">Backend</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1Factory.html#a881d753bb4f6017085271c3e16db2714">createInstance</a> (size_t keyBytes, <a class="el" href="classripple_1_1Section.html">Section</a> const &amp;parameters, <a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> <a class="el" href="namespaceripple.html#a1b38e742ac7fe4c3a80a397e06b83dcbaa62741f39e8a8d667ccccd0642c08746">burstSize</a>, <a class="el" href="classripple_1_1NodeStore_1_1Scheduler.html">Scheduler</a> &amp;scheduler, nudb::context &amp;context, <a class="el" href="classbeast_1_1Journal.html">beast::Journal</a> journal)</td></tr>
<tr class="memdesc:a881d753bb4f6017085271c3e16db2714"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create an instance of this factory's backend. <a href="classripple_1_1NodeStore_1_1Factory.html#a881d753bb4f6017085271c3e16db2714">More...</a><br /></td></tr>
<tr class="separator:a881d753bb4f6017085271c3e16db2714"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >Base class for backend factories. </p>
<p class="definition">Definition at line <a class="el" href="Factory_8h_source.html#l00036">36</a> of file <a class="el" href="Factory_8h_source.html">Factory.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a408ef44b2fd5eeba4a790ae3b4db1d60" name="a408ef44b2fd5eeba4a790ae3b4db1d60"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a408ef44b2fd5eeba4a790ae3b4db1d60">&#9670;&#160;</a></span>~Factory()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual ripple::NodeStore::Factory::~Factory </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a31f0b64f00ea5caba4a992494382e827" name="a31f0b64f00ea5caba4a992494382e827"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a31f0b64f00ea5caba4a992494382e827">&#9670;&#160;</a></span>getName()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> ripple::NodeStore::Factory::getName </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the name of this factory. </p>
<p>Implemented in <a class="el" href="classripple_1_1NodeStore_1_1MemoryFactory.html#a1b06b63f8f1bea3b8eb44d50de48da84">ripple::NodeStore::MemoryFactory</a>, <a class="el" href="classripple_1_1NodeStore_1_1NuDBFactory.html#acacec80114639c2972dd5431df852d15">ripple::NodeStore::NuDBFactory</a>, and <a class="el" href="classripple_1_1NodeStore_1_1NullFactory.html#a887cfa6f76d807f235d17fde36b4f46d">ripple::NodeStore::NullFactory</a>.</p>
</div>
</div>
<a id="ab09ead0fbc88a5b1624cfefc6c9e4f7c" name="ab09ead0fbc88a5b1624cfefc6c9e4f7c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab09ead0fbc88a5b1624cfefc6c9e4f7c">&#9670;&#160;</a></span>createInstance() <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">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/unique_ptr.html">std::unique_ptr</a>&lt; <a class="el" href="classripple_1_1NodeStore_1_1Backend.html">Backend</a> &gt; ripple::NodeStore::Factory::createInstance </td>
<td>(</td>
<td class="paramtype">size_t&#160;</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 &amp;&#160;</td>
<td class="paramname"><em>parameters</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a>&#160;</td>
<td class="paramname"><em>burstSize</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classripple_1_1NodeStore_1_1Scheduler.html">Scheduler</a> &amp;&#160;</td>
<td class="paramname"><em>scheduler</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classbeast_1_1Journal.html">beast::Journal</a>&#160;</td>
<td class="paramname"><em>journal</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create an instance of this factory's backend. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">keyBytes</td><td>The fixed number of bytes per key. </td></tr>
<tr><td class="paramname">parameters</td><td>A set of key/value configuration pairs. </td></tr>
<tr><td class="paramname">burstSize</td><td><a class="el" href="classripple_1_1NodeStore_1_1Backend.html" title="A backend used for the NodeStore.">Backend</a> burst size in bytes. </td></tr>
<tr><td class="paramname">scheduler</td><td>The scheduler to use for running tasks. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A pointer to the <a class="el" href="classripple_1_1NodeStore_1_1Backend.html" title="A backend used for the NodeStore.">Backend</a> object. </dd></dl>
<p>Implemented in <a class="el" href="classripple_1_1NodeStore_1_1MemoryFactory.html#a778cb89cf449fad1a11d81133377c68b">ripple::NodeStore::MemoryFactory</a>, <a class="el" href="classripple_1_1NodeStore_1_1NuDBFactory.html#ad0789a69b94585c90846d67a56e858fd">ripple::NodeStore::NuDBFactory</a>, and <a class="el" href="classripple_1_1NodeStore_1_1NullFactory.html#ab96114970f9a6af7090f0fcca6c83ec9">ripple::NodeStore::NullFactory</a>.</p>
</div>
</div>
<a id="a881d753bb4f6017085271c3e16db2714" name="a881d753bb4f6017085271c3e16db2714"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a881d753bb4f6017085271c3e16db2714">&#9670;&#160;</a></span>createInstance() <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 <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/unique_ptr.html">std::unique_ptr</a>&lt; <a class="el" href="classripple_1_1NodeStore_1_1Backend.html">Backend</a> &gt; ripple::NodeStore::Factory::createInstance </td>
<td>(</td>
<td class="paramtype">size_t&#160;</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 &amp;&#160;</td>
<td class="paramname"><em>parameters</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a>&#160;</td>
<td class="paramname"><em>burstSize</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classripple_1_1NodeStore_1_1Scheduler.html">Scheduler</a> &amp;&#160;</td>
<td class="paramname"><em>scheduler</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">nudb::context &amp;&#160;</td>
<td class="paramname"><em>context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classbeast_1_1Journal.html">beast::Journal</a>&#160;</td>
<td class="paramname"><em>journal</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create an instance of this factory's backend. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">keyBytes</td><td>The fixed number of bytes per key. </td></tr>
<tr><td class="paramname">parameters</td><td>A set of key/value configuration pairs. </td></tr>
<tr><td class="paramname">burstSize</td><td><a class="el" href="classripple_1_1NodeStore_1_1Backend.html" title="A backend used for the NodeStore.">Backend</a> burst size in bytes. </td></tr>
<tr><td class="paramname">scheduler</td><td>The scheduler to use for running tasks. </td></tr>
<tr><td class="paramname">context</td><td>The context used by database. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A pointer to the <a class="el" href="classripple_1_1NodeStore_1_1Backend.html" title="A backend used for the NodeStore.">Backend</a> object. </dd></dl>
<p>Reimplemented in <a class="el" href="classripple_1_1NodeStore_1_1NuDBFactory.html#a0f37ad0f3ae7d6c4e857d94b812e5e95">ripple::NodeStore::NuDBFactory</a>.</p>
<p class="definition">Definition at line <a class="el" href="Factory_8h_source.html#l00071">71</a> of file <a class="el" href="Factory_8h_source.html">Factory.h</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink