ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2026-02-07 23:42:28 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
9b9dfd7e60772525a8e73c805127fb458d68feb9
rippled/State_8h_source.html
bthomee 6863531c3e deploy: 34ef577604
2026-02-04 06:53:36 -08:00

145 lines
15 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" 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: 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 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&amp;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&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<!-- 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="dir_a62226f9e3a6c7c5a3be455e2f87ae01.html">xrpld</a></li><li class="navelem"><a class="el" href="dir_c69db3203fa08a9ff994909ba6ee9783.html">app</a></li><li class="navelem"><a class="el" href="dir_9ce43f199f7837b2bc54444bf73b9bab.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 id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span> </div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="preprocessor">#include &lt;xrpld/app/ledger/Ledger.h&gt;</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include &lt;xrpld/app/misc/Manifest.h&gt;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include &lt;xrpld/core/Config.h&gt;</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include &lt;xrpld/core/DatabaseCon.h&gt;</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include &lt;xrpld/peerfinder/detail/Store.h&gt;</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> </div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include &lt;boost/filesystem.hpp&gt;</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacexrpl.html">xrpl</a> {</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> </div>
<div class="foldopen" id="foldopen00013" data-start="{" data-end="};">
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"><a class="line" href="structxrpl_1_1SavedState.html"> 13</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structxrpl_1_1SavedState.html">SavedState</a></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span>{</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"><a class="line" href="structxrpl_1_1SavedState.html#ab230ef2e5ee59b503cbc9f88386c91e9"> 15</a></span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> <a class="code hl_variable" href="structxrpl_1_1SavedState.html#ab230ef2e5ee59b503cbc9f88386c91e9">writableDb</a>;</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"><a class="line" href="structxrpl_1_1SavedState.html#ade88c37f7e45ec906683435f1be59730"> 16</a></span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> <a class="code hl_variable" href="structxrpl_1_1SavedState.html#ade88c37f7e45ec906683435f1be59730">archiveDb</a>;</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"><a class="line" href="structxrpl_1_1SavedState.html#ad6297658f3de6e9f578ed0ab8e0952c1"> 17</a></span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">LedgerIndex</a> <a class="code hl_variable" href="structxrpl_1_1SavedState.html#ad6297658f3de6e9f578ed0ab8e0952c1">lastRotated</a>;</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span>};</div>
</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="keywordtype">void</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><a class="code hl_function" href="namespacexrpl.html#a41c119dcb9daf1252f89466269e782a9">initStateDB</a>(soci::session&amp; session, <a class="code hl_class" href="classxrpl_1_1BasicConfig.html">BasicConfig</a> <span class="keyword">const</span>&amp; config, <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> <span class="keyword">const</span>&amp; dbName);</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> </div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">LedgerIndex</a></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><a class="code hl_function" href="namespacexrpl.html#af69d396041a10d0d52c78ae01ff93c49">getCanDelete</a>(soci::session&amp; session);</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span><a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">LedgerIndex</a></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span><a class="code hl_function" href="namespacexrpl.html#ada5810245f8a5f5a3bb97c575564f09d">setCanDelete</a>(soci::session&amp; session, <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">LedgerIndex</a> canDelete);</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> </div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span><a class="code hl_struct" href="structxrpl_1_1SavedState.html">SavedState</a></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span><a class="code hl_function" href="namespacexrpl.html#a72d469bd04f88f13c74d0ad144998eb7">getSavedState</a>(soci::session&amp; session);</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> </div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span><span class="keywordtype">void</span></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span><a class="code hl_function" href="namespacexrpl.html#a411e55476dcd79c801cf25f5761eb006">setSavedState</a>(soci::session&amp; session, <a class="code hl_struct" href="structxrpl_1_1SavedState.html">SavedState</a> <span class="keyword">const</span>&amp; state);</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> </div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span><span class="keywordtype">void</span></div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span><a class="code hl_function" href="namespacexrpl.html#a36c0899274d858ab17b4b1009401e0e2">setLastRotated</a>(soci::session&amp; session, <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">LedgerIndex</a> seq);</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> </div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span>} <span class="comment">// namespace xrpl</span></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>
<div class="ttc" id="aclassxrpl_1_1BasicConfig_html"><div class="ttname"><a href="classxrpl_1_1BasicConfig.html">xrpl::BasicConfig</a></div><div class="ttdoc">Holds unparsed configuration information.</div><div class="ttdef"><b>Definition</b> <a href="BasicConfig_8h_source.html#l00195">BasicConfig.h:196</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="anamespacexrpl_html"><div class="ttname"><a href="namespacexrpl.html">xrpl</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="algorithm_8h_source.html#l00005">algorithm.h:5</a></div></div>
<div class="ttc" id="anamespacexrpl_html_a36c0899274d858ab17b4b1009401e0e2"><div class="ttname"><a href="namespacexrpl.html#a36c0899274d858ab17b4b1009401e0e2">xrpl::setLastRotated</a></div><div class="ttdeci">void setLastRotated(soci::session &amp;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#l00093">State.cpp:93</a></div></div>
<div class="ttc" id="anamespacexrpl_html_a411e55476dcd79c801cf25f5761eb006"><div class="ttname"><a href="namespacexrpl.html#a411e55476dcd79c801cf25f5761eb006">xrpl::setSavedState</a></div><div class="ttdeci">void setSavedState(soci::session &amp;session, SavedState const &amp;state)</div><div class="ttdoc">setSavedState Saves the given state.</div><div class="ttdef"><b>Definition</b> <a href="State_8cpp_source.html#l00082">State.cpp:82</a></div></div>
<div class="ttc" id="anamespacexrpl_html_a41c119dcb9daf1252f89466269e782a9"><div class="ttname"><a href="namespacexrpl.html#a41c119dcb9daf1252f89466269e782a9">xrpl::initStateDB</a></div><div class="ttdeci">void initStateDB(soci::session &amp;session, BasicConfig const &amp;config, std::string const &amp;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#l00006">State.cpp:6</a></div></div>
<div class="ttc" id="anamespacexrpl_html_a72d469bd04f88f13c74d0ad144998eb7"><div class="ttname"><a href="namespacexrpl.html#a72d469bd04f88f13c74d0ad144998eb7">xrpl::getSavedState</a></div><div class="ttdeci">SavedState getSavedState(soci::session &amp;session)</div><div class="ttdoc">getSavedState Returns the saved state.</div><div class="ttdef"><b>Definition</b> <a href="State_8cpp_source.html#l00071">State.cpp:71</a></div></div>
<div class="ttc" id="anamespacexrpl_html_ada5810245f8a5f5a3bb97c575564f09d"><div class="ttname"><a href="namespacexrpl.html#ada5810245f8a5f5a3bb97c575564f09d">xrpl::setCanDelete</a></div><div class="ttdeci">LedgerIndex setCanDelete(soci::session &amp;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#l00064">State.cpp:64</a></div></div>
<div class="ttc" id="anamespacexrpl_html_af69d396041a10d0d52c78ae01ff93c49"><div class="ttname"><a href="namespacexrpl.html#af69d396041a10d0d52c78ae01ff93c49">xrpl::getCanDelete</a></div><div class="ttdeci">LedgerIndex getCanDelete(soci::session &amp;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#l00055">State.cpp:55</a></div></div>
<div class="ttc" id="astructxrpl_1_1SavedState_html"><div class="ttname"><a href="structxrpl_1_1SavedState.html">xrpl::SavedState</a></div><div class="ttdef"><b>Definition</b> <a href="State_8h_source.html#l00013">State.h:14</a></div></div>
<div class="ttc" id="astructxrpl_1_1SavedState_html_ab230ef2e5ee59b503cbc9f88386c91e9"><div class="ttname"><a href="structxrpl_1_1SavedState.html#ab230ef2e5ee59b503cbc9f88386c91e9">xrpl::SavedState::writableDb</a></div><div class="ttdeci">std::string writableDb</div><div class="ttdef"><b>Definition</b> <a href="State_8h_source.html#l00015">State.h:15</a></div></div>
<div class="ttc" id="astructxrpl_1_1SavedState_html_ad6297658f3de6e9f578ed0ab8e0952c1"><div class="ttname"><a href="structxrpl_1_1SavedState.html#ad6297658f3de6e9f578ed0ab8e0952c1">xrpl::SavedState::lastRotated</a></div><div class="ttdeci">LedgerIndex lastRotated</div><div class="ttdef"><b>Definition</b> <a href="State_8h_source.html#l00017">State.h:17</a></div></div>
<div class="ttc" id="astructxrpl_1_1SavedState_html_ade88c37f7e45ec906683435f1be59730"><div class="ttname"><a href="structxrpl_1_1SavedState.html#ade88c37f7e45ec906683435f1be59730">xrpl::SavedState::archiveDb</a></div><div class="ttdeci">std::string archiveDb</div><div class="ttdef"><b>Definition</b> <a href="State_8h_source.html#l00016">State.h:16</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<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>
Reference in New Issue View Git Blame Copy Permalink