mirror of
https://github.com/XRPLF/rippled.git
synced 2025-12-06 17:27:55 +00:00
1217 lines
74 KiB
HTML
1217 lines
74 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.17"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>rippled: ripple::NodeStoreScheduler 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&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="namespaceripple.html">ripple</a></li><li class="navelem"><a class="el" href="classripple_1_1NodeStoreScheduler.html">NodeStoreScheduler</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pro-methods">Protected Member Functions</a> |
|
|
<a href="#pri-types">Private Types</a> |
|
|
<a href="#pri-methods">Private Member Functions</a> |
|
|
<a href="#pri-attribs">Private Attributes</a> |
|
|
<a href="classripple_1_1NodeStoreScheduler-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">ripple::NodeStoreScheduler Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>A <a class="el" href="classripple_1_1NodeStore_1_1Scheduler.html" title="Scheduling for asynchronous backend activity.">NodeStore::Scheduler</a> which uses the <a class="el" href="classripple_1_1JobQueue.html" title="A pool of threads to perform work.">JobQueue</a> and implements the <a class="el" href="classripple_1_1Stoppable.html" title="Provides an interface for starting and stopping.">Stoppable</a> API.
|
|
<a href="classripple_1_1NodeStoreScheduler.html#details">More...</a></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for ripple::NodeStoreScheduler:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classripple_1_1NodeStoreScheduler__inherit__graph.png" border="0" usemap="#ripple_1_1NodeStoreScheduler_inherit__map" alt="Inheritance graph"/></div>
|
|
<map name="ripple_1_1NodeStoreScheduler_inherit__map" id="ripple_1_1NodeStoreScheduler_inherit__map">
|
|
<area shape="rect" title="A NodeStore::Scheduler which uses the JobQueue and implements the Stoppable API." alt="" coords="57,95,256,121"/>
|
|
<area shape="rect" href="classripple_1_1NodeStore_1_1Scheduler.html" title="Scheduling for asynchronous backend activity." alt="" coords="5,5,148,47"/>
|
|
<area shape="rect" href="classripple_1_1Stoppable.html" title="Provides an interface for starting and stopping." alt="" coords="172,13,304,39"/>
|
|
</map>
|
|
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
|
|
<div class="dynheader">
|
|
Collaboration diagram for ripple::NodeStoreScheduler:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classripple_1_1NodeStoreScheduler__coll__graph.png" border="0" usemap="#ripple_1_1NodeStoreScheduler_coll__map" alt="Collaboration graph"/></div>
|
|
<map name="ripple_1_1NodeStoreScheduler_coll__map" id="ripple_1_1NodeStoreScheduler_coll__map">
|
|
<area shape="rect" title="A NodeStore::Scheduler which uses the JobQueue and implements the Stoppable API." alt="" coords="2700,262,2899,289"/>
|
|
<area shape="rect" href="classripple_1_1NodeStore_1_1Scheduler.html" title="Scheduling for asynchronous backend activity." alt="" coords="2423,5,2565,47"/>
|
|
<area shape="rect" href="classripple_1_1Stoppable.html" title="Provides an interface for starting and stopping." alt="" coords="1102,306,1234,333"/>
|
|
<area shape="rect" href="classripple_1_1RootStoppable.html" title=" " alt="" coords="1437,323,1599,350"/>
|
|
<area shape="rect" href="structripple_1_1Stoppable_1_1Child.html" title=" " alt="" coords="1448,176,1588,217"/>
|
|
<area shape="rect" href="classripple_1_1JobQueue.html" title="A pool of threads to perform work." alt="" coords="2429,1182,2559,1209"/>
|
|
<area shape="rect" href="http://en.cppreference.com/w/cpp/atomic/atomic.html" title=" " alt="" coords="684,217,837,243"/>
|
|
<area shape="rect" href="http://en.cppreference.com/w/cpp/thread/condition_variable.html" title=" " alt="" coords="675,522,846,549"/>
|
|
<area shape="rect" href="classripple_1_1ClosureCounter.html" title=" " alt="" coords="1085,497,1251,539"/>
|
|
<area shape="rect" href="classripple_1_1Workers.html" title="A group of threads that process tasks." alt="" coords="1458,1103,1578,1130"/>
|
|
<area shape="rect" href="classripple_1_1basic__semaphore.html" title=" " alt="" coords="1067,1053,1269,1109"/>
|
|
<area shape="rect" href="http://en.cppreference.com/w/cpp/thread/mutex.html" title="STL class." alt="" coords="335,746,427,773"/>
|
|
<area shape="rect" href="classripple_1_1LoadMonitor.html" title=" " alt="" coords="687,1619,834,1646"/>
|
|
<area shape="rect" href="http://en.cppreference.com/w/cpp/atomic/atomic.html" title=" " alt="" coords="689,686,832,713"/>
|
|
<area shape="rect" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title="STL class." alt="" coords="717,1415,804,1442"/>
|
|
<area shape="rect" href="classripple_1_1JobTypeInfo.html" title="Holds all the 'static' information about a job, which does not change." alt="" coords="1097,1658,1239,1685"/>
|
|
<area shape="rect" href="classripple_1_1Job.html" title=" " alt="" coords="1834,1454,1921,1481"/>
|
|
<area shape="rect" href="classripple_1_1LoadEvent.html" title=" " alt="" coords="1101,1481,1235,1507"/>
|
|
<area shape="rect" href="classbeast_1_1LockFreeStack_1_1Node.html" title=" " alt="" coords="5,1061,184,1103"/>
|
|
<area shape="rect" href="http://en.cppreference.com/w/cpp/atomic/atomic.html" title=" " alt="" coords="285,1113,476,1155"/>
|
|
<area shape="rect" href="classbeast_1_1LockFreeStack.html" title=" " alt="" coords="681,456,840,497"/>
|
|
<area shape="rect" href="classbeast_1_1LockFreeStack.html" title=" " alt="" coords="653,1130,868,1186"/>
|
|
<area shape="rect" href="classbeast_1_1LockFreeStack.html" title=" " alt="" coords="659,1211,863,1252"/>
|
|
<area shape="rect" href="structripple_1_1Workers_1_1Callback.html" title="Called to perform tasks as needed." alt="" coords="1076,797,1260,823"/>
|
|
<area shape="rect" href="classbeast_1_1insight_1_1Gauge.html" title="A metric for measuring an integral value." alt="" coords="2136,645,2296,671"/>
|
|
<area shape="rect" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html" title=" " alt="" coords="1792,625,1963,667"/>
|
|
<area shape="rect" href="classbeast_1_1insight_1_1GaugeImpl.html" title=" " alt="" coords="1423,625,1613,651"/>
|
|
<area shape="rect" href="http://en.cppreference.com/w/cpp/memory/enable_shared_from_this.html" title=" " alt="" coords="1072,615,1264,656"/>
|
|
<area shape="rect" href="structripple_1_1JobTypeData.html" title=" " alt="" coords="1803,1719,1951,1746"/>
|
|
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/map.html" title=" " alt="" coords="2142,1712,2290,1753"/>
|
|
<area shape="rect" href="http://en.cppreference.com/w/cpp/chrono/duration.html" title=" " alt="" coords="289,1745,473,1771"/>
|
|
<area shape="rect" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="329,1539,432,1566"/>
|
|
<area shape="rect" href="http://en.cppreference.com/w/cpp/chrono/time_point.html" title=" " alt="" coords="295,1612,467,1653"/>
|
|
<area shape="rect" href="classbeast_1_1Journal.html" title="A generic endpoint for log messages." alt="" coords="325,1809,436,1835"/>
|
|
<area shape="rect" href="classbeast_1_1Journal_1_1Sink.html" title="Abstraction for the underlying message destination." alt="" coords="21,1809,168,1835"/>
|
|
<area shape="rect" href="classbeast_1_1insight_1_1Event.html" title="A metric for reporting event timing." alt="" coords="1441,1777,1595,1803"/>
|
|
<area shape="rect" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html" title=" " alt="" coords="1083,1780,1253,1821"/>
|
|
<area shape="rect" href="classbeast_1_1insight_1_1EventImpl.html" title=" " alt="" coords="669,1814,853,1841"/>
|
|
<area shape="rect" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html" title=" " alt="" coords="1415,1851,1621,1878"/>
|
|
<area shape="rect" href="classbeast_1_1insight_1_1Collector.html" title="Interface for a manager that allows collection of metrics." alt="" coords="1080,1851,1256,1878"/>
|
|
<area shape="rect" href="classbeast_1_1insight_1_1Hook.html" title="A reference to a handler for performing polled collection." alt="" coords="2140,703,2292,730"/>
|
|
<area shape="rect" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html" title=" " alt="" coords="1792,691,1963,732"/>
|
|
<area shape="rect" href="classbeast_1_1insight_1_1HookImpl.html" title=" " alt="" coords="1427,690,1609,717"/>
|
|
<area shape="rect" href="http://en.cppreference.com/w/cpp/memory/enable_shared_from_this.html" title=" " alt="" coords="1076,680,1260,721"/>
|
|
<area shape="rect" href="http://en.cppreference.com/w/cpp/types/size_t.html" title=" " alt="" coords="717,1079,805,1106"/>
|
|
<area shape="rect" href="classripple_1_1perf_1_1PerfLog.html" title="Singleton class that maintains performance counters and optionally writes Json-formatted data to a di..." alt="" coords="1093,1321,1243,1347"/>
|
|
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/set.html" title=" " alt="" coords="2133,1357,2299,1383"/>
|
|
<area shape="rect" href="http://en.cppreference.com/w/cpp/utility/functional/function.html" title=" " alt="" coords="1445,1356,1591,1397"/>
|
|
<area shape="rect" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html" title=" " alt="" coords="1433,1473,1603,1515"/>
|
|
<area shape="rect" href="http://en.cppreference.com/w/cpp/utility/functional/function.html" title=" " alt="" coords="1445,1591,1591,1632"/>
|
|
</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:a96b26e08b9c88444a926c142508f1c0c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStoreScheduler.html#a96b26e08b9c88444a926c142508f1c0c">NodeStoreScheduler</a> (<a class="el" href="classripple_1_1Stoppable.html">Stoppable</a> &parent)</td></tr>
|
|
<tr class="separator:a96b26e08b9c88444a926c142508f1c0c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa867bc4406b1edb87c76e6fd423175b1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStoreScheduler.html#aa867bc4406b1edb87c76e6fd423175b1">setJobQueue</a> (<a class="el" href="classripple_1_1JobQueue.html">JobQueue</a> &jobQueue)</td></tr>
|
|
<tr class="separator:aa867bc4406b1edb87c76e6fd423175b1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afb4cb30f4a2af0a88ed51eee872689f3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStoreScheduler.html#afb4cb30f4a2af0a88ed51eee872689f3">onStop</a> () override</td></tr>
|
|
<tr class="memdesc:afb4cb30f4a2af0a88ed51eee872689f3"><td class="mdescLeft"> </td><td class="mdescRight">Override called when the stop notification is issued. <a href="classripple_1_1NodeStoreScheduler.html#afb4cb30f4a2af0a88ed51eee872689f3">More...</a><br /></td></tr>
|
|
<tr class="separator:afb4cb30f4a2af0a88ed51eee872689f3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4f4bf5ea195e8d2cf94967e03e6ec375"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStoreScheduler.html#a4f4bf5ea195e8d2cf94967e03e6ec375">onChildrenStopped</a> () override</td></tr>
|
|
<tr class="memdesc:a4f4bf5ea195e8d2cf94967e03e6ec375"><td class="mdescLeft"> </td><td class="mdescRight">Override called when all children have stopped. <a href="classripple_1_1NodeStoreScheduler.html#a4f4bf5ea195e8d2cf94967e03e6ec375">More...</a><br /></td></tr>
|
|
<tr class="separator:a4f4bf5ea195e8d2cf94967e03e6ec375"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0b1c3260477e401b7e57493b0aaf9a3a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStoreScheduler.html#a0b1c3260477e401b7e57493b0aaf9a3a">scheduleTask</a> (<a class="el" href="structripple_1_1NodeStore_1_1Task.html">NodeStore::Task</a> &task) override</td></tr>
|
|
<tr class="memdesc:a0b1c3260477e401b7e57493b0aaf9a3a"><td class="mdescLeft"> </td><td class="mdescRight">Schedules a task. <a href="classripple_1_1NodeStoreScheduler.html#a0b1c3260477e401b7e57493b0aaf9a3a">More...</a><br /></td></tr>
|
|
<tr class="separator:a0b1c3260477e401b7e57493b0aaf9a3a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a042848ff97f97cff8a602ffec6b9f807"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStoreScheduler.html#a042848ff97f97cff8a602ffec6b9f807">onFetch</a> (<a class="el" href="structripple_1_1NodeStore_1_1FetchReport.html">NodeStore::FetchReport</a> const &report) override</td></tr>
|
|
<tr class="memdesc:a042848ff97f97cff8a602ffec6b9f807"><td class="mdescLeft"> </td><td class="mdescRight">Reports completion of a fetch Allows the scheduler to monitor the node store's performance. <a href="classripple_1_1NodeStoreScheduler.html#a042848ff97f97cff8a602ffec6b9f807">More...</a><br /></td></tr>
|
|
<tr class="separator:a042848ff97f97cff8a602ffec6b9f807"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0b9464b915021b488e3d2e22b840a62f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStoreScheduler.html#a0b9464b915021b488e3d2e22b840a62f">onBatchWrite</a> (<a class="el" href="structripple_1_1NodeStore_1_1BatchWriteReport.html">NodeStore::BatchWriteReport</a> const &report) override</td></tr>
|
|
<tr class="memdesc:a0b9464b915021b488e3d2e22b840a62f"><td class="mdescLeft"> </td><td class="mdescRight">Reports the completion of a batch write Allows the scheduler to monitor the node store's performance. <a href="classripple_1_1NodeStoreScheduler.html#a0b9464b915021b488e3d2e22b840a62f">More...</a><br /></td></tr>
|
|
<tr class="separator:a0b9464b915021b488e3d2e22b840a62f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae9b6cb02b4e1128bd2c4e1a81c9d695c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1RootStoppable.html">RootStoppable</a> & </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"> </td></tr>
|
|
<tr class="memitem:adea135697761febf430a8628814c7902"><td class="memItemLeft" align="right" valign="top">void </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> &parent)</td></tr>
|
|
<tr class="memdesc:adea135697761febf430a8628814c7902"><td class="mdescLeft"> </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"> </td></tr>
|
|
<tr class="memitem:a836b8737444ef1133c3596e61010fa80"><td class="memItemLeft" align="right" valign="top">bool </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"> </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"> </td></tr>
|
|
<tr class="memitem:af1e1447ecb573d2341c8a71afd3e76da"><td class="memItemLeft" align="right" valign="top">bool </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"> </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"> </td></tr>
|
|
<tr class="memitem:a9ec6fda89ff8bc63251a9c3682311e5d"><td class="memItemLeft" align="right" valign="top">bool </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"> </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"> </td></tr>
|
|
<tr class="memitem:acc824cd8bdcffbac3c919c7e6009dea5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple.html#adf17c8e58c57ecf0ed6cbc7ee1c2ab22">JobCounter</a> & </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"> </td></tr>
|
|
<tr class="memitem:aca4a925fd0df7e3a3bca51c9593e6a6e"><td class="memItemLeft" align="right" valign="top">bool </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 &t)</td></tr>
|
|
<tr class="memdesc:aca4a925fd0df7e3a3bca51c9593e6a6e"><td class="mdescLeft"> </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"> </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 </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"> </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"> </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 </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>< <a class="el" href="structripple_1_1Stoppable_1_1Child.html">Child</a> ></td></tr>
|
|
<tr class="separator:a43594a8835ccb53d7b80983694d26cad"><td class="memSeparator" colspan="2"> </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:a1205e3496daf620da17f4e328b5d891e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStoreScheduler.html#a1205e3496daf620da17f4e328b5d891e">doTask</a> (<a class="el" href="structripple_1_1NodeStore_1_1Task.html">NodeStore::Task</a> &task)</td></tr>
|
|
<tr class="separator:a1205e3496daf620da17f4e328b5d891e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab2a5544b4bfc0dccdc6a2a46f6ff5d84"><td class="memItemLeft" align="right" valign="top">virtual void </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"> </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"> </td></tr>
|
|
<tr class="memitem:a0f24b7fcb7e8679dfd3783e9ffe3bbde"><td class="memItemLeft" align="right" valign="top">virtual void </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"> </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"> </td></tr>
|
|
<tr class="memitem:a390c62d40a1ca754dfb2de4befa02b0d"><td class="memItemLeft" align="right" valign="top">void </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"> </td></tr>
|
|
<tr class="memitem:ab53b667e9786bed2c10dd3fcd02b517f"><td class="memItemLeft" align="right" valign="top">void </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"> </td></tr>
|
|
<tr class="memitem:a34ddbefa8dda0aab52b8ecf493833d62"><td class="memItemLeft" align="right" valign="top">void </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"> </td></tr>
|
|
<tr class="memitem:a294e4d3874e76f53a443cb4df306913f"><td class="memItemLeft" align="right" valign="top">void </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"> </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:a146acebc53e84da88b499513783d6687"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1JobQueue.html">JobQueue</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStoreScheduler.html#a146acebc53e84da88b499513783d6687">m_jobQueue</a> {nullptr}</td></tr>
|
|
<tr class="separator:a146acebc53e84da88b499513783d6687"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a658d50b2c4bfdb0446f9527551aa26bb"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/atomic/atomic.html">std::atomic</a>< int > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStoreScheduler.html#a658d50b2c4bfdb0446f9527551aa26bb">m_taskCount</a> {0}</td></tr>
|
|
<tr class="separator:a658d50b2c4bfdb0446f9527551aa26bb"><td class="memSeparator" colspan="2"> </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> </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"> </td></tr>
|
|
<tr class="memitem:a3a889a7b2e1b4c0fd463c51abfaa0ee0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1RootStoppable.html">RootStoppable</a> & </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"> </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> </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"> </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>< bool > </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"> </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>< bool > </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"> </td></tr>
|
|
<tr class="memitem:adc549cdc2b0ebef1878e6d79c496be4d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1Stoppable.html#a43594a8835ccb53d7b80983694d26cad">Children</a> </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"> </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> </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"> </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> </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"> </td></tr>
|
|
<tr class="memitem:a12f304b9baab521c4f5f8291485f1391"><td class="memItemLeft" align="right" valign="top">bool </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"> </td></tr>
|
|
<tr class="memitem:a1538bf3e4636b78efa3d30a5596eddf7"><td class="memItemLeft" align="right" valign="top">bool </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"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>A <a class="el" href="classripple_1_1NodeStore_1_1Scheduler.html" title="Scheduling for asynchronous backend activity.">NodeStore::Scheduler</a> which uses the <a class="el" href="classripple_1_1JobQueue.html" title="A pool of threads to perform work.">JobQueue</a> and implements the <a class="el" href="classripple_1_1Stoppable.html" title="Provides an interface for starting and stopping.">Stoppable</a> API. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="NodeStoreScheduler_8h_source.html#l00032">32</a> of file <a class="el" href="NodeStoreScheduler_8h_source.html">NodeStoreScheduler.h</a>.</p>
|
|
</div><h2 class="groupheader">Member Typedef Documentation</h2>
|
|
<a id="a43594a8835ccb53d7b80983694d26cad"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a43594a8835ccb53d7b80983694d26cad">◆ </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><<a class="el" href="structripple_1_1Stoppable_1_1Child.html">Child</a>></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#l00319">319</a> of file <a class="el" href="Stoppable_8h_source.html">Stoppable.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a96b26e08b9c88444a926c142508f1c0c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a96b26e08b9c88444a926c142508f1c0c">◆ </a></span>NodeStoreScheduler()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ripple::NodeStoreScheduler::NodeStoreScheduler </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1Stoppable.html">Stoppable</a> & </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="NodeStoreScheduler_8cpp_source.html#l00025">25</a> of file <a class="el" href="NodeStoreScheduler_8cpp_source.html">NodeStoreScheduler.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="aa867bc4406b1edb87c76e6fd423175b1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa867bc4406b1edb87c76e6fd423175b1">◆ </a></span>setJobQueue()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ripple::NodeStoreScheduler::setJobQueue </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1JobQueue.html">JobQueue</a> & </td>
|
|
<td class="paramname"><em>jobQueue</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="NodeStoreScheduler_8cpp_source.html#l00031">31</a> of file <a class="el" href="NodeStoreScheduler_8cpp_source.html">NodeStoreScheduler.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afb4cb30f4a2af0a88ed51eee872689f3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afb4cb30f4a2af0a88ed51eee872689f3">◆ </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::NodeStoreScheduler::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">override</span><span class="mlabel">virtual</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 from <a class="el" href="classripple_1_1Stoppable.html#a4278b4c199fbe20a75d69610a8970c03">ripple::Stoppable</a>.</p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="NodeStoreScheduler_8cpp_source.html#l00037">37</a> of file <a class="el" href="NodeStoreScheduler_8cpp_source.html">NodeStoreScheduler.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4f4bf5ea195e8d2cf94967e03e6ec375"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4f4bf5ea195e8d2cf94967e03e6ec375">◆ </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::NodeStoreScheduler::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">override</span><span class="mlabel">virtual</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 from <a class="el" href="classripple_1_1Stoppable.html#a944a3ffe59dc8f41185fe7b740aa3e8f">ripple::Stoppable</a>.</p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="NodeStoreScheduler_8cpp_source.html#l00042">42</a> of file <a class="el" href="NodeStoreScheduler_8cpp_source.html">NodeStoreScheduler.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0b1c3260477e401b7e57493b0aaf9a3a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0b1c3260477e401b7e57493b0aaf9a3a">◆ </a></span>scheduleTask()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ripple::NodeStoreScheduler::scheduleTask </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structripple_1_1NodeStore_1_1Task.html">NodeStore::Task</a> & </td>
|
|
<td class="paramname"><em>task</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Schedules a task. </p>
|
|
<p>Depending on the implementation, the task may be invoked either on the current thread of execution, or an unspecified implementation-defined foreign thread. </p>
|
|
|
|
<p>Implements <a class="el" href="classripple_1_1NodeStore_1_1Scheduler.html#af3734617d65f9903e3b33d3ee6de8102">ripple::NodeStore::Scheduler</a>.</p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="NodeStoreScheduler_8cpp_source.html#l00049">49</a> of file <a class="el" href="NodeStoreScheduler_8cpp_source.html">NodeStoreScheduler.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a042848ff97f97cff8a602ffec6b9f807"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a042848ff97f97cff8a602ffec6b9f807">◆ </a></span>onFetch()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ripple::NodeStoreScheduler::onFetch </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structripple_1_1NodeStore_1_1FetchReport.html">NodeStore::FetchReport</a> const & </td>
|
|
<td class="paramname"><em>report</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reports completion of a fetch Allows the scheduler to monitor the node store's performance. </p>
|
|
|
|
<p>Implements <a class="el" href="classripple_1_1NodeStore_1_1Scheduler.html#acf9a08ef64dd95c98da3e095ee919171">ripple::NodeStore::Scheduler</a>.</p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="NodeStoreScheduler_8cpp_source.html#l00079">79</a> of file <a class="el" href="NodeStoreScheduler_8cpp_source.html">NodeStoreScheduler.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0b9464b915021b488e3d2e22b840a62f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0b9464b915021b488e3d2e22b840a62f">◆ </a></span>onBatchWrite()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ripple::NodeStoreScheduler::onBatchWrite </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structripple_1_1NodeStore_1_1BatchWriteReport.html">NodeStore::BatchWriteReport</a> const & </td>
|
|
<td class="paramname"><em>report</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reports the completion of a batch write Allows the scheduler to monitor the node store's performance. </p>
|
|
|
|
<p>Implements <a class="el" href="classripple_1_1NodeStore_1_1Scheduler.html#a0adffe6c4e42f062bd47864f4e615a39">ripple::NodeStore::Scheduler</a>.</p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="NodeStoreScheduler_8cpp_source.html#l00089">89</a> of file <a class="el" href="NodeStoreScheduler_8cpp_source.html">NodeStoreScheduler.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1205e3496daf620da17f4e328b5d891e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1205e3496daf620da17f4e328b5d891e">◆ </a></span>doTask()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ripple::NodeStoreScheduler::doTask </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structripple_1_1NodeStore_1_1Task.html">NodeStore::Task</a> & </td>
|
|
<td class="paramname"><em>task</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="NodeStoreScheduler_8cpp_source.html#l00063">63</a> of file <a class="el" href="NodeStoreScheduler_8cpp_source.html">NodeStoreScheduler.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae9b6cb02b4e1128bd2c4e1a81c9d695c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae9b6cb02b4e1128bd2c4e1a81c9d695c">◆ </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>& 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#l00214">214</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">◆ </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> & </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">◆ </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">◆ </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">◆ </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">◆ </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> & 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#l00437">437</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">◆ </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 & </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#l00455">455</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">◆ </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">◆ </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">◆ </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_1GRPCServer.html#acf26b69bea55fa6a49fb7528cb5e00c6">ripple::GRPCServer</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="a390c62d40a1ca754dfb2de4befa02b0d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a390c62d40a1ca754dfb2de4befa02b0d">◆ </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">◆ </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">◆ </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> </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">◆ </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> </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="a146acebc53e84da88b499513783d6687"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a146acebc53e84da88b499513783d6687">◆ </a></span>m_jobQueue</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_1JobQueue.html">JobQueue</a>* ripple::NodeStoreScheduler::m_jobQueue {nullptr}</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="NodeStoreScheduler_8h_source.html#l00058">58</a> of file <a class="el" href="NodeStoreScheduler_8h_source.html">NodeStoreScheduler.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a658d50b2c4bfdb0446f9527551aa26bb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a658d50b2c4bfdb0446f9527551aa26bb">◆ </a></span>m_taskCount</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><int> ripple::NodeStoreScheduler::m_taskCount {0}</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="NodeStoreScheduler_8h_source.html#l00059">59</a> of file <a class="el" href="NodeStoreScheduler_8h_source.html">NodeStoreScheduler.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3bee0684bbf67bc8c2f974cc30523cea"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3bee0684bbf67bc8c2f974cc30523cea">◆ </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#l00339">339</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">◆ </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>& 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#l00340">340</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">◆ </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#l00341">341</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">◆ </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><bool> 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#l00342">342</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">◆ </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><bool> 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#l00343">343</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">◆ </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#l00344">344</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">◆ </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#l00345">345</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">◆ </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#l00346">346</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">◆ </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#l00347">347</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">◆ </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#l00348">348</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  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.17
|
|
</small></address>
|
|
</body>
|
|
</html>
|