ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-20 11:05:54 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
rippled/State_8h_source.html
bthomee 33451fdc96 deploy: 1d42c4f6de
2025-11-04 00:36:48 -08:00

151 lines
16 KiB
HTML
Raw Permalink 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">#ifndef XRPL_APP_RDB_STATE_H_INCLUDED</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define XRPL_APP_RDB_STATE_H_INCLUDED</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include &lt;xrpld/app/ledger/Ledger.h&gt;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include &lt;xrpld/app/misc/Manifest.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/Config.h&gt;</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include &lt;xrpld/core/DatabaseCon.h&gt;</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include &lt;xrpld/peerfinder/detail/Store.h&gt;</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include &lt;boost/filesystem.hpp&gt;</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> </div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> </div>
<div class="foldopen" id="foldopen00014" data-start="{" data-end="};">
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"><a class="line" href="structripple_1_1SavedState.html"> 14</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structripple_1_1SavedState.html">SavedState</a></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span>{</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"><a class="line" href="structripple_1_1SavedState.html#a8d0a999fae5b415d6d3570ee17699920"> 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="structripple_1_1SavedState.html#a8d0a999fae5b415d6d3570ee17699920">writableDb</a>;</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"><a class="line" href="structripple_1_1SavedState.html#adda68d802d02c0d2aaeefc12b32727e3"> 17</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="structripple_1_1SavedState.html#adda68d802d02c0d2aaeefc12b32727e3">archiveDb</a>;</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"><a class="line" href="structripple_1_1SavedState.html#a8ca46a5d6d09ecd87222b337edc04729"> 18</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="structripple_1_1SavedState.html#a8ca46a5d6d09ecd87222b337edc04729">lastRotated</a>;</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span>};</div>
</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="keywordtype">void</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><a class="code hl_function" href="namespaceripple.html#a632dcd1160907dbaea1cd6caceca886c">initStateDB</a>(</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> soci::session&amp; session,</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> <a class="code hl_class" href="classripple_1_1BasicConfig.html">BasicConfig</a> <span class="keyword">const</span>&amp; config,</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> <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="l00032" name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">LedgerIndex</a></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span><a class="code hl_function" href="namespaceripple.html#a0fe94e7b03d864a38651a484be4c89d3">getCanDelete</a>(soci::session&amp; session);</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> </div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span><a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">LedgerIndex</a></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span><a class="code hl_function" href="namespaceripple.html#aab972dc5eb4ccbbb4a0a0d0b83042723">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="l00049" name="l00049"></a><span class="lineno"> 49</span> </div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span><a class="code hl_struct" href="structripple_1_1SavedState.html">SavedState</a></div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span><a class="code hl_function" href="namespaceripple.html#a1d7270f000f7f70eb39a3812d17a17bb">getSavedState</a>(soci::session&amp; session);</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> </div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span><span class="keywordtype">void</span></div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span><a class="code hl_function" href="namespaceripple.html#a4ebc529465484d38823ec8fcd242176a">setSavedState</a>(soci::session&amp; session, <a class="code hl_struct" href="structripple_1_1SavedState.html">SavedState</a> <span class="keyword">const</span>&amp; state);</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> </div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span><span class="keywordtype">void</span></div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span><a class="code hl_function" href="namespaceripple.html#aefa79f90126517a5b18ac63f899a9138">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="l00076" name="l00076"></a><span class="lineno"> 76</span> </div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span>} <span class="comment">// namespace ripple</span></div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> </div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span><span class="preprocessor">#endif</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="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#l00198">BasicConfig.h:199</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"><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="algorithm_8h_source.html#l00006">algorithm.h:6</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 &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#l00062">State.cpp:62</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 &amp;session)</div><div class="ttdoc">getSavedState Returns the saved state.</div><div class="ttdef"><b>Definition</b> <a href="State_8cpp_source.html#l00080">State.cpp:80</a></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 &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#l00092">State.cpp:92</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 &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="anamespaceripple_html_aab972dc5eb4ccbbb4a0a0d0b83042723"><div class="ttname"><a href="namespaceripple.html#aab972dc5eb4ccbbb4a0a0d0b83042723">ripple::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#l00072">State.cpp:72</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 &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#l00104">State.cpp:104</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#l00014">State.h:15</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#l00018">State.h:18</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#l00016">State.h:16</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#l00017">State.h:17</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