mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-26 22:15:52 +00:00
147 lines
16 KiB
HTML
147 lines
16 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: Shard.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><li class="navelem"><a class="el" href="dir_5801419af67c8679bcbb6d027b870574.html">detail</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">app/rdb/backend/detail/Shard.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_DETAIL_SHARD_H_INCLUDED</span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define RIPPLE_APP_RDB_BACKEND_DETAIL_SHARD_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/ledger/Ledger.h></span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <ripple/app/rdb/RelationalDatabase.h></span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <ripple/app/rdb/UnitaryShard.h></span></div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <ripple/core/Config.h></span></div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <ripple/protocol/RippleLedgerHash.h></span></div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include <boost/filesystem.hpp></span></div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  </div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">namespace </span><a class="code" href="namespaceripple.html">ripple</a> {</div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">namespace </span>detail {</div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  </div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> DatabasePair</div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <a class="code" href="namespaceripple_1_1detail.html#a131118ac74fb5f75f95f3cc038d9240c">makeMetaDBs</a>(</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  Config <span class="keyword">const</span>& config,</div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  DatabaseCon::Setup <span class="keyword">const</span>& setup,</div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  DatabaseCon::CheckpointerSetup <span class="keyword">const</span>& checkpointerSetup);</div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  </div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="keywordtype">bool</span></div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <a class="code" href="namespaceripple_1_1detail.html#ab91a734fd58da3e9628afe37bd4b6204">saveLedgerMeta</a>(</div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr<Ledger const></a> <span class="keyword">const</span>& ledger,</div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  Application& app,</div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  soci::session& lgrMetaSession,</div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  soci::session& txnMetaSession,</div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> shardIndex);</div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  </div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional<std::uint32_t></a></div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <a class="code" href="namespaceripple_1_1detail.html#ad54aa93bcb0bf57d942f1b9bb54f8d16">getShardIndexforLedger</a>(soci::session& session, <a class="code" href="namespaceripple.html#af5a72d3e0d9b6913c13f688390b90796">LedgerHash</a> <span class="keyword">const</span>& hash);</div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  </div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional<std::uint32_t></a></div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <a class="code" href="namespaceripple_1_1detail.html#ab126eebd8d37a5cfee0882a45977d1d9">getShardIndexforTransaction</a>(soci::session& session, <a class="code" href="namespaceripple.html#a3f39560bfd60c64700b109c412e90f72">TxID</a> <span class="keyword">const</span>& <span class="keywordtype">id</span>);</div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  </div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> } <span class="comment">// namespace detail</span></div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> } <span class="comment">// namespace ripple</span></div>
|
|
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  </div>
|
|
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="preprocessor">#endif</span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<div class="ttc" id="anamespaceripple_1_1detail_html_ab126eebd8d37a5cfee0882a45977d1d9"><div class="ttname"><a href="namespaceripple_1_1detail.html#ab126eebd8d37a5cfee0882a45977d1d9">ripple::detail::getShardIndexforTransaction</a></div><div class="ttdeci">std::optional< std::uint32_t > getShardIndexforTransaction(soci::session &session, TxID const &id)</div><div class="ttdoc">getShardIndexforTransaction Queries the transaction meta database to retrieve the index of the shard ...</div><div class="ttdef"><b>Definition:</b> <a href="app_2rdb_2backend_2detail_2impl_2Shard_8cpp_source.html#l00131">app/rdb/backend/detail/impl/Shard.cpp:131</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_html_af5a72d3e0d9b6913c13f688390b90796"><div class="ttname"><a href="namespaceripple.html#af5a72d3e0d9b6913c13f688390b90796">ripple::LedgerHash</a></div><div class="ttdeci">uint256 LedgerHash</div><div class="ttdef"><b>Definition:</b> <a href="RippleLedgerHash_8h_source.html#l00027">RippleLedgerHash.h:27</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_html_a3f39560bfd60c64700b109c412e90f72"><div class="ttname"><a href="namespaceripple.html#a3f39560bfd60c64700b109c412e90f72">ripple::TxID</a></div><div class="ttdeci">uint256 TxID</div><div class="ttdoc">A transaction identifier.</div><div class="ttdef"><b>Definition:</b> <a href="Protocol_8h_source.html#l00096">Protocol.h:96</a></div></div>
|
|
<div class="ttc" id="ashared_ptr_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a></div><div class="ttdoc">STL class.</div></div>
|
|
<div class="ttc" id="anamespaceripple_1_1detail_html_ab91a734fd58da3e9628afe37bd4b6204"><div class="ttname"><a href="namespaceripple_1_1detail.html#ab91a734fd58da3e9628afe37bd4b6204">ripple::detail::saveLedgerMeta</a></div><div class="ttdeci">bool saveLedgerMeta(std::shared_ptr< Ledger const > const &ledger, Application &app, soci::session &lgrMetaSession, soci::session &txnMetaSession, std::uint32_t const shardIndex)</div><div class="ttdoc">saveLedgerMeta Stores (transaction ID -> shard index) and (ledger hash -> shard index) mappings in th...</div><div class="ttdef"><b>Definition:</b> <a href="app_2rdb_2backend_2detail_2impl_2Shard_8cpp_source.html#l00056">app/rdb/backend/detail/impl/Shard.cpp:56</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_1_1detail_html_a131118ac74fb5f75f95f3cc038d9240c"><div class="ttname"><a href="namespaceripple_1_1detail.html#a131118ac74fb5f75f95f3cc038d9240c">ripple::detail::makeMetaDBs</a></div><div class="ttdeci">DatabasePair makeMetaDBs(Config const &config, DatabaseCon::Setup const &setup, DatabaseCon::CheckpointerSetup const &checkpointerSetup)</div><div class="ttdoc">makeMetaDBs Opens ledger and transaction 'meta' databases which map ledger hashes and transaction IDs...</div><div class="ttdef"><b>Definition:</b> <a href="app_2rdb_2backend_2detail_2impl_2Shard_8cpp_source.html#l00032">app/rdb/backend/detail/impl/Shard.cpp:32</a></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_1_1detail_html_ad54aa93bcb0bf57d942f1b9bb54f8d16"><div class="ttname"><a href="namespaceripple_1_1detail.html#ad54aa93bcb0bf57d942f1b9bb54f8d16">ripple::detail::getShardIndexforLedger</a></div><div class="ttdeci">std::optional< std::uint32_t > getShardIndexforLedger(soci::session &session, LedgerHash const &hash)</div><div class="ttdoc">getShardIndexforLedger Queries the ledger meta database to retrieve the index of the shard that conta...</div><div class="ttdef"><b>Definition:</b> <a href="app_2rdb_2backend_2detail_2impl_2Shard_8cpp_source.html#l00117">app/rdb/backend/detail/impl/Shard.cpp:117</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="aoptional_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional< std::uint32_t ></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>
|