ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-12-06 17:27:55 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
2682e5845e60772ec6cc39ad4dcbe36de632f8ea
rippled/classripple_1_1SHAMapStore.html
nbougalis 2682e5845e deploy: a8d481c2a5
2020-09-08 17:09:25 +00:00

1298 lines
80 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">
<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: ripple::SHAMapStore 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 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&amp;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&amp;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="namespaceripple.html">ripple</a></li><li class="navelem"><a class="el" href="classripple_1_1SHAMapStore.html">SHAMapStore</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pri-types">Private Types</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classripple_1_1SHAMapStore-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ripple::SHAMapStore Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>class to create database, launch online delete thread, and related SQLite database
<a href="classripple_1_1SHAMapStore.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for ripple::SHAMapStore:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1SHAMapStore__inherit__graph.png" border="0" usemap="#ripple_1_1SHAMapStore_inherit__map" alt="Inheritance graph"/></div>
<map name="ripple_1_1SHAMapStore_inherit__map" id="ripple_1_1SHAMapStore_inherit__map">
<area shape="rect" title="class to create database, launch online delete thread, and related SQLite database" alt="" coords="18,80,173,107"/>
<area shape="rect" href="classripple_1_1SHAMapStoreImp.html" title=" " alt="" coords="5,155,185,181"/>
<area shape="rect" href="classripple_1_1Stoppable.html" title="Provides an interface for starting and stopping." alt="" coords="29,5,161,32"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ripple::SHAMapStore:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1SHAMapStore__coll__graph.png" border="0" usemap="#ripple_1_1SHAMapStore_coll__map" alt="Collaboration graph"/></div>
<map name="ripple_1_1SHAMapStore_coll__map" id="ripple_1_1SHAMapStore_coll__map">
<area shape="rect" title="class to create database, launch online delete thread, and related SQLite database" alt="" coords="1251,463,1406,489"/>
<area shape="rect" href="classripple_1_1Stoppable.html" title="Provides an interface for starting and stopping." alt="" coords="968,364,1100,391"/>
<area shape="rect" href="classripple_1_1RootStoppable.html" title=" " alt="" coords="1248,215,1409,241"/>
<area shape="rect" href="structripple_1_1Stoppable_1_1Child.html" title=" " alt="" coords="1259,397,1399,438"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/atomic/atomic.html" title=" " alt="" coords="590,299,743,325"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/thread/condition_variable.html" title=" " alt="" coords="581,219,752,245"/>
<area shape="rect" href="classripple_1_1ClosureCounter.html" title=" " alt="" coords="951,27,1117,69"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/thread/mutex.html" title="STL class." alt="" coords="621,95,713,121"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/atomic/atomic.html" title=" " alt="" coords="595,5,738,32"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title="STL class." alt="" coords="623,445,710,472"/>
<area shape="rect" href="classbeast_1_1LockFreeStack_1_1Node.html" title=" " alt="" coords="5,421,184,462"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/atomic/atomic.html" title=" " alt="" coords="285,430,476,471"/>
<area shape="rect" href="classbeast_1_1LockFreeStack.html" title=" " alt="" coords="587,379,746,421"/>
</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 name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a45e54d3a7fd8dff60d4dcb780914f40f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1SHAMapStore.html#a45e54d3a7fd8dff60d4dcb780914f40f">SHAMapStore</a> (<a class="el" href="classripple_1_1Stoppable.html">Stoppable</a> &amp;parent)</td></tr>
<tr class="separator:a45e54d3a7fd8dff60d4dcb780914f40f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3a16eedab60b2fdc51c616369d5f3969"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1SHAMapStore.html#a3a16eedab60b2fdc51c616369d5f3969">onLedgerClosed</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; <a class="el" href="classripple_1_1Ledger.html">Ledger</a> const &gt; const &amp;ledger)=0</td></tr>
<tr class="memdesc:a3a16eedab60b2fdc51c616369d5f3969"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called by <a class="el" href="classripple_1_1LedgerMaster.html">LedgerMaster</a> every time a ledger validates. <a href="classripple_1_1SHAMapStore.html#a3a16eedab60b2fdc51c616369d5f3969">More...</a><br /></td></tr>
<tr class="separator:a3a16eedab60b2fdc51c616369d5f3969"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a96ae0b236ea08f5178309d80d27a7c5f"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1SHAMapStore.html#a96ae0b236ea08f5178309d80d27a7c5f">rendezvous</a> () const =0</td></tr>
<tr class="separator:a96ae0b236ea08f5178309d80d27a7c5f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6bd103dd779634de40c59681605874e6"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1SHAMapStore.html#a6bd103dd779634de40c59681605874e6">clampFetchDepth</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> fetch_depth) const =0</td></tr>
<tr class="separator:a6bd103dd779634de40c59681605874e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5a3879e1b305de3f9a8c4341d9471ef1"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/unique_ptr.html">std::unique_ptr</a>&lt; <a class="el" href="classripple_1_1NodeStore_1_1Database.html">NodeStore::Database</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1SHAMapStore.html#a5a3879e1b305de3f9a8c4341d9471ef1">makeNodeStore</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &amp;name, <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::int32_t</a> readThreads)=0</td></tr>
<tr class="separator:a5a3879e1b305de3f9a8c4341d9471ef1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2b1a46d6f878575eeea6730c8fc367f2"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd">LedgerIndex</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1SHAMapStore.html#a2b1a46d6f878575eeea6730c8fc367f2">setCanDelete</a> (<a class="el" href="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd">LedgerIndex</a> canDelete)=0</td></tr>
<tr class="memdesc:a2b1a46d6f878575eeea6730c8fc367f2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Highest ledger that may be deleted. <a href="classripple_1_1SHAMapStore.html#a2b1a46d6f878575eeea6730c8fc367f2">More...</a><br /></td></tr>
<tr class="separator:a2b1a46d6f878575eeea6730c8fc367f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a737537b2e26dd540a14ac7c7a98a0701"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1SHAMapStore.html#a737537b2e26dd540a14ac7c7a98a0701">advisoryDelete</a> () const =0</td></tr>
<tr class="memdesc:a737537b2e26dd540a14ac7c7a98a0701"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether advisory delete is enabled. <a href="classripple_1_1SHAMapStore.html#a737537b2e26dd540a14ac7c7a98a0701">More...</a><br /></td></tr>
<tr class="separator:a737537b2e26dd540a14ac7c7a98a0701"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7d926beeaf7fe6baf9fa95ee2b4d85d1"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd">LedgerIndex</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1SHAMapStore.html#a7d926beeaf7fe6baf9fa95ee2b4d85d1">getLastRotated</a> ()=0</td></tr>
<tr class="memdesc:a7d926beeaf7fe6baf9fa95ee2b4d85d1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum ledger that has been deleted, or will be deleted if currently in the act of online deletion. <a href="classripple_1_1SHAMapStore.html#a7d926beeaf7fe6baf9fa95ee2b4d85d1">More...</a><br /></td></tr>
<tr class="separator:a7d926beeaf7fe6baf9fa95ee2b4d85d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a90d0d6d4d070628e340c78cd818e9ae0"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd">LedgerIndex</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1SHAMapStore.html#a90d0d6d4d070628e340c78cd818e9ae0">getCanDelete</a> ()=0</td></tr>
<tr class="memdesc:a90d0d6d4d070628e340c78cd818e9ae0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Highest ledger that may be deleted. <a href="classripple_1_1SHAMapStore.html#a90d0d6d4d070628e340c78cd818e9ae0">More...</a><br /></td></tr>
<tr class="separator:a90d0d6d4d070628e340c78cd818e9ae0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a90ce3f79e011586bc87d6fdcb4cf9a0e"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1SHAMapStore.html#a90ce3f79e011586bc87d6fdcb4cf9a0e">fdRequired</a> () const =0</td></tr>
<tr class="memdesc:a90ce3f79e011586bc87d6fdcb4cf9a0e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the number of file descriptors that are needed. <a href="classripple_1_1SHAMapStore.html#a90ce3f79e011586bc87d6fdcb4cf9a0e">More...</a><br /></td></tr>
<tr class="separator:a90ce3f79e011586bc87d6fdcb4cf9a0e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a05bec537a1aea25f251635dafc755900"><td class="memItemLeft" align="right" valign="top">virtual boost::optional&lt; <a class="el" href="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd">LedgerIndex</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1SHAMapStore.html#a05bec537a1aea25f251635dafc755900">minimumOnline</a> () const =0</td></tr>
<tr class="memdesc:a05bec537a1aea25f251635dafc755900"><td class="mdescLeft">&#160;</td><td class="mdescRight">The minimum ledger to try and maintain in our database. <a href="classripple_1_1SHAMapStore.html#a05bec537a1aea25f251635dafc755900">More...</a><br /></td></tr>
<tr class="separator:a05bec537a1aea25f251635dafc755900"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae9b6cb02b4e1128bd2c4e1a81c9d695c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1RootStoppable.html">RootStoppable</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Stoppable.html#ae9b6cb02b4e1128bd2c4e1a81c9d695c">getRoot</a> ()</td></tr>
<tr class="separator:ae9b6cb02b4e1128bd2c4e1a81c9d695c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adea135697761febf430a8628814c7902"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Stoppable.html#adea135697761febf430a8628814c7902">setParent</a> (<a class="el" href="classripple_1_1Stoppable.html">Stoppable</a> &amp;parent)</td></tr>
<tr class="memdesc:adea135697761febf430a8628814c7902"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the parent of this <a class="el" href="classripple_1_1Stoppable.html" title="Provides an interface for starting and stopping.">Stoppable</a>. <a href="classripple_1_1Stoppable.html#adea135697761febf430a8628814c7902">More...</a><br /></td></tr>
<tr class="separator:adea135697761febf430a8628814c7902"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a836b8737444ef1133c3596e61010fa80"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Stoppable.html#a836b8737444ef1133c3596e61010fa80">isStopping</a> () const</td></tr>
<tr class="memdesc:a836b8737444ef1133c3596e61010fa80"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns <code>true</code> if the stoppable should stop. <a href="classripple_1_1Stoppable.html#a836b8737444ef1133c3596e61010fa80">More...</a><br /></td></tr>
<tr class="separator:a836b8737444ef1133c3596e61010fa80"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af1e1447ecb573d2341c8a71afd3e76da"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Stoppable.html#af1e1447ecb573d2341c8a71afd3e76da">isStopped</a> () const</td></tr>
<tr class="memdesc:af1e1447ecb573d2341c8a71afd3e76da"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns <code>true</code> if the requested stop has completed. <a href="classripple_1_1Stoppable.html#af1e1447ecb573d2341c8a71afd3e76da">More...</a><br /></td></tr>
<tr class="separator:af1e1447ecb573d2341c8a71afd3e76da"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9ec6fda89ff8bc63251a9c3682311e5d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Stoppable.html#a9ec6fda89ff8bc63251a9c3682311e5d">areChildrenStopped</a> () const</td></tr>
<tr class="memdesc:a9ec6fda89ff8bc63251a9c3682311e5d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns <code>true</code> if all children have stopped. <a href="classripple_1_1Stoppable.html#a9ec6fda89ff8bc63251a9c3682311e5d">More...</a><br /></td></tr>
<tr class="separator:a9ec6fda89ff8bc63251a9c3682311e5d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acc824cd8bdcffbac3c919c7e6009dea5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple.html#adf17c8e58c57ecf0ed6cbc7ee1c2ab22">JobCounter</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Stoppable.html#acc824cd8bdcffbac3c919c7e6009dea5">jobCounter</a> ()</td></tr>
<tr class="separator:acc824cd8bdcffbac3c919c7e6009dea5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aca4a925fd0df7e3a3bca51c9593e6a6e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Stoppable.html#aca4a925fd0df7e3a3bca51c9593e6a6e">alertable_sleep_until</a> (std::chrono::system_clock::time_point const &amp;t)</td></tr>
<tr class="memdesc:aca4a925fd0df7e3a3bca51c9593e6a6e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sleep or wake up on stop. <a href="classripple_1_1Stoppable.html#aca4a925fd0df7e3a3bca51c9593e6a6e">More...</a><br /></td></tr>
<tr class="separator:aca4a925fd0df7e3a3bca51c9593e6a6e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a65a95f9c14637491df60d3a07518fa09"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Stoppable.html#a65a95f9c14637491df60d3a07518fa09">stopped</a> ()</td></tr>
<tr class="memdesc:a65a95f9c14637491df60d3a07518fa09"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called by derived classes to indicate that the stoppable has stopped. <a href="classripple_1_1Stoppable.html#a65a95f9c14637491df60d3a07518fa09">More...</a><br /></td></tr>
<tr class="separator:a65a95f9c14637491df60d3a07518fa09"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-types"></a>
Private Types</h2></td></tr>
<tr class="memitem:a43594a8835ccb53d7b80983694d26cad"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Stoppable.html#a43594a8835ccb53d7b80983694d26cad">Children</a> = <a class="el" href="classbeast_1_1LockFreeStack.html">beast::LockFreeStack</a>&lt; <a class="el" href="structripple_1_1Stoppable_1_1Child.html">Child</a> &gt;</td></tr>
<tr class="separator:a43594a8835ccb53d7b80983694d26cad"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr class="memitem:ab2a5544b4bfc0dccdc6a2a46f6ff5d84"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Stoppable.html#ab2a5544b4bfc0dccdc6a2a46f6ff5d84">onPrepare</a> ()</td></tr>
<tr class="memdesc:ab2a5544b4bfc0dccdc6a2a46f6ff5d84"><td class="mdescLeft">&#160;</td><td class="mdescRight">Override called during preparation. <a href="classripple_1_1Stoppable.html#ab2a5544b4bfc0dccdc6a2a46f6ff5d84">More...</a><br /></td></tr>
<tr class="separator:ab2a5544b4bfc0dccdc6a2a46f6ff5d84"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0f24b7fcb7e8679dfd3783e9ffe3bbde"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Stoppable.html#a0f24b7fcb7e8679dfd3783e9ffe3bbde">onStart</a> ()</td></tr>
<tr class="memdesc:a0f24b7fcb7e8679dfd3783e9ffe3bbde"><td class="mdescLeft">&#160;</td><td class="mdescRight">Override called during start. <a href="classripple_1_1Stoppable.html#a0f24b7fcb7e8679dfd3783e9ffe3bbde">More...</a><br /></td></tr>
<tr class="separator:a0f24b7fcb7e8679dfd3783e9ffe3bbde"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4278b4c199fbe20a75d69610a8970c03"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Stoppable.html#a4278b4c199fbe20a75d69610a8970c03">onStop</a> ()</td></tr>
<tr class="memdesc:a4278b4c199fbe20a75d69610a8970c03"><td class="mdescLeft">&#160;</td><td class="mdescRight">Override called when the stop notification is issued. <a href="classripple_1_1Stoppable.html#a4278b4c199fbe20a75d69610a8970c03">More...</a><br /></td></tr>
<tr class="separator:a4278b4c199fbe20a75d69610a8970c03"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a944a3ffe59dc8f41185fe7b740aa3e8f"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Stoppable.html#a944a3ffe59dc8f41185fe7b740aa3e8f">onChildrenStopped</a> ()</td></tr>
<tr class="memdesc:a944a3ffe59dc8f41185fe7b740aa3e8f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Override called when all children have stopped. <a href="classripple_1_1Stoppable.html#a944a3ffe59dc8f41185fe7b740aa3e8f">More...</a><br /></td></tr>
<tr class="separator:a944a3ffe59dc8f41185fe7b740aa3e8f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a390c62d40a1ca754dfb2de4befa02b0d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Stoppable.html#a390c62d40a1ca754dfb2de4befa02b0d">prepareRecursive</a> ()</td></tr>
<tr class="separator:a390c62d40a1ca754dfb2de4befa02b0d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab53b667e9786bed2c10dd3fcd02b517f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Stoppable.html#ab53b667e9786bed2c10dd3fcd02b517f">startRecursive</a> ()</td></tr>
<tr class="separator:ab53b667e9786bed2c10dd3fcd02b517f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a34ddbefa8dda0aab52b8ecf493833d62"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Stoppable.html#a34ddbefa8dda0aab52b8ecf493833d62">stopAsyncRecursive</a> (<a class="el" href="classbeast_1_1Journal.html">beast::Journal</a> j)</td></tr>
<tr class="separator:a34ddbefa8dda0aab52b8ecf493833d62"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a294e4d3874e76f53a443cb4df306913f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Stoppable.html#a294e4d3874e76f53a443cb4df306913f">stopRecursive</a> (<a class="el" href="classbeast_1_1Journal.html">beast::Journal</a> j)</td></tr>
<tr class="separator:a294e4d3874e76f53a443cb4df306913f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a3bee0684bbf67bc8c2f974cc30523cea"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Stoppable.html#a3bee0684bbf67bc8c2f974cc30523cea">m_name</a></td></tr>
<tr class="separator:a3bee0684bbf67bc8c2f974cc30523cea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3a889a7b2e1b4c0fd463c51abfaa0ee0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1RootStoppable.html">RootStoppable</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Stoppable.html#a3a889a7b2e1b4c0fd463c51abfaa0ee0">m_root</a></td></tr>
<tr class="separator:a3a889a7b2e1b4c0fd463c51abfaa0ee0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab9ece0159fb3954819b6b6f1672ac2e4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structripple_1_1Stoppable_1_1Child.html">Child</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Stoppable.html#ab9ece0159fb3954819b6b6f1672ac2e4">m_child</a></td></tr>
<tr class="separator:ab9ece0159fb3954819b6b6f1672ac2e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9d39131e97d8faa6beb1d36eab19dc2f"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/atomic/atomic.html">std::atomic</a>&lt; bool &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Stoppable.html#a9d39131e97d8faa6beb1d36eab19dc2f">m_stopped</a> {false}</td></tr>
<tr class="separator:a9d39131e97d8faa6beb1d36eab19dc2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8c1e09326ea6d61009b6630c9e297c89"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/atomic/atomic.html">std::atomic</a>&lt; bool &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Stoppable.html#a8c1e09326ea6d61009b6630c9e297c89">m_childrenStopped</a> {false}</td></tr>
<tr class="separator:a8c1e09326ea6d61009b6630c9e297c89"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adc549cdc2b0ebef1878e6d79c496be4d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1Stoppable.html#a43594a8835ccb53d7b80983694d26cad">Children</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Stoppable.html#adc549cdc2b0ebef1878e6d79c496be4d">m_children</a></td></tr>
<tr class="separator:adc549cdc2b0ebef1878e6d79c496be4d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3c9a256ee2a1f891a042dda5c89360c0"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/thread/condition_variable.html">std::condition_variable</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Stoppable.html#a3c9a256ee2a1f891a042dda5c89360c0">m_cv</a></td></tr>
<tr class="separator:a3c9a256ee2a1f891a042dda5c89360c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afb1038efa534f43ebbd76db775592aaf"><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_1Stoppable.html#afb1038efa534f43ebbd76db775592aaf">m_mut</a></td></tr>
<tr class="separator:afb1038efa534f43ebbd76db775592aaf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a12f304b9baab521c4f5f8291485f1391"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Stoppable.html#a12f304b9baab521c4f5f8291485f1391">m_is_stopping</a> = false</td></tr>
<tr class="separator:a12f304b9baab521c4f5f8291485f1391"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1538bf3e4636b78efa3d30a5596eddf7"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Stoppable.html#a1538bf3e4636b78efa3d30a5596eddf7">hasParent_</a> {false}</td></tr>
<tr class="separator:a1538bf3e4636b78efa3d30a5596eddf7"><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 to create database, launch online delete thread, and related SQLite database </p>
<p class="definition">Definition at line <a class="el" href="SHAMapStore_8h_source.html#l00037">37</a> of file <a class="el" href="SHAMapStore_8h_source.html">SHAMapStore.h</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a43594a8835ccb53d7b80983694d26cad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a43594a8835ccb53d7b80983694d26cad">&#9670;&nbsp;</a></span>Children</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classripple_1_1Stoppable.html#a43594a8835ccb53d7b80983694d26cad">ripple::Stoppable::Children</a> = <a class="el" href="classbeast_1_1LockFreeStack.html">beast::LockFreeStack</a>&lt;<a class="el" href="structripple_1_1Stoppable_1_1Child.html">Child</a>&gt;</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Stoppable_8h_source.html#l00318">318</a> of file <a class="el" href="Stoppable_8h_source.html">Stoppable.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a45e54d3a7fd8dff60d4dcb780914f40f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a45e54d3a7fd8dff60d4dcb780914f40f">&#9670;&nbsp;</a></span>SHAMapStore()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ripple::SHAMapStore::SHAMapStore </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1Stoppable.html">Stoppable</a> &amp;&#160;</td>
<td class="paramname"><em>parent</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="SHAMapStore_8h_source.html#l00040">40</a> of file <a class="el" href="SHAMapStore_8h_source.html">SHAMapStore.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a3a16eedab60b2fdc51c616369d5f3969"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3a16eedab60b2fdc51c616369d5f3969">&#9670;&nbsp;</a></span>onLedgerClosed()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void ripple::SHAMapStore::onLedgerClosed </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; <a class="el" href="classripple_1_1Ledger.html">Ledger</a> const &gt; const &amp;&#160;</td>
<td class="paramname"><em>ledger</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Called by <a class="el" href="classripple_1_1LedgerMaster.html">LedgerMaster</a> every time a ledger validates. </p>
<p>Implemented in <a class="el" href="classripple_1_1SHAMapStoreImp.html#a59695e67a2807695a5c9cb7234ecfaac">ripple::SHAMapStoreImp</a>.</p>
</div>
</div>
<a id="a96ae0b236ea08f5178309d80d27a7c5f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a96ae0b236ea08f5178309d80d27a7c5f">&#9670;&nbsp;</a></span>rendezvous()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void ripple::SHAMapStore::rendezvous </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="classripple_1_1SHAMapStoreImp.html#a11f592da3dd908e4b8e0e586517377cf">ripple::SHAMapStoreImp</a>.</p>
</div>
</div>
<a id="a6bd103dd779634de40c59681605874e6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6bd103dd779634de40c59681605874e6">&#9670;&nbsp;</a></span>clampFetchDepth()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> ripple::SHAMapStore::clampFetchDepth </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a>&#160;</td>
<td class="paramname"><em>fetch_depth</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="classripple_1_1SHAMapStoreImp.html#a7553dc0489fbb2b00426473c1156cb9a">ripple::SHAMapStoreImp</a>.</p>
</div>
</div>
<a id="a5a3879e1b305de3f9a8c4341d9471ef1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5a3879e1b305de3f9a8c4341d9471ef1">&#9670;&nbsp;</a></span>makeNodeStore()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/unique_ptr.html">std::unique_ptr</a>&lt;<a class="el" href="classripple_1_1NodeStore_1_1Database.html">NodeStore::Database</a>&gt; ripple::SHAMapStore::makeNodeStore </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>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::int32_t</a>&#160;</td>
<td class="paramname"><em>readThreads</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="classripple_1_1SHAMapStoreImp.html#a376d0378bf115b8e476b3771316901c5">ripple::SHAMapStoreImp</a>.</p>
</div>
</div>
<a id="a2b1a46d6f878575eeea6730c8fc367f2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2b1a46d6f878575eeea6730c8fc367f2">&#9670;&nbsp;</a></span>setCanDelete()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd">LedgerIndex</a> ripple::SHAMapStore::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>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Highest ledger that may be deleted. </p>
<p>Implemented in <a class="el" href="classripple_1_1SHAMapStoreImp.html#a3be2b951362ba4c182e2a75dae4805f3">ripple::SHAMapStoreImp</a>.</p>
</div>
</div>
<a id="a737537b2e26dd540a14ac7c7a98a0701"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a737537b2e26dd540a14ac7c7a98a0701">&#9670;&nbsp;</a></span>advisoryDelete()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool ripple::SHAMapStore::advisoryDelete </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Whether advisory delete is enabled. </p>
<p>Implemented in <a class="el" href="classripple_1_1SHAMapStoreImp.html#a1abf26d12fd7aac094d286ba450157c4">ripple::SHAMapStoreImp</a>.</p>
</div>
</div>
<a id="a7d926beeaf7fe6baf9fa95ee2b4d85d1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7d926beeaf7fe6baf9fa95ee2b4d85d1">&#9670;&nbsp;</a></span>getLastRotated()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd">LedgerIndex</a> ripple::SHAMapStore::getLastRotated </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Maximum ledger that has been deleted, or will be deleted if currently in the act of online deletion. </p>
<p>Implemented in <a class="el" href="classripple_1_1SHAMapStoreImp.html#aac0c0154f62d2ef0ddbb52089931d5fa">ripple::SHAMapStoreImp</a>.</p>
</div>
</div>
<a id="a90d0d6d4d070628e340c78cd818e9ae0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a90d0d6d4d070628e340c78cd818e9ae0">&#9670;&nbsp;</a></span>getCanDelete()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd">LedgerIndex</a> ripple::SHAMapStore::getCanDelete </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Highest ledger that may be deleted. </p>
<p>Implemented in <a class="el" href="classripple_1_1SHAMapStoreImp.html#a7f1d7a2d2fb1fefbfc50303be0d12a08">ripple::SHAMapStoreImp</a>.</p>
</div>
</div>
<a id="a90ce3f79e011586bc87d6fdcb4cf9a0e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a90ce3f79e011586bc87d6fdcb4cf9a0e">&#9670;&nbsp;</a></span>fdRequired()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int ripple::SHAMapStore::fdRequired </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the number of file descriptors that are needed. </p>
<p>Implemented in <a class="el" href="classripple_1_1SHAMapStoreImp.html#ac502b9f3e8822e3111bce648c7375d32">ripple::SHAMapStoreImp</a>.</p>
</div>
</div>
<a id="a05bec537a1aea25f251635dafc755900"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a05bec537a1aea25f251635dafc755900">&#9670;&nbsp;</a></span>minimumOnline()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual boost::optional&lt;<a class="el" href="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd">LedgerIndex</a>&gt; ripple::SHAMapStore::minimumOnline </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The minimum ledger to try and maintain in our database. </p>
<p>This defines the lower bound for attempting to acquire historical ledgers over the peer to peer network.</p>
<p>If online_delete is enabled, then each time online_delete executes and just prior to clearing SQL databases of historical ledgers, move the value forward to one past the greatest ledger being deleted. This minimizes fetching of ledgers that are in the process of being deleted. Without online_delete or before online_delete is executed, this value is always the minimum value persisted in the ledger database, if any.</p>
<dl class="section return"><dt>Returns</dt><dd>The minimum ledger sequence to keep online based on the description above. If not set, then an unseated optional. </dd></dl>
<p>Implemented in <a class="el" href="classripple_1_1SHAMapStoreImp.html#a6a83852c52d91ffb7fe55092d7b07bce">ripple::SHAMapStoreImp</a>.</p>
</div>
</div>
<a id="ae9b6cb02b4e1128bd2c4e1a81c9d695c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae9b6cb02b4e1128bd2c4e1a81c9d695c">&#9670;&nbsp;</a></span>getRoot()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1RootStoppable.html">RootStoppable</a>&amp; ripple::Stoppable::getRoot </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Stoppable_8h_source.html#l00213">213</a> of file <a class="el" href="Stoppable_8h_source.html">Stoppable.h</a>.</p>
</div>
</div>
<a id="adea135697761febf430a8628814c7902"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adea135697761febf430a8628814c7902">&#9670;&nbsp;</a></span>setParent()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ripple::Stoppable::setParent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1Stoppable.html">Stoppable</a> &amp;&#160;</td>
<td class="paramname"><em>parent</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the parent of this <a class="el" href="classripple_1_1Stoppable.html" title="Provides an interface for starting and stopping.">Stoppable</a>. </p>
<dl class="section note"><dt>Note</dt><dd>The <a class="el" href="classripple_1_1Stoppable.html" title="Provides an interface for starting and stopping.">Stoppable</a> must not already have a parent. The parent to be set cannot not be stopping. Both roots must match. </dd></dl>
<p class="definition">Definition at line <a class="el" href="Stoppable_8cpp_source.html#l00043">43</a> of file <a class="el" href="Stoppable_8cpp_source.html">Stoppable.cpp</a>.</p>
</div>
</div>
<a id="a836b8737444ef1133c3596e61010fa80"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a836b8737444ef1133c3596e61010fa80">&#9670;&nbsp;</a></span>isStopping()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool ripple::Stoppable::isStopping </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns <code>true</code> if the stoppable should stop. </p>
<p class="definition">Definition at line <a class="el" href="Stoppable_8cpp_source.html#l00054">54</a> of file <a class="el" href="Stoppable_8cpp_source.html">Stoppable.cpp</a>.</p>
</div>
</div>
<a id="af1e1447ecb573d2341c8a71afd3e76da"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af1e1447ecb573d2341c8a71afd3e76da">&#9670;&nbsp;</a></span>isStopped()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool ripple::Stoppable::isStopped </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns <code>true</code> if the requested stop has completed. </p>
<p class="definition">Definition at line <a class="el" href="Stoppable_8cpp_source.html#l00060">60</a> of file <a class="el" href="Stoppable_8cpp_source.html">Stoppable.cpp</a>.</p>
</div>
</div>
<a id="a9ec6fda89ff8bc63251a9c3682311e5d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9ec6fda89ff8bc63251a9c3682311e5d">&#9670;&nbsp;</a></span>areChildrenStopped()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool ripple::Stoppable::areChildrenStopped </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns <code>true</code> if all children have stopped. </p>
<p class="definition">Definition at line <a class="el" href="Stoppable_8cpp_source.html#l00066">66</a> of file <a class="el" href="Stoppable_8cpp_source.html">Stoppable.cpp</a>.</p>
</div>
</div>
<a id="acc824cd8bdcffbac3c919c7e6009dea5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acc824cd8bdcffbac3c919c7e6009dea5">&#9670;&nbsp;</a></span>jobCounter()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceripple.html#adf17c8e58c57ecf0ed6cbc7ee1c2ab22">JobCounter</a> &amp; ripple::Stoppable::jobCounter </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Stoppable_8h_source.html#l00436">436</a> of file <a class="el" href="Stoppable_8h_source.html">Stoppable.h</a>.</p>
</div>
</div>
<a id="aca4a925fd0df7e3a3bca51c9593e6a6e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aca4a925fd0df7e3a3bca51c9593e6a6e">&#9670;&nbsp;</a></span>alertable_sleep_until()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool ripple::Stoppable::alertable_sleep_until </td>
<td>(</td>
<td class="paramtype">std::chrono::system_clock::time_point const &amp;&#160;</td>
<td class="paramname"><em>t</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sleep or wake up on stop. </p>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if we are stopping </dd></dl>
<p class="definition">Definition at line <a class="el" href="Stoppable_8h_source.html#l00454">454</a> of file <a class="el" href="Stoppable_8h_source.html">Stoppable.h</a>.</p>
</div>
</div>
<a id="a65a95f9c14637491df60d3a07518fa09"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a65a95f9c14637491df60d3a07518fa09">&#9670;&nbsp;</a></span>stopped()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ripple::Stoppable::stopped </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Called by derived classes to indicate that the stoppable has stopped. </p>
<p class="definition">Definition at line <a class="el" href="Stoppable_8cpp_source.html#l00072">72</a> of file <a class="el" href="Stoppable_8cpp_source.html">Stoppable.cpp</a>.</p>
</div>
</div>
<a id="ab2a5544b4bfc0dccdc6a2a46f6ff5d84"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab2a5544b4bfc0dccdc6a2a46f6ff5d84">&#9670;&nbsp;</a></span>onPrepare()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ripple::Stoppable::onPrepare </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Override called during preparation. </p>
<p>Since all other <a class="el" href="classripple_1_1Stoppable.html" title="Provides an interface for starting and stopping.">Stoppable</a> objects in the tree have already been constructed, this provides an opportunity to perform initialization which depends on calling into other <a class="el" href="classripple_1_1Stoppable.html" title="Provides an interface for starting and stopping.">Stoppable</a> objects. This call is made on the same thread that called prepare(). The default implementation does nothing. Guaranteed to only be called once. </p>
<p>Reimplemented in <a class="el" href="classripple_1_1ApplicationImp.html#a11604902ac7fe26dea0514976808e2ad">ripple::ApplicationImp</a>, <a class="el" href="classripple_1_1OverlayImpl.html#addad297874d76d9df9fc2d7c903d7782">ripple::OverlayImpl</a>, <a class="el" href="classripple_1_1test_1_1Stoppable__test_1_1Root.html#a0419ed3fe1cbaff9a0e7b218ea8c7383">ripple::test::Stoppable_test::Root</a>, <a class="el" href="classripple_1_1test_1_1Stoppable__test_1_1C.html#a27bf534a255be28d9db438c2e650febe">ripple::test::Stoppable_test::C</a>, <a class="el" href="classripple_1_1test_1_1Stoppable__test_1_1I.html#a1f3cfa0cbcefd9779a0d6bbb33e929ad">ripple::test::Stoppable_test::I</a>, <a class="el" href="classripple_1_1test_1_1Stoppable__test_1_1B.html#a3802f8ec07a49c257e7af4d6425c66d3">ripple::test::Stoppable_test::B</a>, <a class="el" href="classripple_1_1test_1_1Stoppable__test_1_1H.html#aca211ad8479955c5c3a8ff56c8b80f23">ripple::test::Stoppable_test::H</a>, <a class="el" href="classripple_1_1test_1_1Stoppable__test_1_1G.html#acb490a17968f0429b5e98fdab6165de0">ripple::test::Stoppable_test::G</a>, <a class="el" href="classripple_1_1SHAMapStoreImp.html#adff33ddff93fb52cbc61b12abcafe98e">ripple::SHAMapStoreImp</a>, <a class="el" href="classripple_1_1test_1_1Stoppable__test_1_1A.html#a9c4f120d3d1257cb1922e6dedc6ebb7c">ripple::test::Stoppable_test::A</a>, <a class="el" href="classripple_1_1PeerFinder_1_1ManagerImp.html#a20612412402a342e2acc42a3f19936e7">ripple::PeerFinder::ManagerImp</a>, <a class="el" href="classripple_1_1perf_1_1PerfLogImp.html#a26d2333c65f5f8b8489f785d61c6346f">ripple::perf::PerfLogImp</a>, <a class="el" href="classripple_1_1test_1_1Stoppable__test_1_1F.html#a65baffca9446b7f05a5c4c561743698f">ripple::test::Stoppable_test::F</a>, <a class="el" href="classripple_1_1test_1_1Stoppable__test_1_1E.html#ab0d1bcc2b5c8349c9fedb83c880a0bcb">ripple::test::Stoppable_test::E</a>, <a class="el" href="classripple_1_1detail_1_1LedgerCleanerImp.html#a5f8e1250b4903f039435451cb8175f61">ripple::detail::LedgerCleanerImp</a>, <a class="el" href="classripple_1_1test_1_1Stoppable__test_1_1J.html#aeae3d11b4b4965ad1e41229b51eb3d10">ripple::test::Stoppable_test::J</a>, <a class="el" href="classripple_1_1LoadManager.html#a6f602f780c6e72f265cef2454e384db5">ripple::LoadManager</a>, <a class="el" href="structripple_1_1PerfLog__test_1_1PerfLogParent.html#a46116902aa4f8b6f1a5c91a49854e8f0">ripple::PerfLog_test::PerfLogParent</a>, and <a class="el" href="classripple_1_1test_1_1Stoppable__test_1_1D.html#a247b2d122fe5ebeda596a7f0bff9d79a">ripple::test::Stoppable_test::D</a>.</p>
<p class="definition">Definition at line <a class="el" href="Stoppable_8cpp_source.html#l00080">80</a> of file <a class="el" href="Stoppable_8cpp_source.html">Stoppable.cpp</a>.</p>
</div>
</div>
<a id="a0f24b7fcb7e8679dfd3783e9ffe3bbde"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0f24b7fcb7e8679dfd3783e9ffe3bbde">&#9670;&nbsp;</a></span>onStart()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ripple::Stoppable::onStart </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Override called during start. </p>
<p>Reimplemented in <a class="el" href="classripple_1_1ApplicationImp.html#a21dd55310b1f0a99297b384518d6df25">ripple::ApplicationImp</a>, <a class="el" href="classripple_1_1OverlayImpl.html#a3918e80c1267d4f907730999a4f26008">ripple::OverlayImpl</a>, <a class="el" href="classripple_1_1test_1_1Stoppable__test_1_1Root.html#aa42c557911d8e76788e87c2d877750ed">ripple::test::Stoppable_test::Root</a>, <a class="el" href="classripple_1_1test_1_1Stoppable__test_1_1C.html#a5be3e389258ba50a85c06a5af860927e">ripple::test::Stoppable_test::C</a>, <a class="el" href="classripple_1_1test_1_1Stoppable__test_1_1I.html#ae470d42add62e9c7f0a80d3ef8cceaf7">ripple::test::Stoppable_test::I</a>, <a class="el" href="classripple_1_1test_1_1Stoppable__test_1_1B.html#af411953a02cb2ba6b5694ffd519aed7e">ripple::test::Stoppable_test::B</a>, <a class="el" href="classripple_1_1test_1_1Stoppable__test_1_1H.html#ae196a19d259fd57700c35f233c11c026">ripple::test::Stoppable_test::H</a>, <a class="el" href="classripple_1_1test_1_1Stoppable__test_1_1G.html#ad54103c4f31d04a7f5d6593583028049">ripple::test::Stoppable_test::G</a>, <a class="el" href="classripple_1_1SHAMapStoreImp.html#a06851331bd59c5b55221845549708a34">ripple::SHAMapStoreImp</a>, <a class="el" href="classripple_1_1test_1_1Stoppable__test_1_1A.html#a7683aa7a642d9f45973df12e2d50faf4">ripple::test::Stoppable_test::A</a>, <a class="el" href="classripple_1_1PeerFinder_1_1ManagerImp.html#aadd75f0fa58820b55705ba28adec085b">ripple::PeerFinder::ManagerImp</a>, <a class="el" href="classripple_1_1perf_1_1PerfLogImp.html#a81a7c17c2d7403d410f40266c8dc8a85">ripple::perf::PerfLogImp</a>, <a class="el" href="classripple_1_1test_1_1Stoppable__test_1_1F.html#aae263a3c2bc022bc75b2506345cbebcd">ripple::test::Stoppable_test::F</a>, <a class="el" href="classripple_1_1test_1_1Stoppable__test_1_1E.html#a3a98555a979eb1a3249205d75919f8ad">ripple::test::Stoppable_test::E</a>, <a class="el" href="classripple_1_1detail_1_1LedgerCleanerImp.html#a363652c7715c7176bff335387f97991f">ripple::detail::LedgerCleanerImp</a>, <a class="el" href="classripple_1_1test_1_1Stoppable__test_1_1J.html#ae2d5a662e72976386d89b013572172d1">ripple::test::Stoppable_test::J</a>, <a class="el" href="classripple_1_1LoadManager.html#a347fd7fdf32d02e17c676fdd92990cd4">ripple::LoadManager</a>, <a class="el" href="structripple_1_1PerfLog__test_1_1PerfLogParent.html#a29639c6dcd73b345d6592f25c0138f8e">ripple::PerfLog_test::PerfLogParent</a>, and <a class="el" href="classripple_1_1test_1_1Stoppable__test_1_1D.html#a279e901b5c96dfffe93a24af57c6dc3c">ripple::test::Stoppable_test::D</a>.</p>
<p class="definition">Definition at line <a class="el" href="Stoppable_8cpp_source.html#l00085">85</a> of file <a class="el" href="Stoppable_8cpp_source.html">Stoppable.cpp</a>.</p>
</div>
</div>
<a id="a4278b4c199fbe20a75d69610a8970c03"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4278b4c199fbe20a75d69610a8970c03">&#9670;&nbsp;</a></span>onStop()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ripple::Stoppable::onStop </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Override called when the stop notification is issued. </p>
<p>The call is made on an unspecified, implementation-specific thread. onStop and onChildrenStopped will never be called concurrently, across all <a class="el" href="classripple_1_1Stoppable.html" title="Provides an interface for starting and stopping.">Stoppable</a> objects descended from the same root, inclusive of the root.</p>
<p>It is safe to call isStopping, isStopped, and areChildrenStopped from within this function; The values returned will always be valid and never change during the callback.</p>
<p>The default implementation simply calls <a class="el" href="classripple_1_1Stoppable.html#a65a95f9c14637491df60d3a07518fa09" title="Called by derived classes to indicate that the stoppable has stopped.">stopped()</a>. This is applicable when the <a class="el" href="classripple_1_1Stoppable.html" title="Provides an interface for starting and stopping.">Stoppable</a> has a trivial stop operation (or no stop operation), and we are merely using the <a class="el" href="classripple_1_1Stoppable.html" title="Provides an interface for starting and stopping.">Stoppable</a> API to position it as a dependency of some parent service.</p>
<p>Thread safety: May not block for long periods. Guaranteed only to be called once. Must be safe to call from any thread at any time. </p>
<p>Reimplemented in <a class="el" href="classripple_1_1ApplicationImp.html#ac3e552208e87d45c4c4283ec92d8f597">ripple::ApplicationImp</a>, <a class="el" href="classripple_1_1NetworkOPsImp.html#a566af9184de6a79e72afeb03a2b9ef70">ripple::NetworkOPsImp</a>, <a class="el" href="classripple_1_1OverlayImpl.html#ac252980b7a02834b5a4577456ad8f7a3">ripple::OverlayImpl</a>, <a class="el" href="classripple_1_1test_1_1Stoppable__test_1_1Root.html#a7d8b2b342d239b17ac4363483faa30f8">ripple::test::Stoppable_test::Root</a>, <a class="el" href="classripple_1_1test_1_1Stoppable__test_1_1C.html#a0c231bfc40280225d0503fb038d7f3c1">ripple::test::Stoppable_test::C</a>, <a class="el" href="classripple_1_1test_1_1Stoppable__test_1_1I.html#adfef651261465710ea126b92a4bea7a2">ripple::test::Stoppable_test::I</a>, <a class="el" href="classripple_1_1InboundLedgersImp.html#a13863a89515101f87c811717eff67560">ripple::InboundLedgersImp</a>, <a class="el" href="classripple_1_1test_1_1Stoppable__test_1_1B.html#a4ba31e326d2e5c40012be3b7f771243a">ripple::test::Stoppable_test::B</a>, <a class="el" href="classripple_1_1test_1_1Stoppable__test_1_1H.html#a77d515e8d04274637def495440544e03">ripple::test::Stoppable_test::H</a>, <a class="el" href="classripple_1_1test_1_1Stoppable__test_1_1G.html#ab05f8bc37eef6d54af615290f2331f44">ripple::test::Stoppable_test::G</a>, <a class="el" href="classripple_1_1SHAMapStoreImp.html#ad51f8995dc2a26e24a6057ea904dcb4a">ripple::SHAMapStoreImp</a>, <a class="el" href="classripple_1_1JobQueue.html#a699f1396dab44ca8f0593e43e2b3f04b">ripple::JobQueue</a>, <a class="el" href="classripple_1_1test_1_1Stoppable__test_1_1A.html#ac4c9c208f2ba41c717841f4d34d198ec">ripple::test::Stoppable_test::A</a>, <a class="el" href="classripple_1_1InboundTransactionsImp.html#aa7e193d3f153d0bd6c294c1b060a62aa">ripple::InboundTransactionsImp</a>, <a class="el" href="classripple_1_1PeerFinder_1_1ManagerImp.html#a24a58d109ca55cd2e7926974bc9645f8">ripple::PeerFinder::ManagerImp</a>, <a class="el" href="classripple_1_1NodeStore_1_1Database.html#a0923c37ede6c7ffeca02f59f566cf588">ripple::NodeStore::Database</a>, <a class="el" href="classripple_1_1perf_1_1PerfLogImp.html#a3ecaa02f9bbc6c0cd3990688f8e5ee4b">ripple::perf::PerfLogImp</a>, <a class="el" href="classripple_1_1test_1_1Stoppable__test_1_1F.html#a4dc097199a6b09417838bca44fe29809">ripple::test::Stoppable_test::F</a>, <a class="el" href="classripple_1_1test_1_1Stoppable__test_1_1E.html#a72d702ae8591244422a5d8335f71e18f">ripple::test::Stoppable_test::E</a>, <a class="el" href="classripple_1_1NodeStore_1_1DatabaseShardImp.html#a9f17f5785642cce8324c56de29a14770">ripple::NodeStore::DatabaseShardImp</a>, <a class="el" href="classripple_1_1ServerHandlerImp.html#adb3155b91ed400c237732dc331b69d43">ripple::ServerHandlerImp</a>, <a class="el" href="classripple_1_1detail_1_1LedgerCleanerImp.html#ab4b28d4a1d4ebcba9c5b3c855dc2ace2">ripple::detail::LedgerCleanerImp</a>, <a class="el" href="classripple_1_1test_1_1Stoppable__test_1_1J.html#aaebc0ea2a7765741af4e28235c387f0b">ripple::test::Stoppable_test::J</a>, <a class="el" href="classripple_1_1LoadManager.html#a7db1c4190e9152cefdaa35d7f1d242f9">ripple::LoadManager</a>, <a class="el" href="classripple_1_1RPC_1_1ShardArchiveHandler.html#a12e34fdf5bd82be5f3738391578a9020">ripple::RPC::ShardArchiveHandler</a>, <a class="el" href="structripple_1_1PerfLog__test_1_1PerfLogParent.html#a5089e33090d781c5f0d959dc568b3244">ripple::PerfLog_test::PerfLogParent</a>, <a class="el" href="classripple_1_1test_1_1Stoppable__test_1_1D.html#ad20ec39dd30bd1ed235760fe8be4d644">ripple::test::Stoppable_test::D</a>, <a class="el" href="classripple_1_1NodeStoreScheduler.html#afb4cb30f4a2af0a88ed51eee872689f3">ripple::NodeStoreScheduler</a>, and <a class="el" href="classripple_1_1NodeStore_1_1TaskQueue.html#a621ef5d4bf00e8499bef58c8789686c3">ripple::NodeStore::TaskQueue</a>.</p>
<p class="definition">Definition at line <a class="el" href="Stoppable_8cpp_source.html#l00090">90</a> of file <a class="el" href="Stoppable_8cpp_source.html">Stoppable.cpp</a>.</p>
</div>
</div>
<a id="a944a3ffe59dc8f41185fe7b740aa3e8f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a944a3ffe59dc8f41185fe7b740aa3e8f">&#9670;&nbsp;</a></span>onChildrenStopped()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ripple::Stoppable::onChildrenStopped </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Override called when all children have stopped. </p>
<p>The call is made on an unspecified, implementation-specific thread. onStop and onChildrenStopped will never be called concurrently, across all <a class="el" href="classripple_1_1Stoppable.html" title="Provides an interface for starting and stopping.">Stoppable</a> objects descended from the same root, inclusive of the root.</p>
<p>It is safe to call isStopping, isStopped, and areChildrenStopped from within this function; The values returned will always be valid and never change during the callback.</p>
<p>The default implementation does nothing.</p>
<p>Thread safety: May not block for long periods. Guaranteed only to be called once. Must be safe to call from any thread at any time. </p>
<p>Reimplemented in <a class="el" href="classripple_1_1OverlayImpl.html#a3a2a34dcf3647aad5b8860744fc4a324">ripple::OverlayImpl</a>, <a class="el" href="classripple_1_1test_1_1Stoppable__test_1_1Root.html#a2207576109879034546928ca55b1d700">ripple::test::Stoppable_test::Root</a>, <a class="el" href="classripple_1_1test_1_1Stoppable__test_1_1C.html#a02efcac1ce2652ab65cd909ddb6f836d">ripple::test::Stoppable_test::C</a>, <a class="el" href="classripple_1_1test_1_1Stoppable__test_1_1I.html#a0c3fb7cde430461b5ec75375c0ad6c54">ripple::test::Stoppable_test::I</a>, <a class="el" href="classripple_1_1test_1_1Stoppable__test_1_1B.html#a01878ee5cc7e155ea8c626e7e02312a3">ripple::test::Stoppable_test::B</a>, <a class="el" href="classripple_1_1JobQueue.html#ae768881eecd962f76f12b290fe991cbe">ripple::JobQueue</a>, <a class="el" href="classripple_1_1test_1_1Stoppable__test_1_1H.html#a5e33be0f2cb72f8f88b874d940f04365">ripple::test::Stoppable_test::H</a>, <a class="el" href="classripple_1_1test_1_1Stoppable__test_1_1G.html#a04c59bc636bd73be750c95342d88b939">ripple::test::Stoppable_test::G</a>, <a class="el" href="classripple_1_1SHAMapStoreImp.html#a0c59947861cceb42b88e2218b581e985">ripple::SHAMapStoreImp</a>, <a class="el" href="classripple_1_1test_1_1Stoppable__test_1_1A.html#a39e3b1e4e61a89c77f67e1cea7b9ff6f">ripple::test::Stoppable_test::A</a>, <a class="el" href="classripple_1_1NodeStore_1_1Database.html#ae84b30410af69ec7e7adcdb6265a4af8">ripple::NodeStore::Database</a>, <a class="el" href="classripple_1_1perf_1_1PerfLogImp.html#a32612bcc8d906ddf25a412d4024b33da">ripple::perf::PerfLogImp</a>, <a class="el" href="classripple_1_1test_1_1Stoppable__test_1_1F.html#ae935bf8f308a9cf15568e36e5da6338c">ripple::test::Stoppable_test::F</a>, <a class="el" href="classripple_1_1test_1_1Stoppable__test_1_1E.html#a990e49f21b4787bb7e318887445cc6b2">ripple::test::Stoppable_test::E</a>, <a class="el" href="classripple_1_1test_1_1Stoppable__test_1_1J.html#ad9378ab66db740d19cb2aea688a1647a">ripple::test::Stoppable_test::J</a>, <a class="el" href="structripple_1_1PerfLog__test_1_1PerfLogParent.html#a8061f5ed2fbbdca8ea5438ea3b6a6c3f">ripple::PerfLog_test::PerfLogParent</a>, <a class="el" href="classripple_1_1test_1_1Stoppable__test_1_1D.html#a28e05fec1dc41788a0616d349f209ce2">ripple::test::Stoppable_test::D</a>, and <a class="el" href="classripple_1_1NodeStoreScheduler.html#a4f4bf5ea195e8d2cf94967e03e6ec375">ripple::NodeStoreScheduler</a>.</p>
<p class="definition">Definition at line <a class="el" href="Stoppable_8cpp_source.html#l00096">96</a> of file <a class="el" href="Stoppable_8cpp_source.html">Stoppable.cpp</a>.</p>
</div>
</div>
<a id="a390c62d40a1ca754dfb2de4befa02b0d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a390c62d40a1ca754dfb2de4befa02b0d">&#9670;&nbsp;</a></span>prepareRecursive()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ripple::Stoppable::prepareRecursive </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Stoppable_8cpp_source.html#l00103">103</a> of file <a class="el" href="Stoppable_8cpp_source.html">Stoppable.cpp</a>.</p>
</div>
</div>
<a id="ab53b667e9786bed2c10dd3fcd02b517f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab53b667e9786bed2c10dd3fcd02b517f">&#9670;&nbsp;</a></span>startRecursive()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ripple::Stoppable::startRecursive </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Stoppable_8cpp_source.html#l00113">113</a> of file <a class="el" href="Stoppable_8cpp_source.html">Stoppable.cpp</a>.</p>
</div>
</div>
<a id="a34ddbefa8dda0aab52b8ecf493833d62"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a34ddbefa8dda0aab52b8ecf493833d62">&#9670;&nbsp;</a></span>stopAsyncRecursive()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ripple::Stoppable::stopAsyncRecursive </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classbeast_1_1Journal.html">beast::Journal</a>&#160;</td>
<td class="paramname"><em>j</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Stoppable_8cpp_source.html#l00123">123</a> of file <a class="el" href="Stoppable_8cpp_source.html">Stoppable.cpp</a>.</p>
</div>
</div>
<a id="a294e4d3874e76f53a443cb4df306913f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a294e4d3874e76f53a443cb4df306913f">&#9670;&nbsp;</a></span>stopRecursive()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ripple::Stoppable::stopRecursive </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classbeast_1_1Journal.html">beast::Journal</a>&#160;</td>
<td class="paramname"><em>j</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Stoppable_8cpp_source.html#l00134">134</a> of file <a class="el" href="Stoppable_8cpp_source.html">Stoppable.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a3bee0684bbf67bc8c2f974cc30523cea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3bee0684bbf67bc8c2f974cc30523cea">&#9670;&nbsp;</a></span>m_name</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> ripple::Stoppable::m_name</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Stoppable_8h_source.html#l00338">338</a> of file <a class="el" href="Stoppable_8h_source.html">Stoppable.h</a>.</p>
</div>
</div>
<a id="a3a889a7b2e1b4c0fd463c51abfaa0ee0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3a889a7b2e1b4c0fd463c51abfaa0ee0">&#9670;&nbsp;</a></span>m_root</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1RootStoppable.html">RootStoppable</a>&amp; ripple::Stoppable::m_root</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Stoppable_8h_source.html#l00339">339</a> of file <a class="el" href="Stoppable_8h_source.html">Stoppable.h</a>.</p>
</div>
</div>
<a id="ab9ece0159fb3954819b6b6f1672ac2e4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab9ece0159fb3954819b6b6f1672ac2e4">&#9670;&nbsp;</a></span>m_child</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structripple_1_1Stoppable_1_1Child.html">Child</a> ripple::Stoppable::m_child</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Stoppable_8h_source.html#l00340">340</a> of file <a class="el" href="Stoppable_8h_source.html">Stoppable.h</a>.</p>
</div>
</div>
<a id="a9d39131e97d8faa6beb1d36eab19dc2f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9d39131e97d8faa6beb1d36eab19dc2f">&#9670;&nbsp;</a></span>m_stopped</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/atomic/atomic.html">std::atomic</a>&lt;bool&gt; ripple::Stoppable::m_stopped {false}</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Stoppable_8h_source.html#l00341">341</a> of file <a class="el" href="Stoppable_8h_source.html">Stoppable.h</a>.</p>
</div>
</div>
<a id="a8c1e09326ea6d61009b6630c9e297c89"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8c1e09326ea6d61009b6630c9e297c89">&#9670;&nbsp;</a></span>m_childrenStopped</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/atomic/atomic.html">std::atomic</a>&lt;bool&gt; ripple::Stoppable::m_childrenStopped {false}</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Stoppable_8h_source.html#l00342">342</a> of file <a class="el" href="Stoppable_8h_source.html">Stoppable.h</a>.</p>
</div>
</div>
<a id="adc549cdc2b0ebef1878e6d79c496be4d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adc549cdc2b0ebef1878e6d79c496be4d">&#9670;&nbsp;</a></span>m_children</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1Stoppable.html#a43594a8835ccb53d7b80983694d26cad">Children</a> ripple::Stoppable::m_children</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Stoppable_8h_source.html#l00343">343</a> of file <a class="el" href="Stoppable_8h_source.html">Stoppable.h</a>.</p>
</div>
</div>
<a id="a3c9a256ee2a1f891a042dda5c89360c0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3c9a256ee2a1f891a042dda5c89360c0">&#9670;&nbsp;</a></span>m_cv</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/thread/condition_variable.html">std::condition_variable</a> ripple::Stoppable::m_cv</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Stoppable_8h_source.html#l00344">344</a> of file <a class="el" href="Stoppable_8h_source.html">Stoppable.h</a>.</p>
</div>
</div>
<a id="afb1038efa534f43ebbd76db775592aaf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afb1038efa534f43ebbd76db775592aaf">&#9670;&nbsp;</a></span>m_mut</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/thread/mutex.html">std::mutex</a> ripple::Stoppable::m_mut</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Stoppable_8h_source.html#l00345">345</a> of file <a class="el" href="Stoppable_8h_source.html">Stoppable.h</a>.</p>
</div>
</div>
<a id="a12f304b9baab521c4f5f8291485f1391"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a12f304b9baab521c4f5f8291485f1391">&#9670;&nbsp;</a></span>m_is_stopping</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool ripple::Stoppable::m_is_stopping = false</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Stoppable_8h_source.html#l00346">346</a> of file <a class="el" href="Stoppable_8h_source.html">Stoppable.h</a>.</p>
</div>
</div>
<a id="a1538bf3e4636b78efa3d30a5596eddf7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1538bf3e4636b78efa3d30a5596eddf7">&#9670;&nbsp;</a></span>hasParent_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool ripple::Stoppable::hasParent_ {false}</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Stoppable_8h_source.html#l00347">347</a> of file <a class="el" href="Stoppable_8h_source.html">Stoppable.h</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink