mirror of
https://github.com/XRPLF/rippled.git
synced 2026-02-03 13:35:25 +00:00
131 lines
13 KiB
HTML
131 lines
13 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.9.8"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>rippled: NodeStoreScheduler.h Source File</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">rippled
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.8 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(document).ready(function() { init_codefold(0); });
|
|
/* @license-end */
|
|
</script>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_a62226f9e3a6c7c5a3be455e2f87ae01.html">xrpld</a></li><li class="navelem"><a class="el" href="dir_c69db3203fa08a9ff994909ba6ee9783.html">app</a></li><li class="navelem"><a class="el" href="dir_c1a59f40492cf594814ad34c94ddc6cd.html">main</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle"><div class="title">NodeStoreScheduler.h</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#ifndef XRPL_APP_MAIN_NODESTORESCHEDULER_H_INCLUDED</span></div>
|
|
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define XRPL_APP_MAIN_NODESTORESCHEDULER_H_INCLUDED</span></div>
|
|
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
|
|
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include <xrpl/core/JobQueue.h></span></div>
|
|
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include <xrpl/nodestore/Scheduler.h></span></div>
|
|
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
|
|
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacexrpl.html">xrpl</a> {</div>
|
|
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> </div>
|
|
<div class="foldopen" id="foldopen00010" data-start="{" data-end="};">
|
|
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"><a class="line" href="classxrpl_1_1NodeStoreScheduler.html"> 10</a></span><span class="keyword">class </span><a class="code hl_class" href="classxrpl_1_1NodeStoreScheduler.html">NodeStoreScheduler</a> : <span class="keyword">public</span> <a class="code hl_class" href="classxrpl_1_1NodeStore_1_1Scheduler.html">NodeStore::Scheduler</a></div>
|
|
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span>{</div>
|
|
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="keyword">public</span>:</div>
|
|
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> <span class="keyword">explicit</span> <a class="code hl_class" href="classxrpl_1_1NodeStoreScheduler.html">NodeStoreScheduler</a>(<a class="code hl_class" href="classxrpl_1_1JobQueue.html">JobQueue</a>& jobQueue);</div>
|
|
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> </div>
|
|
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> <span class="keywordtype">void</span></div>
|
|
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> <a class="code hl_function" href="classxrpl_1_1NodeStoreScheduler.html#a875b17ba4cbbeb44a61ca0647f3ca9fe">scheduleTask</a>(<a class="code hl_struct" href="structxrpl_1_1NodeStore_1_1Task.html">NodeStore::Task</a>& task) <span class="keyword">override</span>;</div>
|
|
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> <span class="keywordtype">void</span></div>
|
|
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> <a class="code hl_function" href="classxrpl_1_1NodeStoreScheduler.html#adf73e8e3aee9fb1237708782a27daa7d">onFetch</a>(<a class="code hl_struct" href="structxrpl_1_1NodeStore_1_1FetchReport.html">NodeStore::FetchReport</a> <span class="keyword">const</span>& report) <span class="keyword">override</span>;</div>
|
|
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> <span class="keywordtype">void</span></div>
|
|
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> <a class="code hl_function" href="classxrpl_1_1NodeStoreScheduler.html#a80d1f57b08cbacb0346b426fb2473d7c">onBatchWrite</a>(<a class="code hl_struct" href="structxrpl_1_1NodeStore_1_1BatchWriteReport.html">NodeStore::BatchWriteReport</a> <span class="keyword">const</span>& report) <span class="keyword">override</span>;</div>
|
|
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div>
|
|
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="keyword">private</span>:</div>
|
|
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"><a class="line" href="classxrpl_1_1NodeStoreScheduler.html#a1fdd6bc1315d459ae35ff30b5f0137e5"> 23</a></span> <a class="code hl_class" href="classxrpl_1_1JobQueue.html">JobQueue</a>& <a class="code hl_variable" href="classxrpl_1_1NodeStoreScheduler.html#a1fdd6bc1315d459ae35ff30b5f0137e5">jobQueue_</a>;</div>
|
|
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span>};</div>
|
|
</div>
|
|
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> </div>
|
|
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span>} <span class="comment">// namespace xrpl</span></div>
|
|
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div>
|
|
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor">#endif</span></div>
|
|
<div class="ttc" id="aclassxrpl_1_1JobQueue_html"><div class="ttname"><a href="classxrpl_1_1JobQueue.html">xrpl::JobQueue</a></div><div class="ttdoc">A pool of threads to perform work.</div><div class="ttdef"><b>Definition</b> <a href="JobQueue_8h_source.html#l00037">JobQueue.h:38</a></div></div>
|
|
<div class="ttc" id="aclassxrpl_1_1NodeStoreScheduler_html"><div class="ttname"><a href="classxrpl_1_1NodeStoreScheduler.html">xrpl::NodeStoreScheduler</a></div><div class="ttdoc">A NodeStore::Scheduler which uses the JobQueue.</div><div class="ttdef"><b>Definition</b> <a href="NodeStoreScheduler_8h_source.html#l00010">NodeStoreScheduler.h:11</a></div></div>
|
|
<div class="ttc" id="aclassxrpl_1_1NodeStoreScheduler_html_a1fdd6bc1315d459ae35ff30b5f0137e5"><div class="ttname"><a href="classxrpl_1_1NodeStoreScheduler.html#a1fdd6bc1315d459ae35ff30b5f0137e5">xrpl::NodeStoreScheduler::jobQueue_</a></div><div class="ttdeci">JobQueue & jobQueue_</div><div class="ttdef"><b>Definition</b> <a href="NodeStoreScheduler_8h_source.html#l00023">NodeStoreScheduler.h:23</a></div></div>
|
|
<div class="ttc" id="aclassxrpl_1_1NodeStoreScheduler_html_a80d1f57b08cbacb0346b426fb2473d7c"><div class="ttname"><a href="classxrpl_1_1NodeStoreScheduler.html#a80d1f57b08cbacb0346b426fb2473d7c">xrpl::NodeStoreScheduler::onBatchWrite</a></div><div class="ttdeci">void onBatchWrite(NodeStore::BatchWriteReport const &report) override</div><div class="ttdoc">Reports the completion of a batch write Allows the scheduler to monitor the node store's performance.</div><div class="ttdef"><b>Definition</b> <a href="NodeStoreScheduler_8cpp_source.html#l00039">NodeStoreScheduler.cpp:39</a></div></div>
|
|
<div class="ttc" id="aclassxrpl_1_1NodeStoreScheduler_html_a875b17ba4cbbeb44a61ca0647f3ca9fe"><div class="ttname"><a href="classxrpl_1_1NodeStoreScheduler.html#a875b17ba4cbbeb44a61ca0647f3ca9fe">xrpl::NodeStoreScheduler::scheduleTask</a></div><div class="ttdeci">void scheduleTask(NodeStore::Task &task) override</div><div class="ttdoc">Schedules a task.</div><div class="ttdef"><b>Definition</b> <a href="NodeStoreScheduler_8cpp_source.html#l00010">NodeStoreScheduler.cpp:10</a></div></div>
|
|
<div class="ttc" id="aclassxrpl_1_1NodeStoreScheduler_html_adf73e8e3aee9fb1237708782a27daa7d"><div class="ttname"><a href="classxrpl_1_1NodeStoreScheduler.html#adf73e8e3aee9fb1237708782a27daa7d">xrpl::NodeStoreScheduler::onFetch</a></div><div class="ttdeci">void onFetch(NodeStore::FetchReport const &report) override</div><div class="ttdoc">Reports completion of a fetch Allows the scheduler to monitor the node store's performance.</div><div class="ttdef"><b>Definition</b> <a href="NodeStoreScheduler_8cpp_source.html#l00026">NodeStoreScheduler.cpp:26</a></div></div>
|
|
<div class="ttc" id="aclassxrpl_1_1NodeStore_1_1Scheduler_html"><div class="ttname"><a href="classxrpl_1_1NodeStore_1_1Scheduler.html">xrpl::NodeStore::Scheduler</a></div><div class="ttdoc">Scheduling for asynchronous backend activity.</div><div class="ttdef"><b>Definition</b> <a href="include_2xrpl_2nodestore_2Scheduler_8h_source.html#l00042">include/xrpl/nodestore/Scheduler.h:43</a></div></div>
|
|
<div class="ttc" id="anamespacexrpl_html"><div class="ttname"><a href="namespacexrpl.html">xrpl</a></div><div class="ttdoc">Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.</div><div class="ttdef"><b>Definition</b> <a href="algorithm_8h_source.html#l00006">algorithm.h:6</a></div></div>
|
|
<div class="ttc" id="astructxrpl_1_1NodeStore_1_1BatchWriteReport_html"><div class="ttname"><a href="structxrpl_1_1NodeStore_1_1BatchWriteReport.html">xrpl::NodeStore::BatchWriteReport</a></div><div class="ttdoc">Contains information about a batch write operation.</div><div class="ttdef"><b>Definition</b> <a href="include_2xrpl_2nodestore_2Scheduler_8h_source.html#l00026">include/xrpl/nodestore/Scheduler.h:27</a></div></div>
|
|
<div class="ttc" id="astructxrpl_1_1NodeStore_1_1FetchReport_html"><div class="ttname"><a href="structxrpl_1_1NodeStore_1_1FetchReport.html">xrpl::NodeStore::FetchReport</a></div><div class="ttdoc">Contains information about a fetch operation.</div><div class="ttdef"><b>Definition</b> <a href="include_2xrpl_2nodestore_2Scheduler_8h_source.html#l00014">include/xrpl/nodestore/Scheduler.h:15</a></div></div>
|
|
<div class="ttc" id="astructxrpl_1_1NodeStore_1_1Task_html"><div class="ttname"><a href="structxrpl_1_1NodeStore_1_1Task.html">xrpl::NodeStore::Task</a></div><div class="ttdoc">Derived classes perform scheduled tasks.</div><div class="ttdef"><b>Definition</b> <a href="Task_8h_source.html#l00008">Task.h:9</a></div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
|
|
</small></address>
|
|
</body>
|
|
</html>
|