mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-23 12:35:50 +00:00
158 lines
19 KiB
HTML
158 lines
19 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: State.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> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">State.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) 2021 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_STATE_H_INCLUDED</span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define RIPPLE_APP_RDB_STATE_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/misc/Manifest.h></span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <ripple/core/Config.h></span></div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <ripple/core/DatabaseCon.h></span></div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <ripple/overlay/PeerReservationTable.h></span></div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include <ripple/peerfinder/impl/Store.h></span></div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include <boost/filesystem.hpp></span></div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  </div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">namespace </span><a class="code" href="namespaceripple.html">ripple</a> {</div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  </div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="structripple_1_1SavedState.html"> 33</a></span> <span class="keyword">struct </span><a class="code" href="structripple_1_1SavedState.html">SavedState</a></div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> {</div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="structripple_1_1SavedState.html#a8d0a999fae5b415d6d3570ee17699920"> 35</a></span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> <a class="code" href="structripple_1_1SavedState.html#a8d0a999fae5b415d6d3570ee17699920">writableDb</a>;</div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="structripple_1_1SavedState.html#adda68d802d02c0d2aaeefc12b32727e3"> 36</a></span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> <a class="code" href="structripple_1_1SavedState.html#adda68d802d02c0d2aaeefc12b32727e3">archiveDb</a>;</div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="structripple_1_1SavedState.html#a8ca46a5d6d09ecd87222b337edc04729"> 37</a></span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/integer.html">LedgerIndex</a> <a class="code" href="structripple_1_1SavedState.html#a8ca46a5d6d09ecd87222b337edc04729">lastRotated</a>;</div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> };</div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  </div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="keywordtype">void</span></div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <a class="code" href="namespaceripple.html#a632dcd1160907dbaea1cd6caceca886c">initStateDB</a>(</div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  soci::session& session,</div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <a class="code" href="classripple_1_1BasicConfig.html">BasicConfig</a> <span class="keyword">const</span>& config,</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> <span class="keyword">const</span>& dbName);</div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  </div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/integer.html">LedgerIndex</a></div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <a class="code" href="namespaceripple.html#a0fe94e7b03d864a38651a484be4c89d3">getCanDelete</a>(soci::session& session);</div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  </div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/integer.html">LedgerIndex</a></div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <a class="code" href="namespaceripple.html#aab972dc5eb4ccbbb4a0a0d0b83042723">setCanDelete</a>(soci::session& session, <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/integer.html">LedgerIndex</a> canDelete);</div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  </div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <a class="code" href="structripple_1_1SavedState.html">SavedState</a></div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <a class="code" href="namespaceripple.html#a1d7270f000f7f70eb39a3812d17a17bb">getSavedState</a>(soci::session& session);</div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  </div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="keywordtype">void</span></div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <a class="code" href="namespaceripple.html#a4ebc529465484d38823ec8fcd242176a">setSavedState</a>(soci::session& session, <a class="code" href="structripple_1_1SavedState.html">SavedState</a> <span class="keyword">const</span>& state);</div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  </div>
|
|
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="keywordtype">void</span></div>
|
|
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <a class="code" href="namespaceripple.html#aefa79f90126517a5b18ac63f899a9138">setLastRotated</a>(soci::session& session, <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/integer.html">LedgerIndex</a> seq);</div>
|
|
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  </div>
|
|
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> } <span class="comment">// namespace ripple</span></div>
|
|
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  </div>
|
|
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="preprocessor">#endif</span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<div class="ttc" id="anamespaceripple_html_aab972dc5eb4ccbbb4a0a0d0b83042723"><div class="ttname"><a href="namespaceripple.html#aab972dc5eb4ccbbb4a0a0d0b83042723">ripple::setCanDelete</a></div><div class="ttdeci">LedgerIndex setCanDelete(soci::session &session, LedgerIndex canDelete)</div><div class="ttdoc">setCanDelete Updates the ledger sequence which can be deleted.</div><div class="ttdef"><b>Definition:</b> <a href="State_8cpp_source.html#l00091">State.cpp:91</a></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="anamespaceripple_html_a4ebc529465484d38823ec8fcd242176a"><div class="ttname"><a href="namespaceripple.html#a4ebc529465484d38823ec8fcd242176a">ripple::setSavedState</a></div><div class="ttdeci">void setSavedState(soci::session &session, SavedState const &state)</div><div class="ttdoc">setSavedState Saves the given state.</div><div class="ttdef"><b>Definition:</b> <a href="State_8cpp_source.html#l00111">State.cpp:111</a></div></div>
|
|
<div class="ttc" id="astructripple_1_1SavedState_html_a8d0a999fae5b415d6d3570ee17699920"><div class="ttname"><a href="structripple_1_1SavedState.html#a8d0a999fae5b415d6d3570ee17699920">ripple::SavedState::writableDb</a></div><div class="ttdeci">std::string writableDb</div><div class="ttdef"><b>Definition:</b> <a href="State_8h_source.html#l00035">State.h:35</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_html_a632dcd1160907dbaea1cd6caceca886c"><div class="ttname"><a href="namespaceripple.html#a632dcd1160907dbaea1cd6caceca886c">ripple::initStateDB</a></div><div class="ttdeci">void initStateDB(soci::session &session, BasicConfig const &config, std::string const &dbName)</div><div class="ttdoc">initStateDB Opens a session with the State database.</div><div class="ttdef"><b>Definition:</b> <a href="State_8cpp_source.html#l00025">State.cpp:25</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_html_a1d7270f000f7f70eb39a3812d17a17bb"><div class="ttname"><a href="namespaceripple.html#a1d7270f000f7f70eb39a3812d17a17bb">ripple::getSavedState</a></div><div class="ttdeci">SavedState getSavedState(soci::session &session)</div><div class="ttdoc">getSavedState Returns the saved state.</div><div class="ttdef"><b>Definition:</b> <a href="State_8cpp_source.html#l00099">State.cpp:99</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_html_aefa79f90126517a5b18ac63f899a9138"><div class="ttname"><a href="namespaceripple.html#aefa79f90126517a5b18ac63f899a9138">ripple::setLastRotated</a></div><div class="ttdeci">void setLastRotated(soci::session &session, LedgerIndex seq)</div><div class="ttdoc">setLastRotated Updates the last rotated ledger sequence.</div><div class="ttdef"><b>Definition:</b> <a href="State_8cpp_source.html#l00123">State.cpp:123</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="astructripple_1_1SavedState_html_adda68d802d02c0d2aaeefc12b32727e3"><div class="ttname"><a href="structripple_1_1SavedState.html#adda68d802d02c0d2aaeefc12b32727e3">ripple::SavedState::archiveDb</a></div><div class="ttdeci">std::string archiveDb</div><div class="ttdef"><b>Definition:</b> <a href="State_8h_source.html#l00036">State.h:36</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_html_a0fe94e7b03d864a38651a484be4c89d3"><div class="ttname"><a href="namespaceripple.html#a0fe94e7b03d864a38651a484be4c89d3">ripple::getCanDelete</a></div><div class="ttdeci">LedgerIndex getCanDelete(soci::session &session)</div><div class="ttdoc">getCanDelete Returns the ledger sequence which can be deleted.</div><div class="ttdef"><b>Definition:</b> <a href="State_8cpp_source.html#l00081">State.cpp:81</a></div></div>
|
|
<div class="ttc" id="astructripple_1_1SavedState_html_a8ca46a5d6d09ecd87222b337edc04729"><div class="ttname"><a href="structripple_1_1SavedState.html#a8ca46a5d6d09ecd87222b337edc04729">ripple::SavedState::lastRotated</a></div><div class="ttdeci">LedgerIndex lastRotated</div><div class="ttdef"><b>Definition:</b> <a href="State_8h_source.html#l00037">State.h:37</a></div></div>
|
|
<div class="ttc" id="astructripple_1_1SavedState_html"><div class="ttname"><a href="structripple_1_1SavedState.html">ripple::SavedState</a></div><div class="ttdef"><b>Definition:</b> <a href="State_8h_source.html#l00033">State.h:33</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1BasicConfig_html"><div class="ttname"><a href="classripple_1_1BasicConfig.html">ripple::BasicConfig</a></div><div class="ttdoc">Holds unparsed configuration information.</div><div class="ttdef"><b>Definition:</b> <a href="BasicConfig_8h_source.html#l00215">BasicConfig.h:215</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>
|