Files
rippled/structripple_1_1NodeStore_1_1Task.html
2025-11-04 00:36:48 -08:00

174 lines
7.8 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: ripple::NodeStore::Task Struct 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="structripple_1_1NodeStore_1_1Task.html">Task</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="structripple_1_1NodeStore_1_1Task-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::NodeStore::Task Struct Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
</div><!--header-->
<div class="contents">
<p>Derived classes perform scheduled tasks.
<a href="structripple_1_1NodeStore_1_1Task.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="Task_8h_source.html">Task.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ripple::NodeStore::Task:</div>
<div class="dyncontent">
<div class="center"><img src="structripple_1_1NodeStore_1_1Task__inherit__graph.png" border="0" usemap="#aripple_1_1NodeStore_1_1Task_inherit__map" alt="Inheritance graph"/></div>
<map name="aripple_1_1NodeStore_1_1Task_inherit__map" id="aripple_1_1NodeStore_1_1Task_inherit__map">
<area shape="rect" title="Derived classes perform scheduled tasks." alt="" coords="5,5,177,31"/>
<area shape="rect" href="classripple_1_1NodeStore_1_1BatchWriter.html" title="Batch&#45;writing assist logic." alt="" coords="20,79,163,119"/>
<area shape="poly" title=" " alt="" coords="94,44,94,79,89,79,89,44"/>
</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:ab19643df31f79516d1b06f5cc1d4a359" id="r_ab19643df31f79516d1b06f5cc1d4a359"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1NodeStore_1_1Task.html#ab19643df31f79516d1b06f5cc1d4a359">~Task</a> ()=default</td></tr>
<tr class="separator:ab19643df31f79516d1b06f5cc1d4a359"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1ed44e570fe3bd98407aae13a554ec2b" id="r_a1ed44e570fe3bd98407aae13a554ec2b"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1NodeStore_1_1Task.html#a1ed44e570fe3bd98407aae13a554ec2b">performScheduledTask</a> ()=0</td></tr>
<tr class="memdesc:a1ed44e570fe3bd98407aae13a554ec2b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Performs the task. <br /></td></tr>
<tr class="separator:a1ed44e570fe3bd98407aae13a554ec2b"><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>Derived classes perform scheduled tasks. </p>
<p class="definition">Definition at line <a class="el" href="Task_8h_source.html#l00008">8</a> of file <a class="el" href="Task_8h_source.html">Task.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ab19643df31f79516d1b06f5cc1d4a359" name="ab19643df31f79516d1b06f5cc1d4a359"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab19643df31f79516d1b06f5cc1d4a359">&#9670;&#160;</a></span>~Task()</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::Task::~Task </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="a1ed44e570fe3bd98407aae13a554ec2b" name="a1ed44e570fe3bd98407aae13a554ec2b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1ed44e570fe3bd98407aae13a554ec2b">&#9670;&#160;</a></span>performScheduledTask()</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::Task::performScheduledTask </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Performs the task. </p>
<p>The call may take place on a foreign thread. </p>
<p>Implemented in <a class="el" href="classripple_1_1NodeStore_1_1BatchWriter.html#aafd94fab31d667c79c53ae2f5b770778">ripple::NodeStore::BatchWriter</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>