Files
rippled/classripple_1_1SHAMapStoreImp_1_1SavedStateDB.html
2025-11-04 00:36:48 -08:00

340 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" 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: ripple::SHAMapStoreImp::SavedStateDB Class Reference</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>
<!-- 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="namespaceripple.html">ripple</a></li><li class="navelem"><a class="el" href="classripple_1_1SHAMapStoreImp.html">SHAMapStoreImp</a></li><li class="navelem"><a class="el" href="classripple_1_1SHAMapStoreImp_1_1SavedStateDB.html">SavedStateDB</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="classripple_1_1SHAMapStoreImp_1_1SavedStateDB-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::SHAMapStoreImp::SavedStateDB Class Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Collaboration diagram for ripple::SHAMapStoreImp::SavedStateDB:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1SHAMapStoreImp_1_1SavedStateDB__coll__graph.png" border="0" usemap="#aripple_1_1SHAMapStoreImp_1_1SavedStateDB_coll__map" alt="Collaboration graph"/></div>
<map name="aripple_1_1SHAMapStoreImp_1_1SavedStateDB_coll__map" id="aripple_1_1SHAMapStoreImp_1_1SavedStateDB_coll__map">
<area shape="rect" title=" " alt="" coords="13,181,194,221"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/thread/mutex.html" title=" " alt="" coords="5,93,97,119"/>
<area shape="poly" title=" " alt="" coords="63,130,75,156,91,180,86,183,70,159,58,133"/>
<area shape="rect" href="classbeast_1_1Journal.html" title="A generic endpoint for log messages." alt="" coords="121,93,232,119"/>
<area shape="poly" title=" " alt="" coords="161,131,120,183,116,179,157,128"/>
<area shape="rect" href="classbeast_1_1Journal_1_1Sink.html" title="Abstraction for the underlying message destination." alt="" coords="103,5,250,31"/>
<area shape="poly" title=" " alt="" coords="179,45,179,93,174,93,174,45"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a873387ad6ed182ee21d29b7b6d1d48b4" id="r_a873387ad6ed182ee21d29b7b6d1d48b4"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1SHAMapStoreImp_1_1SavedStateDB.html#a873387ad6ed182ee21d29b7b6d1d48b4">SavedStateDB</a> ()</td></tr>
<tr class="separator:a873387ad6ed182ee21d29b7b6d1d48b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af9d1f71941c252879c5cc461438faaaa" id="r_af9d1f71941c252879c5cc461438faaaa"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1SHAMapStoreImp_1_1SavedStateDB.html#af9d1f71941c252879c5cc461438faaaa">init</a> (<a class="el" href="classripple_1_1BasicConfig.html">BasicConfig</a> const &amp;config, <a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &amp;dbName)</td></tr>
<tr class="separator:af9d1f71941c252879c5cc461438faaaa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad21f55aa2b33bc3f8c700a8c3f201a4b" id="r_ad21f55aa2b33bc3f8c700a8c3f201a4b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd">LedgerIndex</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1SHAMapStoreImp_1_1SavedStateDB.html#ad21f55aa2b33bc3f8c700a8c3f201a4b">getCanDelete</a> ()</td></tr>
<tr class="separator:ad21f55aa2b33bc3f8c700a8c3f201a4b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2daf6933e39fef00c2004ea292a5655c" id="r_a2daf6933e39fef00c2004ea292a5655c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd">LedgerIndex</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1SHAMapStoreImp_1_1SavedStateDB.html#a2daf6933e39fef00c2004ea292a5655c">setCanDelete</a> (<a class="el" href="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd">LedgerIndex</a> canDelete)</td></tr>
<tr class="separator:a2daf6933e39fef00c2004ea292a5655c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a56301f76a4e4c837d2fc036451227c59" id="r_a56301f76a4e4c837d2fc036451227c59"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structripple_1_1SavedState.html">SavedState</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1SHAMapStoreImp_1_1SavedStateDB.html#a56301f76a4e4c837d2fc036451227c59">getState</a> ()</td></tr>
<tr class="separator:a56301f76a4e4c837d2fc036451227c59"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2ff3adb29b03343ad89a6d9e6a7e82aa" id="r_a2ff3adb29b03343ad89a6d9e6a7e82aa"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1SHAMapStoreImp_1_1SavedStateDB.html#a2ff3adb29b03343ad89a6d9e6a7e82aa">setState</a> (<a class="el" href="structripple_1_1SavedState.html">SavedState</a> const &amp;state)</td></tr>
<tr class="separator:a2ff3adb29b03343ad89a6d9e6a7e82aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad08732c80f7c72199b1853d0516e1e0c" id="r_ad08732c80f7c72199b1853d0516e1e0c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1SHAMapStoreImp_1_1SavedStateDB.html#ad08732c80f7c72199b1853d0516e1e0c">setLastRotated</a> (<a class="el" href="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd">LedgerIndex</a> seq)</td></tr>
<tr class="separator:ad08732c80f7c72199b1853d0516e1e0c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a2d268ed2f9cdaac1ea6995d1ee0ce527" id="r_a2d268ed2f9cdaac1ea6995d1ee0ce527"><td class="memItemLeft" align="right" valign="top">soci::session&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1SHAMapStoreImp_1_1SavedStateDB.html#a2d268ed2f9cdaac1ea6995d1ee0ce527">sqlDb_</a></td></tr>
<tr class="separator:a2d268ed2f9cdaac1ea6995d1ee0ce527"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad5df3722609c889e8fb9b414e42b67a9" id="r_ad5df3722609c889e8fb9b414e42b67a9"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/thread/mutex.html">std::mutex</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1SHAMapStoreImp_1_1SavedStateDB.html#ad5df3722609c889e8fb9b414e42b67a9">mutex_</a></td></tr>
<tr class="separator:ad5df3722609c889e8fb9b414e42b67a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab50ea61308db5a53187dd82fa82da867" id="r_ab50ea61308db5a53187dd82fa82da867"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classbeast_1_1Journal.html">beast::Journal</a> const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1SHAMapStoreImp_1_1SavedStateDB.html#ab50ea61308db5a53187dd82fa82da867">journal_</a></td></tr>
<tr class="separator:ab50ea61308db5a53187dd82fa82da867"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p class="definition">Definition at line <a class="el" href="SHAMapStoreImp_8h_source.html#l00023">23</a> of file <a class="el" href="SHAMapStoreImp_8h_source.html">SHAMapStoreImp.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a873387ad6ed182ee21d29b7b6d1d48b4" name="a873387ad6ed182ee21d29b7b6d1d48b4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a873387ad6ed182ee21d29b7b6d1d48b4">&#9670;&#160;</a></span>SavedStateDB()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ripple::SHAMapStoreImp::SavedStateDB::SavedStateDB </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="SHAMapStoreImp_8h_source.html#l00032">32</a> of file <a class="el" href="SHAMapStoreImp_8h_source.html">SHAMapStoreImp.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="af9d1f71941c252879c5cc461438faaaa" name="af9d1f71941c252879c5cc461438faaaa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af9d1f71941c252879c5cc461438faaaa">&#9670;&#160;</a></span>init()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ripple::SHAMapStoreImp::SavedStateDB::init </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1BasicConfig.html">BasicConfig</a> const &amp;&#160;</td>
<td class="paramname"><em>config</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &amp;&#160;</td>
<td class="paramname"><em>dbName</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="SHAMapStoreImp_8cpp_source.html#l00017">17</a> of file <a class="el" href="SHAMapStoreImp_8cpp_source.html">SHAMapStoreImp.cpp</a>.</p>
</div>
</div>
<a id="ad21f55aa2b33bc3f8c700a8c3f201a4b" name="ad21f55aa2b33bc3f8c700a8c3f201a4b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad21f55aa2b33bc3f8c700a8c3f201a4b">&#9670;&#160;</a></span>getCanDelete()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd">LedgerIndex</a> ripple::SHAMapStoreImp::SavedStateDB::getCanDelete </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="SHAMapStoreImp_8cpp_source.html#l00026">26</a> of file <a class="el" href="SHAMapStoreImp_8cpp_source.html">SHAMapStoreImp.cpp</a>.</p>
</div>
</div>
<a id="a2daf6933e39fef00c2004ea292a5655c" name="a2daf6933e39fef00c2004ea292a5655c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2daf6933e39fef00c2004ea292a5655c">&#9670;&#160;</a></span>setCanDelete()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd">LedgerIndex</a> ripple::SHAMapStoreImp::SavedStateDB::setCanDelete </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd">LedgerIndex</a>&#160;</td>
<td class="paramname"><em>canDelete</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="SHAMapStoreImp_8cpp_source.html#l00034">34</a> of file <a class="el" href="SHAMapStoreImp_8cpp_source.html">SHAMapStoreImp.cpp</a>.</p>
</div>
</div>
<a id="a56301f76a4e4c837d2fc036451227c59" name="a56301f76a4e4c837d2fc036451227c59"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a56301f76a4e4c837d2fc036451227c59">&#9670;&#160;</a></span>getState()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structripple_1_1SavedState.html">SavedState</a> ripple::SHAMapStoreImp::SavedStateDB::getState </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="SHAMapStoreImp_8cpp_source.html#l00042">42</a> of file <a class="el" href="SHAMapStoreImp_8cpp_source.html">SHAMapStoreImp.cpp</a>.</p>
</div>
</div>
<a id="a2ff3adb29b03343ad89a6d9e6a7e82aa" name="a2ff3adb29b03343ad89a6d9e6a7e82aa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2ff3adb29b03343ad89a6d9e6a7e82aa">&#9670;&#160;</a></span>setState()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ripple::SHAMapStoreImp::SavedStateDB::setState </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structripple_1_1SavedState.html">SavedState</a> const &amp;&#160;</td>
<td class="paramname"><em>state</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="SHAMapStoreImp_8cpp_source.html#l00050">50</a> of file <a class="el" href="SHAMapStoreImp_8cpp_source.html">SHAMapStoreImp.cpp</a>.</p>
</div>
</div>
<a id="ad08732c80f7c72199b1853d0516e1e0c" name="ad08732c80f7c72199b1853d0516e1e0c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad08732c80f7c72199b1853d0516e1e0c">&#9670;&#160;</a></span>setLastRotated()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ripple::SHAMapStoreImp::SavedStateDB::setLastRotated </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd">LedgerIndex</a>&#160;</td>
<td class="paramname"><em>seq</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="SHAMapStoreImp_8cpp_source.html#l00057">57</a> of file <a class="el" href="SHAMapStoreImp_8cpp_source.html">SHAMapStoreImp.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a2d268ed2f9cdaac1ea6995d1ee0ce527" name="a2d268ed2f9cdaac1ea6995d1ee0ce527"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2d268ed2f9cdaac1ea6995d1ee0ce527">&#9670;&#160;</a></span>sqlDb_</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">soci::session ripple::SHAMapStoreImp::SavedStateDB::sqlDb_</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="SHAMapStoreImp_8h_source.html#l00026">26</a> of file <a class="el" href="SHAMapStoreImp_8h_source.html">SHAMapStoreImp.h</a>.</p>
</div>
</div>
<a id="ad5df3722609c889e8fb9b414e42b67a9" name="ad5df3722609c889e8fb9b414e42b67a9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad5df3722609c889e8fb9b414e42b67a9">&#9670;&#160;</a></span>mutex_</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/thread/mutex.html">std::mutex</a> ripple::SHAMapStoreImp::SavedStateDB::mutex_</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="SHAMapStoreImp_8h_source.html#l00027">27</a> of file <a class="el" href="SHAMapStoreImp_8h_source.html">SHAMapStoreImp.h</a>.</p>
</div>
</div>
<a id="ab50ea61308db5a53187dd82fa82da867" name="ab50ea61308db5a53187dd82fa82da867"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab50ea61308db5a53187dd82fa82da867">&#9670;&#160;</a></span>journal_</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classbeast_1_1Journal.html">beast::Journal</a> const ripple::SHAMapStoreImp::SavedStateDB::journal_</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="SHAMapStoreImp_8h_source.html#l00028">28</a> of file <a class="el" href="SHAMapStoreImp_8h_source.html">SHAMapStoreImp.h</a>.</p>
</div>
</div>
</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>