ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-20 02:55:50 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
rippled/classripple_1_1NodeStore_1_1Scheduler.html
bthomee 33451fdc96 deploy: 1d42c4f6de
2025-11-04 00:36:48 -08:00

245 lines
13 KiB
HTML
Raw Permalink 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: ripple::NodeStore::Scheduler Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">rippled
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceripple.html">ripple</a></li><li class="navelem"><a class="el" href="namespaceripple_1_1NodeStore.html">NodeStore</a></li><li class="navelem"><a class="el" href="classripple_1_1NodeStore_1_1Scheduler.html">Scheduler</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classripple_1_1NodeStore_1_1Scheduler-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::NodeStore::Scheduler Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
</div><!--header-->
<div class="contents">
<p>Scheduling for asynchronous backend activity.
<a href="classripple_1_1NodeStore_1_1Scheduler.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="include_2xrpl_2nodestore_2Scheduler_8h_source.html">Scheduler.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ripple::NodeStore::Scheduler:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1NodeStore_1_1Scheduler__inherit__graph.png" border="0" usemap="#aripple_1_1NodeStore_1_1Scheduler_inherit__map" alt="Inheritance graph"/></div>
<map name="aripple_1_1NodeStore_1_1Scheduler_inherit__map" id="aripple_1_1NodeStore_1_1Scheduler_inherit__map">
<area shape="rect" title="Scheduling for asynchronous backend activity." alt="" coords="103,5,245,45"/>
<area shape="rect" href="classripple_1_1NodeStore_1_1DummyScheduler.html" title="Simple NodeStore Scheduler that just peforms the tasks synchronously." alt="" coords="5,93,148,133"/>
<area shape="poly" title=" " alt="" coords="144,56,100,95,96,91,141,52"/>
<area shape="rect" href="classripple_1_1NodeStoreScheduler.html" title="A NodeStore::Scheduler which uses the JobQueue." alt="" coords="172,101,371,126"/>
<area shape="poly" title=" " alt="" coords="208,53,260,98,256,102,204,57"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a623cbe27a726b27e9ea57fca6149e72a" id="r_a623cbe27a726b27e9ea57fca6149e72a"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1Scheduler.html#a623cbe27a726b27e9ea57fca6149e72a">~Scheduler</a> ()=default</td></tr>
<tr class="separator:a623cbe27a726b27e9ea57fca6149e72a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af3734617d65f9903e3b33d3ee6de8102" id="r_af3734617d65f9903e3b33d3ee6de8102"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1Scheduler.html#af3734617d65f9903e3b33d3ee6de8102">scheduleTask</a> (<a class="el" href="structripple_1_1NodeStore_1_1Task.html">Task</a> &amp;task)=0</td></tr>
<tr class="memdesc:af3734617d65f9903e3b33d3ee6de8102"><td class="mdescLeft">&#160;</td><td class="mdescRight">Schedules a task. <br /></td></tr>
<tr class="separator:af3734617d65f9903e3b33d3ee6de8102"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acf9a08ef64dd95c98da3e095ee919171" id="r_acf9a08ef64dd95c98da3e095ee919171"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1Scheduler.html#acf9a08ef64dd95c98da3e095ee919171">onFetch</a> (<a class="el" href="structripple_1_1NodeStore_1_1FetchReport.html">FetchReport</a> const &amp;report)=0</td></tr>
<tr class="memdesc:acf9a08ef64dd95c98da3e095ee919171"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reports completion of a fetch Allows the scheduler to monitor the node store's performance. <br /></td></tr>
<tr class="separator:acf9a08ef64dd95c98da3e095ee919171"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0adffe6c4e42f062bd47864f4e615a39" id="r_a0adffe6c4e42f062bd47864f4e615a39"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1NodeStore_1_1Scheduler.html#a0adffe6c4e42f062bd47864f4e615a39">onBatchWrite</a> (<a class="el" href="structripple_1_1NodeStore_1_1BatchWriteReport.html">BatchWriteReport</a> const &amp;report)=0</td></tr>
<tr class="memdesc:a0adffe6c4e42f062bd47864f4e615a39"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reports the completion of a batch write Allows the scheduler to monitor the node store's performance. <br /></td></tr>
<tr class="separator:a0adffe6c4e42f062bd47864f4e615a39"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Scheduling for asynchronous backend activity. </p>
<p>For improved performance, a backend has the option of performing writes in batches. These writes can be scheduled using the provided scheduler object.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classripple_1_1NodeStore_1_1BatchWriter.html" title="Batch-writing assist logic.">BatchWriter</a> </dd></dl>
<p class="definition">Definition at line <a class="el" href="include_2xrpl_2nodestore_2Scheduler_8h_source.html#l00042">42</a> of file <a class="el" href="include_2xrpl_2nodestore_2Scheduler_8h_source.html">include/xrpl/nodestore/Scheduler.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a623cbe27a726b27e9ea57fca6149e72a" name="a623cbe27a726b27e9ea57fca6149e72a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a623cbe27a726b27e9ea57fca6149e72a">&#9670;&#160;</a></span>~Scheduler()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual ripple::NodeStore::Scheduler::~Scheduler </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="af3734617d65f9903e3b33d3ee6de8102" name="af3734617d65f9903e3b33d3ee6de8102"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af3734617d65f9903e3b33d3ee6de8102">&#9670;&#160;</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">virtual void ripple::NodeStore::Scheduler::scheduleTask </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structripple_1_1NodeStore_1_1Task.html">Task</a> &amp;&#160;</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">pure 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>Implemented in <a class="el" href="classripple_1_1NodeStoreScheduler.html#a0b1c3260477e401b7e57493b0aaf9a3a">ripple::NodeStoreScheduler</a>, and <a class="el" href="classripple_1_1NodeStore_1_1DummyScheduler.html#a2a287126593234b18b86ff8bdd10708b">ripple::NodeStore::DummyScheduler</a>.</p>
</div>
</div>
<a id="acf9a08ef64dd95c98da3e095ee919171" name="acf9a08ef64dd95c98da3e095ee919171"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acf9a08ef64dd95c98da3e095ee919171">&#9670;&#160;</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">virtual void ripple::NodeStore::Scheduler::onFetch </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structripple_1_1NodeStore_1_1FetchReport.html">FetchReport</a> const &amp;&#160;</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">pure 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>Implemented in <a class="el" href="classripple_1_1NodeStore_1_1DummyScheduler.html#a77c0eec0a3c23752082f34bcd81019e2">ripple::NodeStore::DummyScheduler</a>, and <a class="el" href="classripple_1_1NodeStoreScheduler.html#a042848ff97f97cff8a602ffec6b9f807">ripple::NodeStoreScheduler</a>.</p>
</div>
</div>
<a id="a0adffe6c4e42f062bd47864f4e615a39" name="a0adffe6c4e42f062bd47864f4e615a39"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0adffe6c4e42f062bd47864f4e615a39">&#9670;&#160;</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">virtual void ripple::NodeStore::Scheduler::onBatchWrite </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structripple_1_1NodeStore_1_1BatchWriteReport.html">BatchWriteReport</a> const &amp;&#160;</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">pure 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>Implemented in <a class="el" href="classripple_1_1NodeStore_1_1DummyScheduler.html#ad8b696b6cd74015ecc865a6087a87878">ripple::NodeStore::DummyScheduler</a>, and <a class="el" href="classripple_1_1NodeStoreScheduler.html#a0b9464b915021b488e3d2e22b840a62f">ripple::NodeStoreScheduler</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink