ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-21 19:45:53 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
7e8d836c5282db826188d0baae826543abe38ae0
rippled/NodeStoreScheduler_8h_source.html
bthomee 7e8d836c52 deploy: 8eb233c2ea
2025-10-31 15:28:26 -07:00

151 lines
16 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" 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&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_a62226f9e3a6c7c5a3be455e2f87ae01.html">xrpld</a></li><li class="navelem"><a class="el" href="dir_c69db3203fa08a9ff994909ba6ee9783.html">app</a></li><li class="navelem"><a class="el" href="dir_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="comment">//------------------------------------------------------------------------------</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">/*</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> This file is part of rippled: https://github.com/ripple/rippled</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> Copyright (c) 2012, 2013 Ripple Labs Inc.</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"></span> </div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> Permission to use, copy, modify, and/or distribute this software for any</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> purpose with or without fee is hereby granted, provided that the above</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> copyright notice and this permission notice appear in all copies.</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"></span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> THE SOFTWARE IS PROVIDED &quot;AS IS&quot; AND THE AUTHOR DISCLAIMS ALL WARRANTIES</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment">*/</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment">//==============================================================================</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#ifndef RIPPLE_APP_MAIN_NODESTORESCHEDULER_H_INCLUDED</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#define RIPPLE_APP_MAIN_NODESTORESCHEDULER_H_INCLUDED</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor">#include &lt;xrpld/core/JobQueue.h&gt;</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#include &lt;xrpl/nodestore/Scheduler.h&gt;</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> </div>
<div class="foldopen" id="foldopen00030" data-start="{" data-end="};">
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"><a class="line" href="classripple_1_1NodeStoreScheduler.html"> 30</a></span><span class="keyword">class </span><a class="code hl_class" href="classripple_1_1NodeStoreScheduler.html">NodeStoreScheduler</a> : <span class="keyword">public</span> <a class="code hl_class" href="classripple_1_1NodeStore_1_1Scheduler.html">NodeStore::Scheduler</a></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span>{</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">explicit</span> <a class="code hl_class" href="classripple_1_1NodeStoreScheduler.html">NodeStoreScheduler</a>(<a class="code hl_class" href="classripple_1_1JobQueue.html">JobQueue</a>&amp; jobQueue);</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> </div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> <span class="keywordtype">void</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> <a class="code hl_function" href="classripple_1_1NodeStoreScheduler.html#a0b1c3260477e401b7e57493b0aaf9a3a">scheduleTask</a>(<a class="code hl_struct" href="structripple_1_1NodeStore_1_1Task.html">NodeStore::Task</a>&amp; task) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <span class="keywordtype">void</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> <a class="code hl_function" href="classripple_1_1NodeStoreScheduler.html#a042848ff97f97cff8a602ffec6b9f807">onFetch</a>(<a class="code hl_struct" href="structripple_1_1NodeStore_1_1FetchReport.html">NodeStore::FetchReport</a> <span class="keyword">const</span>&amp; report) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> <span class="keywordtype">void</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <a class="code hl_function" href="classripple_1_1NodeStoreScheduler.html#a0b9464b915021b488e3d2e22b840a62f">onBatchWrite</a>(<a class="code hl_struct" href="structripple_1_1NodeStore_1_1BatchWriteReport.html">NodeStore::BatchWriteReport</a> <span class="keyword">const</span>&amp; report) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> </div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"><a class="line" href="classripple_1_1NodeStoreScheduler.html#aa0fbc996243ce5b4d1b5eb2a2cabc2fa"> 43</a></span> <a class="code hl_class" href="classripple_1_1JobQueue.html">JobQueue</a>&amp; <a class="code hl_variable" href="classripple_1_1NodeStoreScheduler.html#aa0fbc996243ce5b4d1b5eb2a2cabc2fa">jobQueue_</a>;</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span>};</div>
</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> </div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span>} <span class="comment">// namespace ripple</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> </div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclassripple_1_1JobQueue_html"><div class="ttname"><a href="classripple_1_1JobQueue.html">ripple::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#l00057">JobQueue.h:58</a></div></div>
<div class="ttc" id="aclassripple_1_1NodeStoreScheduler_html"><div class="ttname"><a href="classripple_1_1NodeStoreScheduler.html">ripple::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#l00030">NodeStoreScheduler.h:31</a></div></div>
<div class="ttc" id="aclassripple_1_1NodeStoreScheduler_html_a042848ff97f97cff8a602ffec6b9f807"><div class="ttname"><a href="classripple_1_1NodeStoreScheduler.html#a042848ff97f97cff8a602ffec6b9f807">ripple::NodeStoreScheduler::onFetch</a></div><div class="ttdeci">void onFetch(NodeStore::FetchReport const &amp;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#l00045">NodeStoreScheduler.cpp:45</a></div></div>
<div class="ttc" id="aclassripple_1_1NodeStoreScheduler_html_a0b1c3260477e401b7e57493b0aaf9a3a"><div class="ttname"><a href="classripple_1_1NodeStoreScheduler.html#a0b1c3260477e401b7e57493b0aaf9a3a">ripple::NodeStoreScheduler::scheduleTask</a></div><div class="ttdeci">void scheduleTask(NodeStore::Task &amp;task) override</div><div class="ttdoc">Schedules a task.</div><div class="ttdef"><b>Definition</b> <a href="NodeStoreScheduler_8cpp_source.html#l00029">NodeStoreScheduler.cpp:29</a></div></div>
<div class="ttc" id="aclassripple_1_1NodeStoreScheduler_html_a0b9464b915021b488e3d2e22b840a62f"><div class="ttname"><a href="classripple_1_1NodeStoreScheduler.html#a0b9464b915021b488e3d2e22b840a62f">ripple::NodeStoreScheduler::onBatchWrite</a></div><div class="ttdeci">void onBatchWrite(NodeStore::BatchWriteReport const &amp;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#l00058">NodeStoreScheduler.cpp:58</a></div></div>
<div class="ttc" id="aclassripple_1_1NodeStoreScheduler_html_aa0fbc996243ce5b4d1b5eb2a2cabc2fa"><div class="ttname"><a href="classripple_1_1NodeStoreScheduler.html#aa0fbc996243ce5b4d1b5eb2a2cabc2fa">ripple::NodeStoreScheduler::jobQueue_</a></div><div class="ttdeci">JobQueue &amp; jobQueue_</div><div class="ttdef"><b>Definition</b> <a href="NodeStoreScheduler_8h_source.html#l00043">NodeStoreScheduler.h:43</a></div></div>
<div class="ttc" id="aclassripple_1_1NodeStore_1_1Scheduler_html"><div class="ttname"><a href="classripple_1_1NodeStore_1_1Scheduler.html">ripple::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#l00061">include/xrpl/nodestore/Scheduler.h:62</a></div></div>
<div class="ttc" id="anamespaceripple_html"><div class="ttname"><a href="namespaceripple.html">ripple</a></div><div class="ttdoc">Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.</div><div class="ttdef"><b>Definition</b> <a href="algorithm_8h_source.html#l00025">algorithm.h:25</a></div></div>
<div class="ttc" id="astructripple_1_1NodeStore_1_1BatchWriteReport_html"><div class="ttname"><a href="structripple_1_1NodeStore_1_1BatchWriteReport.html">ripple::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#l00045">include/xrpl/nodestore/Scheduler.h:46</a></div></div>
<div class="ttc" id="astructripple_1_1NodeStore_1_1FetchReport_html"><div class="ttname"><a href="structripple_1_1NodeStore_1_1FetchReport.html">ripple::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#l00033">include/xrpl/nodestore/Scheduler.h:34</a></div></div>
<div class="ttc" id="astructripple_1_1NodeStore_1_1Task_html"><div class="ttname"><a href="structripple_1_1NodeStore_1_1Task.html">ripple::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#l00027">Task.h:28</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink