ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-24 04:55:52 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
a84d06b17d69754eb8af364182d5865ac35a05bc
rippled/classripple_1_1NodeStore_1_1Factory.html
manojsdoshi 46ee4c24ed deploy: c11037fd27
2021-01-21 18:53:50 +00:00

318 lines
17 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">
<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::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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">rippled
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceripple.html">ripple</a></li><li class="navelem"><a class="el" href="namespaceripple_1_1NodeStore.html">NodeStore</a></li><li class="navelem"><a class="el" href="classripple_1_1NodeStore_1_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>
<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="#ripple_1_1NodeStore_1_1Factory_inherit__map" alt="Inheritance graph"/></div>
<map name="ripple_1_1NodeStore_1_1Factory_inherit__map" id="ripple_1_1NodeStore_1_1Factory_inherit__map">
<area shape="rect" title="Base class for backend factories." alt="" coords="5,71,148,112"/>
<area shape="rect" href="classripple_1_1NodeStore_1_1MemoryFactory.html" title=" " alt="" coords="196,5,339,47"/>
<area shape="rect" href="classripple_1_1NodeStore_1_1NuDBFactory.html" title=" " alt="" coords="196,71,339,112"/>
<area shape="rect" href="classripple_1_1NodeStore_1_1NullFactory.html" title=" " alt="" coords="196,136,339,177"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem: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:ad17e5c51eefbb327dbdb0106ce0662dc"><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#ad17e5c51eefbb327dbdb0106ce0662dc">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> burstSize, <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:ad17e5c51eefbb327dbdb0106ce0662dc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create an instance of this factory's backend. <a href="classripple_1_1NodeStore_1_1Factory.html#ad17e5c51eefbb327dbdb0106ce0662dc">More...</a><br /></td></tr>
<tr class="separator:ad17e5c51eefbb327dbdb0106ce0662dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a04fdc83cd925dbdcd792a3fdff5926a1"><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#a04fdc83cd925dbdcd792a3fdff5926a1">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> burstSize, <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:a04fdc83cd925dbdcd792a3fdff5926a1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create an instance of this factory's backend. <a href="classripple_1_1NodeStore_1_1Factory.html#a04fdc83cd925dbdcd792a3fdff5926a1">More...</a><br /></td></tr>
<tr class="separator:a04fdc83cd925dbdcd792a3fdff5926a1"><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#l00033">33</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"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a408ef44b2fd5eeba4a790ae3b4db1d60">&#9670;&nbsp;</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"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a31f0b64f00ea5caba4a992494382e827">&#9670;&nbsp;</a></span>getName()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> ripple::NodeStore::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_1NuDBFactory.html#acacec80114639c2972dd5431df852d15">ripple::NodeStore::NuDBFactory</a>, <a class="el" href="classripple_1_1NodeStore_1_1NullFactory.html#a887cfa6f76d807f235d17fde36b4f46d">ripple::NodeStore::NullFactory</a>, and <a class="el" href="classripple_1_1NodeStore_1_1MemoryFactory.html#a1b06b63f8f1bea3b8eb44d50de48da84">ripple::NodeStore::MemoryFactory</a>.</p>
</div>
</div>
<a id="ad17e5c51eefbb327dbdb0106ce0662dc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad17e5c51eefbb327dbdb0106ce0662dc">&#9670;&nbsp;</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_1NullFactory.html#a4a249cd155428b64f261a807e7b64875">ripple::NodeStore::NullFactory</a>, <a class="el" href="classripple_1_1NodeStore_1_1NuDBFactory.html#ac6b38beb29569eb38d0d18f8838eacb2">ripple::NodeStore::NuDBFactory</a>, and <a class="el" href="classripple_1_1NodeStore_1_1MemoryFactory.html#a778cb89cf449fad1a11d81133377c68b">ripple::NodeStore::MemoryFactory</a>.</p>
</div>
</div>
<a id="a04fdc83cd925dbdcd792a3fdff5926a1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a04fdc83cd925dbdcd792a3fdff5926a1">&#9670;&nbsp;</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#ae0b3932e780fa34de5822a1c153b5266">ripple::NodeStore::NuDBFactory</a>.</p>
<p class="definition">Definition at line <a class="el" href="Factory_8h_source.html#l00068">68</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="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink