mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-23 20:45:51 +00:00
164 lines
20 KiB
HTML
164 lines
20 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: PostgresDatabase.h Source File</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="dir_df9c78dcf3f59a33b12284f95992a64b.html">ripple</a></li><li class="navelem"><a class="el" href="dir_9f69212e4c6e2ca9ec5ab59cd7b6275c.html">app</a></li><li class="navelem"><a class="el" href="dir_6fe6f4dca26289abeb8b3619a8f9ad32.html">rdb</a></li><li class="navelem"><a class="el" href="dir_1ae1364b37866bc8f8141af60c9f44a5.html">backend</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">PostgresDatabase.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">//------------------------------------------------------------------------------</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> This file is part of rippled: https://github.com/ripple/rippled</span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> Copyright (c) 2020 Ripple Labs Inc.</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> Permission to use, copy, modify, and/or distribute this software for any</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> purpose with or without fee is hereby granted, provided that the above</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> copyright notice and this permission notice appear in all copies.</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF</span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES</span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF</span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">//==============================================================================</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  </div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#ifndef RIPPLE_APP_RDB_BACKEND_POSTGRESDATABASE_H_INCLUDED</span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define RIPPLE_APP_RDB_BACKEND_POSTGRESDATABASE_H_INCLUDED</span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  </div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <ripple/app/rdb/RelationalDatabase.h></span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  </div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="keyword">namespace </span><a class="code" href="namespaceripple.html">ripple</a> {</div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  </div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="classripple_1_1PostgresDatabase.html"> 27</a></span> <span class="keyword">class </span><a class="code" href="classripple_1_1PostgresDatabase.html">PostgresDatabase</a> : <span class="keyword">public</span> <a class="code" href="classripple_1_1RelationalDatabase.html">RelationalDatabase</a></div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> {</div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span></div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <a class="code" href="classripple_1_1PostgresDatabase.html#a777dd8559a055cca317f9525694be1c4">stop</a>() = 0;</div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  </div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span></div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <a class="code" href="classripple_1_1PostgresDatabase.html#ad14da01d1b10dbcc73c16b729ed67b1a">sweep</a>() = 0;</div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  </div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keyword">virtual</span> <a class="codeRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a></div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <a class="code" href="classripple_1_1PostgresDatabase.html#a638a2672a99fd56dc7c534a65de82422">getCompleteLedgers</a>() = 0;</div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  </div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keyword">virtual</span> <a class="codeRef" href="http://en.cppreference.com/w/cpp/chrono/duration.html">std::chrono::seconds</a></div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <a class="code" href="classripple_1_1PostgresDatabase.html#acbad8709817f45cb6879fd6bbb8168d9">getValidatedLedgerAge</a>() = 0;</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  </div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span></div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <a class="code" href="classripple_1_1PostgresDatabase.html#a80ccf4e291a450fb7dda321479677e32">writeLedgerAndTransactions</a>(</div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <a class="code" href="structripple_1_1LedgerInfo.html">LedgerInfo</a> <span class="keyword">const</span>& info,</div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector<AccountTransactionsData></a> <span class="keyword">const</span>& accountTxData) = 0;</div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  </div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keyword">virtual</span> <a class="codeRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector<uint256></a></div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <a class="code" href="classripple_1_1PostgresDatabase.html#a784583e95d607018791e7073784bd04d">getTxHashes</a>(<a class="codeRef" href="http://en.cppreference.com/w/cpp/types/integer.html">LedgerIndex</a> seq) = 0;</div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  </div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keyword">virtual</span> <a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair<AccountTxResult, RPC::Status></a></div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <a class="code" href="classripple_1_1PostgresDatabase.html#af006b47c3c1caa59cc062700a4d41741">getAccountTx</a>(<a class="code" href="structripple_1_1RelationalDatabase_1_1AccountTxArgs.html">AccountTxArgs</a> <span class="keyword">const</span>& args) = 0;</div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  </div>
|
|
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keyword">virtual</span> <a class="code" href="structripple_1_1Transaction_1_1Locator.html">Transaction::Locator</a></div>
|
|
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <a class="code" href="classripple_1_1PostgresDatabase.html#a7ba9f944c4586b5b93018d828ace12b8">locateTransaction</a>(<a class="code" href="classripple_1_1base__uint.html">uint256</a> <span class="keyword">const</span>& <span class="keywordtype">id</span>) = 0;</div>
|
|
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  </div>
|
|
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span></div>
|
|
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <a class="code" href="classripple_1_1PostgresDatabase.html#aeff0aabad25764e5b7bd22acfd9c3a82">isCaughtUp</a>(<a class="codeRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a>& reason) = 0;</div>
|
|
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> };</div>
|
|
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  </div>
|
|
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> } <span class="comment">// namespace ripple</span></div>
|
|
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  </div>
|
|
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="preprocessor">#endif</span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<div class="ttc" id="aclassripple_1_1PostgresDatabase_html_a784583e95d607018791e7073784bd04d"><div class="ttname"><a href="classripple_1_1PostgresDatabase.html#a784583e95d607018791e7073784bd04d">ripple::PostgresDatabase::getTxHashes</a></div><div class="ttdeci">virtual std::vector< uint256 > getTxHashes(LedgerIndex seq)=0</div><div class="ttdoc">getTxHashes Returns a vector of the hashes of transactions belonging to the ledger with the provided ...</div></div>
|
|
<div class="ttc" id="abasic_string_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a></div><div class="ttdoc">STL class.</div></div>
|
|
<div class="ttc" id="astructripple_1_1RelationalDatabase_1_1AccountTxArgs_html"><div class="ttname"><a href="structripple_1_1RelationalDatabase_1_1AccountTxArgs.html">ripple::RelationalDatabase::AccountTxArgs</a></div><div class="ttdef"><b>Definition:</b> <a href="RelationalDatabase_8h_source.html#l00096">RelationalDatabase.h:96</a></div></div>
|
|
<div class="ttc" id="apair_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1PostgresDatabase_html_a638a2672a99fd56dc7c534a65de82422"><div class="ttname"><a href="classripple_1_1PostgresDatabase.html#a638a2672a99fd56dc7c534a65de82422">ripple::PostgresDatabase::getCompleteLedgers</a></div><div class="ttdeci">virtual std::string getCompleteLedgers()=0</div><div class="ttdoc">getCompleteLedgers Returns a string which contains a list of completed ledgers.</div></div>
|
|
<div class="ttc" id="avector_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a></div><div class="ttdoc">STL class.</div></div>
|
|
<div class="ttc" id="aduration_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/chrono/duration.html">std::chrono::seconds</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1PostgresDatabase_html_a7ba9f944c4586b5b93018d828ace12b8"><div class="ttname"><a href="classripple_1_1PostgresDatabase.html#a7ba9f944c4586b5b93018d828ace12b8">ripple::PostgresDatabase::locateTransaction</a></div><div class="ttdeci">virtual Transaction::Locator locateTransaction(uint256 const &id)=0</div><div class="ttdoc">locateTransaction Returns information used to locate a transaction.</div></div>
|
|
<div class="ttc" id="aclassripple_1_1PostgresDatabase_html_a777dd8559a055cca317f9525694be1c4"><div class="ttname"><a href="classripple_1_1PostgresDatabase.html#a777dd8559a055cca317f9525694be1c4">ripple::PostgresDatabase::stop</a></div><div class="ttdeci">virtual void stop()=0</div></div>
|
|
<div class="ttc" id="aclassripple_1_1PostgresDatabase_html_af006b47c3c1caa59cc062700a4d41741"><div class="ttname"><a href="classripple_1_1PostgresDatabase.html#af006b47c3c1caa59cc062700a4d41741">ripple::PostgresDatabase::getAccountTx</a></div><div class="ttdeci">virtual std::pair< AccountTxResult, RPC::Status > getAccountTx(AccountTxArgs const &args)=0</div><div class="ttdoc">getAccountTx Get the last account transactions specified by the AccountTxArgs struct.</div></div>
|
|
<div class="ttc" id="aclassripple_1_1PostgresDatabase_html_acbad8709817f45cb6879fd6bbb8168d9"><div class="ttname"><a href="classripple_1_1PostgresDatabase.html#acbad8709817f45cb6879fd6bbb8168d9">ripple::PostgresDatabase::getValidatedLedgerAge</a></div><div class="ttdeci">virtual std::chrono::seconds getValidatedLedgerAge()=0</div><div class="ttdoc">getValidatedLedgerAge Returns the age of the last validated ledger.</div></div>
|
|
<div class="ttc" id="aclassripple_1_1base__uint_html"><div class="ttname"><a href="classripple_1_1base__uint.html">ripple::base_uint< 256 ></a></div></div>
|
|
<div class="ttc" id="astructripple_1_1Transaction_1_1Locator_html"><div class="ttname"><a href="structripple_1_1Transaction_1_1Locator.html">ripple::Transaction::Locator</a></div><div class="ttdef"><b>Definition:</b> <a href="Transaction_8h_source.html#l00315">Transaction.h:315</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1PostgresDatabase_html_ad14da01d1b10dbcc73c16b729ed67b1a"><div class="ttname"><a href="classripple_1_1PostgresDatabase.html#ad14da01d1b10dbcc73c16b729ed67b1a">ripple::PostgresDatabase::sweep</a></div><div class="ttdeci">virtual void sweep()=0</div><div class="ttdoc">sweep Sweeps the database.</div></div>
|
|
<div class="ttc" id="ainteger_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_html"><div class="ttname"><a href="namespaceripple.html">ripple</a></div><div class="ttdoc">Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.</div><div class="ttdef"><b>Definition:</b> <a href="RCLCensorshipDetector_8h_source.html#l00029">RCLCensorshipDetector.h:29</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1PostgresDatabase_html_a80ccf4e291a450fb7dda321479677e32"><div class="ttname"><a href="classripple_1_1PostgresDatabase.html#a80ccf4e291a450fb7dda321479677e32">ripple::PostgresDatabase::writeLedgerAndTransactions</a></div><div class="ttdeci">virtual bool writeLedgerAndTransactions(LedgerInfo const &info, std::vector< AccountTransactionsData > const &accountTxData)=0</div><div class="ttdoc">writeLedgerAndTransactions Writes new ledger and transaction data into the database.</div></div>
|
|
<div class="ttc" id="aclassripple_1_1PostgresDatabase_html_aeff0aabad25764e5b7bd22acfd9c3a82"><div class="ttname"><a href="classripple_1_1PostgresDatabase.html#aeff0aabad25764e5b7bd22acfd9c3a82">ripple::PostgresDatabase::isCaughtUp</a></div><div class="ttdeci">virtual bool isCaughtUp(std::string &reason)=0</div><div class="ttdoc">isCaughtUp returns whether the database is caught up with the network</div></div>
|
|
<div class="ttc" id="aclassripple_1_1PostgresDatabase_html"><div class="ttname"><a href="classripple_1_1PostgresDatabase.html">ripple::PostgresDatabase</a></div><div class="ttdef"><b>Definition:</b> <a href="PostgresDatabase_8h_source.html#l00027">PostgresDatabase.h:27</a></div></div>
|
|
<div class="ttc" id="astructripple_1_1LedgerInfo_html"><div class="ttname"><a href="structripple_1_1LedgerInfo.html">ripple::LedgerInfo</a></div><div class="ttdoc">Information about the notional ledger backing the view.</div><div class="ttdef"><b>Definition:</b> <a href="ReadView_8h_source.html#l00075">ReadView.h:75</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1RelationalDatabase_html"><div class="ttname"><a href="classripple_1_1RelationalDatabase.html">ripple::RelationalDatabase</a></div><div class="ttdef"><b>Definition:</b> <a href="RelationalDatabase_8h_source.html#l00048">RelationalDatabase.h:48</a></div></div>
|
|
<!-- 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>
|