mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-20 19:15:54 +00:00
796 lines
53 KiB
HTML
796 lines
53 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::RelationalDatabase 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="classripple_1_1RelationalDatabase.html">RelationalDatabase</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#nested-classes">Classes</a> |
|
|
<a href="#pub-types">Public Types</a> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pub-static-methods">Static Public Member Functions</a> |
|
|
<a href="classripple_1_1RelationalDatabase-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">ripple::RelationalDatabase Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><code>#include <<a class="el" href="RelationalDatabase_8h_source.html">RelationalDatabase.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for ripple::RelationalDatabase:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classripple_1_1RelationalDatabase__inherit__graph.png" border="0" usemap="#aripple_1_1RelationalDatabase_inherit__map" alt="Inheritance graph"/></div>
|
|
<map name="aripple_1_1RelationalDatabase_inherit__map" id="aripple_1_1RelationalDatabase_inherit__map">
|
|
<area shape="rect" title=" " alt="" coords="6,5,201,31"/>
|
|
<area shape="rect" href="classripple_1_1SQLiteDatabase.html" title=" " alt="" coords="18,79,189,104"/>
|
|
<area shape="poly" title=" " alt="" coords="106,44,106,79,101,79,101,44"/>
|
|
<area shape="rect" href="classripple_1_1SQLiteDatabaseImp.html" title=" " alt="" coords="5,152,201,177"/>
|
|
<area shape="poly" title=" " alt="" coords="106,118,106,152,101,152,101,118"/>
|
|
</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="nested-classes" name="nested-classes"></a>
|
|
Classes</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1RelationalDatabase_1_1AccountTxArgs.html">AccountTxArgs</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1RelationalDatabase_1_1AccountTxMarker.html">AccountTxMarker</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1RelationalDatabase_1_1AccountTxOptions.html">AccountTxOptions</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1RelationalDatabase_1_1AccountTxPageOptions.html">AccountTxPageOptions</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1RelationalDatabase_1_1AccountTxResult.html">AccountTxResult</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1RelationalDatabase_1_1CountMinMax.html">CountMinMax</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
|
|
Public Types</h2></td></tr>
|
|
<tr class="memitem:a251e55e3d5aa9b4e4d1a7eebe2157d46" id="r_a251e55e3d5aa9b4e4d1a7eebe2157d46"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RelationalDatabase.html#a251e55e3d5aa9b4e4d1a7eebe2157d46">AccountTx</a> = <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/memory/shared_ptr.html">std::shared_ptr</a>< <a class="el" href="classripple_1_1Transaction.html">Transaction</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_1TxMeta.html">TxMeta</a> > ></td></tr>
|
|
<tr class="separator:a251e55e3d5aa9b4e4d1a7eebe2157d46"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1af9139d7f4c8f662c7b8e49473a21e2" id="r_a1af9139d7f4c8f662c7b8e49473a21e2"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RelationalDatabase.html#a1af9139d7f4c8f662c7b8e49473a21e2">AccountTxs</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a>< <a class="el" href="classripple_1_1RelationalDatabase.html#a251e55e3d5aa9b4e4d1a7eebe2157d46">AccountTx</a> ></td></tr>
|
|
<tr class="separator:a1af9139d7f4c8f662c7b8e49473a21e2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad49d721f8f069c1ee9652b93a3485423" id="r_ad49d721f8f069c1ee9652b93a3485423"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RelationalDatabase.html#ad49d721f8f069c1ee9652b93a3485423">txnMetaLedgerType</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/tuple.html">std::tuple</a>< <a class="el" href="namespaceripple.html#ab1f2184bb5938b5508798cd47a561a21">Blob</a>, <a class="el" href="namespaceripple.html#ab1f2184bb5938b5508798cd47a561a21">Blob</a>, <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> ></td></tr>
|
|
<tr class="separator:ad49d721f8f069c1ee9652b93a3485423"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a183ed7f35d368ec4564d8083fe9656f3" id="r_a183ed7f35d368ec4564d8083fe9656f3"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RelationalDatabase.html#a183ed7f35d368ec4564d8083fe9656f3">MetaTxsList</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a>< <a class="el" href="classripple_1_1RelationalDatabase.html#ad49d721f8f069c1ee9652b93a3485423">txnMetaLedgerType</a> ></td></tr>
|
|
<tr class="separator:a183ed7f35d368ec4564d8083fe9656f3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:affdfbc3c5f0f2d7b78cc5570617a5fda" id="r_affdfbc3c5f0f2d7b78cc5570617a5fda"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RelationalDatabase.html#affdfbc3c5f0f2d7b78cc5570617a5fda">LedgerSequence</a> = uint32_t</td></tr>
|
|
<tr class="separator:affdfbc3c5f0f2d7b78cc5570617a5fda"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae6ed6a653c43698a1480c0230b1e99aa" id="r_ae6ed6a653c43698a1480c0230b1e99aa"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RelationalDatabase.html#ae6ed6a653c43698a1480c0230b1e99aa">LedgerHash</a> = <a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a></td></tr>
|
|
<tr class="separator:ae6ed6a653c43698a1480c0230b1e99aa"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a99c471461c2b0858d240f98034c6fda3" id="r_a99c471461c2b0858d240f98034c6fda3"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RelationalDatabase.html#a99c471461c2b0858d240f98034c6fda3">LedgerShortcut</a> = <a class="el" href="namespaceripple_1_1RPC.html#a4c04e509451d50d9449cff3d477ff4f2">RPC::LedgerShortcut</a></td></tr>
|
|
<tr class="separator:a99c471461c2b0858d240f98034c6fda3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae6edb30f534bd5669ee659789aa22e86" id="r_ae6edb30f534bd5669ee659789aa22e86"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RelationalDatabase.html#ae6edb30f534bd5669ee659789aa22e86">LedgerSpecifier</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/variant.html">std::variant</a>< <a class="el" href="structripple_1_1LedgerRange.html">LedgerRange</a>, <a class="el" href="namespaceripple_1_1RPC.html#a4c04e509451d50d9449cff3d477ff4f2">LedgerShortcut</a>, <a class="el" href="classripple_1_1RelationalDatabase.html#affdfbc3c5f0f2d7b78cc5570617a5fda">LedgerSequence</a>, <a class="el" href="classripple_1_1RelationalDatabase.html#ae6ed6a653c43698a1480c0230b1e99aa">LedgerHash</a> ></td></tr>
|
|
<tr class="separator:ae6edb30f534bd5669ee659789aa22e86"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><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:a2aa37e3eb9fbd4f96a030b6188c4e9d2" id="r_a2aa37e3eb9fbd4f96a030b6188c4e9d2"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RelationalDatabase.html#a2aa37e3eb9fbd4f96a030b6188c4e9d2">~RelationalDatabase</a> ()=default</td></tr>
|
|
<tr class="separator:a2aa37e3eb9fbd4f96a030b6188c4e9d2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acf44d77817b8dab02b31c974817aaa29" id="r_acf44d77817b8dab02b31c974817aaa29"><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="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd">LedgerIndex</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RelationalDatabase.html#acf44d77817b8dab02b31c974817aaa29">getMinLedgerSeq</a> ()=0</td></tr>
|
|
<tr class="memdesc:acf44d77817b8dab02b31c974817aaa29"><td class="mdescLeft"> </td><td class="mdescRight">getMinLedgerSeq Returns the minimum ledger sequence in the Ledgers table. <br /></td></tr>
|
|
<tr class="separator:acf44d77817b8dab02b31c974817aaa29"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6e5c168f1ca0906e6df4b07e488863aa" id="r_a6e5c168f1ca0906e6df4b07e488863aa"><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="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd">LedgerIndex</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RelationalDatabase.html#a6e5c168f1ca0906e6df4b07e488863aa">getMaxLedgerSeq</a> ()=0</td></tr>
|
|
<tr class="memdesc:a6e5c168f1ca0906e6df4b07e488863aa"><td class="mdescLeft"> </td><td class="mdescRight">getMaxLedgerSeq Returns the maximum ledger sequence in the Ledgers table. <br /></td></tr>
|
|
<tr class="separator:a6e5c168f1ca0906e6df4b07e488863aa"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a388e80415da1da75b45ecf011a64f5dd" id="r_a388e80415da1da75b45ecf011a64f5dd"><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="namespaceripple.html#aaf521cde20561da32d6a54a105363555">LedgerInfo</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RelationalDatabase.html#a388e80415da1da75b45ecf011a64f5dd">getLedgerInfoByIndex</a> (<a class="el" href="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd">LedgerIndex</a> ledgerSeq)=0</td></tr>
|
|
<tr class="memdesc:a388e80415da1da75b45ecf011a64f5dd"><td class="mdescLeft"> </td><td class="mdescRight">getLedgerInfoByIndex Returns a ledger by its sequence. <br /></td></tr>
|
|
<tr class="separator:a388e80415da1da75b45ecf011a64f5dd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a21b8bd40f0332c84bf71ef73d32bd91c" id="r_a21b8bd40f0332c84bf71ef73d32bd91c"><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="namespaceripple.html#aaf521cde20561da32d6a54a105363555">LedgerInfo</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RelationalDatabase.html#a21b8bd40f0332c84bf71ef73d32bd91c">getNewestLedgerInfo</a> ()=0</td></tr>
|
|
<tr class="memdesc:a21b8bd40f0332c84bf71ef73d32bd91c"><td class="mdescLeft"> </td><td class="mdescRight">getNewestLedgerInfo Returns the info of the newest saved ledger. <br /></td></tr>
|
|
<tr class="separator:a21b8bd40f0332c84bf71ef73d32bd91c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae42b5ec856d806da94e9ebf4560e3ee4" id="r_ae42b5ec856d806da94e9ebf4560e3ee4"><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="namespaceripple.html#aaf521cde20561da32d6a54a105363555">LedgerInfo</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RelationalDatabase.html#ae42b5ec856d806da94e9ebf4560e3ee4">getLedgerInfoByHash</a> (<a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> const &ledgerHash)=0</td></tr>
|
|
<tr class="memdesc:ae42b5ec856d806da94e9ebf4560e3ee4"><td class="mdescLeft"> </td><td class="mdescRight">getLedgerInfoByHash Returns the info of the ledger with given hash. <br /></td></tr>
|
|
<tr class="separator:ae42b5ec856d806da94e9ebf4560e3ee4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae73b0356cc96e29c9c66e52f64aeac0d" id="r_ae73b0356cc96e29c9c66e52f64aeac0d"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RelationalDatabase.html#ae73b0356cc96e29c9c66e52f64aeac0d">getHashByIndex</a> (<a class="el" href="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd">LedgerIndex</a> ledgerIndex)=0</td></tr>
|
|
<tr class="memdesc:ae73b0356cc96e29c9c66e52f64aeac0d"><td class="mdescLeft"> </td><td class="mdescRight">getHashByIndex Returns the hash of the ledger with the given sequence. <br /></td></tr>
|
|
<tr class="separator:ae73b0356cc96e29c9c66e52f64aeac0d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9513642103dc26cb1b207e9a0a87074e" id="r_a9513642103dc26cb1b207e9a0a87074e"><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_1LedgerHashPair.html">LedgerHashPair</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RelationalDatabase.html#a9513642103dc26cb1b207e9a0a87074e">getHashesByIndex</a> (<a class="el" href="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd">LedgerIndex</a> ledgerIndex)=0</td></tr>
|
|
<tr class="memdesc:a9513642103dc26cb1b207e9a0a87074e"><td class="mdescLeft"> </td><td class="mdescRight">getHashesByIndex Returns the hashes of the ledger and its parent as specified by the ledgerIndex. <br /></td></tr>
|
|
<tr class="separator:a9513642103dc26cb1b207e9a0a87074e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae0ab4bafca46dbbfc446c3a540e2da9d" id="r_ae0ab4bafca46dbbfc446c3a540e2da9d"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/container/map.html">std::map</a>< <a class="el" href="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd">LedgerIndex</a>, <a class="el" href="structripple_1_1LedgerHashPair.html">LedgerHashPair</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RelationalDatabase.html#ae0ab4bafca46dbbfc446c3a540e2da9d">getHashesByIndex</a> (<a class="el" href="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd">LedgerIndex</a> minSeq, <a class="el" href="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd">LedgerIndex</a> maxSeq)=0</td></tr>
|
|
<tr class="memdesc:ae0ab4bafca46dbbfc446c3a540e2da9d"><td class="mdescLeft"> </td><td class="mdescRight">getHashesByIndex Returns hashes of each ledger and its parent for all ledgers within the provided range. <br /></td></tr>
|
|
<tr class="separator:ae0ab4bafca46dbbfc446c3a540e2da9d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a488a2779ee9aa65c2e349df6a99bad58" id="r_a488a2779ee9aa65c2e349df6a99bad58"><td class="memItemLeft" align="right" valign="top">virtual <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_1Transaction.html">Transaction</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RelationalDatabase.html#a488a2779ee9aa65c2e349df6a99bad58">getTxHistory</a> (<a class="el" href="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd">LedgerIndex</a> startIndex)=0</td></tr>
|
|
<tr class="memdesc:a488a2779ee9aa65c2e349df6a99bad58"><td class="mdescLeft"> </td><td class="mdescRight">getTxHistory Returns the 20 most recent transactions starting from the given number. <br /></td></tr>
|
|
<tr class="separator:a488a2779ee9aa65c2e349df6a99bad58"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7d4e0e3c03536c80901f72355139a483" id="r_a7d4e0e3c03536c80901f72355139a483"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RelationalDatabase.html#a7d4e0e3c03536c80901f72355139a483">ledgerDbHasSpace</a> (<a class="el" href="classripple_1_1Config.html">Config</a> const &config)=0</td></tr>
|
|
<tr class="memdesc:a7d4e0e3c03536c80901f72355139a483"><td class="mdescLeft"> </td><td class="mdescRight">ledgerDbHasSpace Checks if the ledger database has available space. <br /></td></tr>
|
|
<tr class="separator:a7d4e0e3c03536c80901f72355139a483"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a59c527306560ba3cf9d774fc73ee29a4" id="r_a59c527306560ba3cf9d774fc73ee29a4"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RelationalDatabase.html#a59c527306560ba3cf9d774fc73ee29a4">transactionDbHasSpace</a> (<a class="el" href="classripple_1_1Config.html">Config</a> const &config)=0</td></tr>
|
|
<tr class="memdesc:a59c527306560ba3cf9d774fc73ee29a4"><td class="mdescLeft"> </td><td class="mdescRight">transactionDbHasSpace Checks if the transaction database has available space. <br /></td></tr>
|
|
<tr class="separator:a59c527306560ba3cf9d774fc73ee29a4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
|
|
Static Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a7f08e20557d394e761662ff29373f467" id="r_a7f08e20557d394e761662ff29373f467"><td class="memItemLeft" align="right" valign="top">static <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/unique_ptr.html">std::unique_ptr</a>< <a class="el" href="classripple_1_1RelationalDatabase.html">RelationalDatabase</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RelationalDatabase.html#a7f08e20557d394e761662ff29373f467">init</a> (<a class="el" href="classripple_1_1Application.html">Application</a> &app, <a class="el" href="classripple_1_1Config.html">Config</a> const &config, <a class="el" href="classripple_1_1JobQueue.html">JobQueue</a> &jobQueue)</td></tr>
|
|
<tr class="memdesc:a7f08e20557d394e761662ff29373f467"><td class="mdescLeft"> </td><td class="mdescRight">init Creates and returns an appropriate <a class="el" href="classripple_1_1RelationalDatabase.html">RelationalDatabase</a> instance based on configuration. <br /></td></tr>
|
|
<tr class="separator:a7f08e20557d394e761662ff29373f467"><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="RelationalDatabase_8h_source.html#l00030">30</a> of file <a class="el" href="RelationalDatabase_8h_source.html">RelationalDatabase.h</a>.</p>
|
|
</div><h2 class="groupheader">Member Typedef Documentation</h2>
|
|
<a id="a251e55e3d5aa9b4e4d1a7eebe2157d46" name="a251e55e3d5aa9b4e4d1a7eebe2157d46"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a251e55e3d5aa9b4e4d1a7eebe2157d46">◆ </a></span>AccountTx</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="classripple_1_1RelationalDatabase.html#a251e55e3d5aa9b4e4d1a7eebe2157d46">ripple::RelationalDatabase::AccountTx</a> = <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/memory/shared_ptr.html">std::shared_ptr</a><<a class="el" href="classripple_1_1Transaction.html">Transaction</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_1TxMeta.html">TxMeta</a>> ></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="RelationalDatabase_8h_source.html#l00066">66</a> of file <a class="el" href="RelationalDatabase_8h_source.html">RelationalDatabase.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1af9139d7f4c8f662c7b8e49473a21e2" name="a1af9139d7f4c8f662c7b8e49473a21e2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1af9139d7f4c8f662c7b8e49473a21e2">◆ </a></span>AccountTxs</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="classripple_1_1RelationalDatabase.html#a1af9139d7f4c8f662c7b8e49473a21e2">ripple::RelationalDatabase::AccountTxs</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a><<a class="el" href="classripple_1_1RelationalDatabase.html#a251e55e3d5aa9b4e4d1a7eebe2157d46">AccountTx</a>></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="RelationalDatabase_8h_source.html#l00068">68</a> of file <a class="el" href="RelationalDatabase_8h_source.html">RelationalDatabase.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad49d721f8f069c1ee9652b93a3485423" name="ad49d721f8f069c1ee9652b93a3485423"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad49d721f8f069c1ee9652b93a3485423">◆ </a></span>txnMetaLedgerType</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="classripple_1_1RelationalDatabase.html#ad49d721f8f069c1ee9652b93a3485423">ripple::RelationalDatabase::txnMetaLedgerType</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/tuple.html">std::tuple</a><<a class="el" href="namespaceripple.html#ab1f2184bb5938b5508798cd47a561a21">Blob</a>, <a class="el" href="namespaceripple.html#ab1f2184bb5938b5508798cd47a561a21">Blob</a>, <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a>></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="RelationalDatabase_8h_source.html#l00069">69</a> of file <a class="el" href="RelationalDatabase_8h_source.html">RelationalDatabase.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a183ed7f35d368ec4564d8083fe9656f3" name="a183ed7f35d368ec4564d8083fe9656f3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a183ed7f35d368ec4564d8083fe9656f3">◆ </a></span>MetaTxsList</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="classripple_1_1RelationalDatabase.html#a183ed7f35d368ec4564d8083fe9656f3">ripple::RelationalDatabase::MetaTxsList</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a><<a class="el" href="classripple_1_1RelationalDatabase.html#ad49d721f8f069c1ee9652b93a3485423">txnMetaLedgerType</a>></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="RelationalDatabase_8h_source.html#l00070">70</a> of file <a class="el" href="RelationalDatabase_8h_source.html">RelationalDatabase.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="affdfbc3c5f0f2d7b78cc5570617a5fda" name="affdfbc3c5f0f2d7b78cc5570617a5fda"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#affdfbc3c5f0f2d7b78cc5570617a5fda">◆ </a></span>LedgerSequence</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="classripple_1_1RelationalDatabase.html#affdfbc3c5f0f2d7b78cc5570617a5fda">ripple::RelationalDatabase::LedgerSequence</a> = uint32_t</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="RelationalDatabase_8h_source.html#l00072">72</a> of file <a class="el" href="RelationalDatabase_8h_source.html">RelationalDatabase.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae6ed6a653c43698a1480c0230b1e99aa" name="ae6ed6a653c43698a1480c0230b1e99aa"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae6ed6a653c43698a1480c0230b1e99aa">◆ </a></span>LedgerHash</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="classripple_1_1RelationalDatabase.html#ae6ed6a653c43698a1480c0230b1e99aa">ripple::RelationalDatabase::LedgerHash</a> = <a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="RelationalDatabase_8h_source.html#l00073">73</a> of file <a class="el" href="RelationalDatabase_8h_source.html">RelationalDatabase.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a99c471461c2b0858d240f98034c6fda3" name="a99c471461c2b0858d240f98034c6fda3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a99c471461c2b0858d240f98034c6fda3">◆ </a></span>LedgerShortcut</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="namespaceripple_1_1RPC.html#a4c04e509451d50d9449cff3d477ff4f2">ripple::RelationalDatabase::LedgerShortcut</a> = <a class="el" href="namespaceripple_1_1RPC.html#a4c04e509451d50d9449cff3d477ff4f2">RPC::LedgerShortcut</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="RelationalDatabase_8h_source.html#l00074">74</a> of file <a class="el" href="RelationalDatabase_8h_source.html">RelationalDatabase.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae6edb30f534bd5669ee659789aa22e86" name="ae6edb30f534bd5669ee659789aa22e86"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae6edb30f534bd5669ee659789aa22e86">◆ </a></span>LedgerSpecifier</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="classripple_1_1RelationalDatabase.html#ae6edb30f534bd5669ee659789aa22e86">ripple::RelationalDatabase::LedgerSpecifier</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/variant.html">std::variant</a><<a class="el" href="structripple_1_1LedgerRange.html">LedgerRange</a>, <a class="el" href="namespaceripple_1_1RPC.html#a4c04e509451d50d9449cff3d477ff4f2">LedgerShortcut</a>, <a class="el" href="classripple_1_1RelationalDatabase.html#affdfbc3c5f0f2d7b78cc5570617a5fda">LedgerSequence</a>, <a class="el" href="classripple_1_1RelationalDatabase.html#ae6ed6a653c43698a1480c0230b1e99aa">LedgerHash</a>></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="RelationalDatabase_8h_source.html#l00075">75</a> of file <a class="el" href="RelationalDatabase_8h_source.html">RelationalDatabase.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a2aa37e3eb9fbd4f96a030b6188c4e9d2" name="a2aa37e3eb9fbd4f96a030b6188c4e9d2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2aa37e3eb9fbd4f96a030b6188c4e9d2">◆ </a></span>~RelationalDatabase()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual ripple::RelationalDatabase::~RelationalDatabase </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="a7f08e20557d394e761662ff29373f467" name="a7f08e20557d394e761662ff29373f467"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7f08e20557d394e761662ff29373f467">◆ </a></span>init()</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/memory/unique_ptr.html">std::unique_ptr</a>< <a class="el" href="classripple_1_1RelationalDatabase.html">RelationalDatabase</a> > ripple::RelationalDatabase::init </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1Application.html">Application</a> & </td>
|
|
<td class="paramname"><em>app</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1Config.html">Config</a> const & </td>
|
|
<td class="paramname"><em>config</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1JobQueue.html">JobQueue</a> & </td>
|
|
<td class="paramname"><em>jobQueue</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">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>init Creates and returns an appropriate <a class="el" href="classripple_1_1RelationalDatabase.html">RelationalDatabase</a> instance based on configuration. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">app</td><td><a class="el" href="classripple_1_1Application.html">Application</a> object. </td></tr>
|
|
<tr><td class="paramname">config</td><td><a class="el" href="classripple_1_1Config.html">Config</a> object. </td></tr>
|
|
<tr><td class="paramname">jobQueue</td><td><a class="el" href="classripple_1_1JobQueue.html" title="A pool of threads to perform work.">JobQueue</a> object. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Unique pointer to the interface. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="RelationalDatabase_8cpp_source.html#l00011">11</a> of file <a class="el" href="RelationalDatabase_8cpp_source.html">RelationalDatabase.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="acf44d77817b8dab02b31c974817aaa29" name="acf44d77817b8dab02b31c974817aaa29"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acf44d77817b8dab02b31c974817aaa29">◆ </a></span>getMinLedgerSeq()</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="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd">LedgerIndex</a> > ripple::RelationalDatabase::getMinLedgerSeq </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>getMinLedgerSeq Returns the minimum ledger sequence in the Ledgers table. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classripple_1_1Ledger.html" title="Holds a ledger.">Ledger</a> sequence or no value if no ledgers exist. </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1SQLiteDatabaseImp.html#a8730d0f70b92408cf5be5e83715ffb07">ripple::SQLiteDatabaseImp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6e5c168f1ca0906e6df4b07e488863aa" name="a6e5c168f1ca0906e6df4b07e488863aa"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6e5c168f1ca0906e6df4b07e488863aa">◆ </a></span>getMaxLedgerSeq()</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="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd">LedgerIndex</a> > ripple::RelationalDatabase::getMaxLedgerSeq </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>getMaxLedgerSeq Returns the maximum ledger sequence in the Ledgers table. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classripple_1_1Ledger.html" title="Holds a ledger.">Ledger</a> sequence or none if no ledgers exist. </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1SQLiteDatabaseImp.html#a2654ba0e88a9e8aaa0e6686d90edf4ca">ripple::SQLiteDatabaseImp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a388e80415da1da75b45ecf011a64f5dd" name="a388e80415da1da75b45ecf011a64f5dd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a388e80415da1da75b45ecf011a64f5dd">◆ </a></span>getLedgerInfoByIndex()</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="namespaceripple.html#aaf521cde20561da32d6a54a105363555">LedgerInfo</a> > ripple::RelationalDatabase::getLedgerInfoByIndex </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd">LedgerIndex</a> </td>
|
|
<td class="paramname"><em>ledgerSeq</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>getLedgerInfoByIndex Returns a ledger by its sequence. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ledgerSeq</td><td><a class="el" href="classripple_1_1Ledger.html" title="Holds a ledger.">Ledger</a> sequence. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The ledger if found, otherwise no value. </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1SQLiteDatabaseImp.html#af98c9aa88ce231f95164cec02e58ed0d">ripple::SQLiteDatabaseImp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a21b8bd40f0332c84bf71ef73d32bd91c" name="a21b8bd40f0332c84bf71ef73d32bd91c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a21b8bd40f0332c84bf71ef73d32bd91c">◆ </a></span>getNewestLedgerInfo()</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="namespaceripple.html#aaf521cde20561da32d6a54a105363555">LedgerInfo</a> > ripple::RelationalDatabase::getNewestLedgerInfo </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>getNewestLedgerInfo Returns the info of the newest saved ledger. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classripple_1_1Ledger.html" title="Holds a ledger.">Ledger</a> info if found, otherwise no value. </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1SQLiteDatabaseImp.html#a1416bd1f665f27453f8dce95f0818fbb">ripple::SQLiteDatabaseImp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae42b5ec856d806da94e9ebf4560e3ee4" name="ae42b5ec856d806da94e9ebf4560e3ee4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae42b5ec856d806da94e9ebf4560e3ee4">◆ </a></span>getLedgerInfoByHash()</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="namespaceripple.html#aaf521cde20561da32d6a54a105363555">LedgerInfo</a> > ripple::RelationalDatabase::getLedgerInfoByHash </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> const & </td>
|
|
<td class="paramname"><em>ledgerHash</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>getLedgerInfoByHash Returns the info of the ledger with given hash. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ledgerHash</td><td>Hash of the ledger. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classripple_1_1Ledger.html" title="Holds a ledger.">Ledger</a> if found, otherwise no value. </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1SQLiteDatabaseImp.html#a575ad184e70064a3e324ea435fa58333">ripple::SQLiteDatabaseImp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae73b0356cc96e29c9c66e52f64aeac0d" name="ae73b0356cc96e29c9c66e52f64aeac0d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae73b0356cc96e29c9c66e52f64aeac0d">◆ </a></span>getHashByIndex()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> ripple::RelationalDatabase::getHashByIndex </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd">LedgerIndex</a> </td>
|
|
<td class="paramname"><em>ledgerIndex</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>getHashByIndex Returns the hash of the ledger with the given sequence. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ledgerIndex</td><td><a class="el" href="classripple_1_1Ledger.html" title="Holds a ledger.">Ledger</a> sequence. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Hash of the ledger. </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1SQLiteDatabaseImp.html#ad7796a6d5a4a4b0a7fd7feb7e23f612b">ripple::SQLiteDatabaseImp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9513642103dc26cb1b207e9a0a87074e" name="a9513642103dc26cb1b207e9a0a87074e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9513642103dc26cb1b207e9a0a87074e">◆ </a></span>getHashesByIndex() <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/utility/optional.html">std::optional</a>< <a class="el" href="structripple_1_1LedgerHashPair.html">LedgerHashPair</a> > ripple::RelationalDatabase::getHashesByIndex </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd">LedgerIndex</a> </td>
|
|
<td class="paramname"><em>ledgerIndex</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>getHashesByIndex Returns the hashes of the ledger and its parent as specified by the ledgerIndex. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ledgerIndex</td><td><a class="el" href="classripple_1_1Ledger.html" title="Holds a ledger.">Ledger</a> sequence. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Struct <a class="el" href="structripple_1_1LedgerHashPair.html">LedgerHashPair</a> which contains hashes of the ledger and its parent. </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1SQLiteDatabaseImp.html#a8e0a657a3892d93fdf957d892f1729c2">ripple::SQLiteDatabaseImp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae0ab4bafca46dbbfc446c3a540e2da9d" name="ae0ab4bafca46dbbfc446c3a540e2da9d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae0ab4bafca46dbbfc446c3a540e2da9d">◆ </a></span>getHashesByIndex() <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/container/map.html">std::map</a>< <a class="el" href="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd">LedgerIndex</a>, <a class="el" href="structripple_1_1LedgerHashPair.html">LedgerHashPair</a> > ripple::RelationalDatabase::getHashesByIndex </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd">LedgerIndex</a> </td>
|
|
<td class="paramname"><em>minSeq</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd">LedgerIndex</a> </td>
|
|
<td class="paramname"><em>maxSeq</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">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>getHashesByIndex Returns hashes of each ledger and its parent for all ledgers within the provided range. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">minSeq</td><td>Minimum ledger sequence. </td></tr>
|
|
<tr><td class="paramname">maxSeq</td><td>Maximum ledger sequence. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Container that maps the sequence number of a found ledger to the struct <a class="el" href="structripple_1_1LedgerHashPair.html">LedgerHashPair</a> which contains the hashes of the ledger and its parent. </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1SQLiteDatabaseImp.html#a5eb08bfeccc246735821bbd45a82c4b2">ripple::SQLiteDatabaseImp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a488a2779ee9aa65c2e349df6a99bad58" name="a488a2779ee9aa65c2e349df6a99bad58"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a488a2779ee9aa65c2e349df6a99bad58">◆ </a></span>getTxHistory()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a>< <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>< <a class="el" href="classripple_1_1Transaction.html">Transaction</a> > > ripple::RelationalDatabase::getTxHistory </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd">LedgerIndex</a> </td>
|
|
<td class="paramname"><em>startIndex</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>getTxHistory Returns the 20 most recent transactions starting from the given number. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">startIndex</td><td>First number of returned entry. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Vector of shared pointers to transactions sorted in descending order by ledger sequence. </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1SQLiteDatabaseImp.html#a95e09f3d9aad4bddd230a858ebc523f0">ripple::SQLiteDatabaseImp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7d4e0e3c03536c80901f72355139a483" name="a7d4e0e3c03536c80901f72355139a483"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7d4e0e3c03536c80901f72355139a483">◆ </a></span>ledgerDbHasSpace()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual bool ripple::RelationalDatabase::ledgerDbHasSpace </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1Config.html">Config</a> const & </td>
|
|
<td class="paramname"><em>config</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>ledgerDbHasSpace Checks if the ledger database has available space. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">config</td><td><a class="el" href="classripple_1_1Config.html">Config</a> object. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if space is available. </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1SQLiteDatabaseImp.html#a311a803593ac3b5ce62b3263f4d298bd">ripple::SQLiteDatabaseImp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a59c527306560ba3cf9d774fc73ee29a4" name="a59c527306560ba3cf9d774fc73ee29a4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a59c527306560ba3cf9d774fc73ee29a4">◆ </a></span>transactionDbHasSpace()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual bool ripple::RelationalDatabase::transactionDbHasSpace </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1Config.html">Config</a> const & </td>
|
|
<td class="paramname"><em>config</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>transactionDbHasSpace Checks if the transaction database has available space. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">config</td><td><a class="el" href="classripple_1_1Config.html">Config</a> object. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if space is available. </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1SQLiteDatabaseImp.html#a004a13d01781eb4ffd043a0934c99b39">ripple::SQLiteDatabaseImp</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>
|