ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-12-06 17:27:55 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
e5d00ab2bf5a6fed840f2f17ebf7ba99974fe875
rippled/structripple_1_1Workers_1_1Callback.html
bthomee e61ca37029 deploy: eac3abdca9
2025-01-21 19:58:08 +00:00

265 lines
13 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.5"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: ripple::Workers::Callback 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.5 -->
<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="classripple_1_1Workers.html">Workers</a></li><li class="navelem"><a class="el" href="structripple_1_1Workers_1_1Callback.html">Callback</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_1Workers_1_1Callback-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::Workers::Callback Struct Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
</div><!--header-->
<div class="contents">
<p>Called to perform tasks as needed.
<a href="structripple_1_1Workers_1_1Callback.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="Workers_8h_source.html">Workers.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ripple::Workers::Callback:</div>
<div class="dyncontent">
<div class="center"><img src="structripple_1_1Workers_1_1Callback__inherit__graph.png" border="0" usemap="#aripple_1_1Workers_1_1Callback_inherit__map" alt="Inheritance graph"/></div>
<map name="aripple_1_1Workers_1_1Callback_inherit__map" id="aripple_1_1Workers_1_1Callback_inherit__map">
<area shape="rect" title="Called to perform tasks as needed." alt="" coords="60,5,243,31"/>
<area shape="rect" href="classripple_1_1JobQueue.html" title="A pool of threads to perform work." alt="" coords="5,86,135,111"/>
<area shape="rect" href="structripple_1_1Workers__test_1_1TestCallback.html" title=" " alt="" coords="159,79,309,119"/>
</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:a71388dd2ec03bdbae91be386b27a32e1"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1Workers_1_1Callback.html#a71388dd2ec03bdbae91be386b27a32e1">~Callback</a> ()=default</td></tr>
<tr class="separator:a71388dd2ec03bdbae91be386b27a32e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8ea5b61a0e9ec549c6aa6d6975b0a0ac"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1Workers_1_1Callback.html#a8ea5b61a0e9ec549c6aa6d6975b0a0ac">Callback</a> ()=default</td></tr>
<tr class="separator:a8ea5b61a0e9ec549c6aa6d6975b0a0ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae0c6ccaf33c99f8173485201eadbb385"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1Workers_1_1Callback.html#ae0c6ccaf33c99f8173485201eadbb385">Callback</a> (<a class="el" href="structripple_1_1Workers_1_1Callback.html">Callback</a> const &amp;)=delete</td></tr>
<tr class="separator:ae0c6ccaf33c99f8173485201eadbb385"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a93299f4dfa95dd3f00c329301bde7cfb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structripple_1_1Workers_1_1Callback.html">Callback</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1Workers_1_1Callback.html#a93299f4dfa95dd3f00c329301bde7cfb">operator=</a> (<a class="el" href="structripple_1_1Workers_1_1Callback.html">Callback</a> const &amp;)=delete</td></tr>
<tr class="separator:a93299f4dfa95dd3f00c329301bde7cfb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaf9d435c1413c9a7ac8f662518e16312"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1Workers_1_1Callback.html#aaf9d435c1413c9a7ac8f662518e16312">processTask</a> (int instance)=0</td></tr>
<tr class="memdesc:aaf9d435c1413c9a7ac8f662518e16312"><td class="mdescLeft">&#160;</td><td class="mdescRight">Perform a task. <a href="structripple_1_1Workers_1_1Callback.html#aaf9d435c1413c9a7ac8f662518e16312">More...</a><br /></td></tr>
<tr class="separator:aaf9d435c1413c9a7ac8f662518e16312"><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 >Called to perform tasks as needed. </p>
<p class="definition">Definition at line <a class="el" href="Workers_8h_source.html#l00083">83</a> of file <a class="el" href="Workers_8h_source.html">Workers.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a71388dd2ec03bdbae91be386b27a32e1" name="a71388dd2ec03bdbae91be386b27a32e1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a71388dd2ec03bdbae91be386b27a32e1">&#9670;&#160;</a></span>~Callback()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual ripple::Workers::Callback::~Callback </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>
<a id="a8ea5b61a0e9ec549c6aa6d6975b0a0ac" name="a8ea5b61a0e9ec549c6aa6d6975b0a0ac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8ea5b61a0e9ec549c6aa6d6975b0a0ac">&#9670;&#160;</a></span>Callback() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ripple::Workers::Callback::Callback </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ae0c6ccaf33c99f8173485201eadbb385" name="ae0c6ccaf33c99f8173485201eadbb385"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae0c6ccaf33c99f8173485201eadbb385">&#9670;&#160;</a></span>Callback() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ripple::Workers::Callback::Callback </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structripple_1_1Workers_1_1Callback.html">Callback</a> const &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a93299f4dfa95dd3f00c329301bde7cfb" name="a93299f4dfa95dd3f00c329301bde7cfb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a93299f4dfa95dd3f00c329301bde7cfb">&#9670;&#160;</a></span>operator=()</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_1Workers_1_1Callback.html">Callback</a> &amp; ripple::Workers::Callback::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structripple_1_1Workers_1_1Callback.html">Callback</a> const &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="aaf9d435c1413c9a7ac8f662518e16312" name="aaf9d435c1413c9a7ac8f662518e16312"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaf9d435c1413c9a7ac8f662518e16312">&#9670;&#160;</a></span>processTask()</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::Workers::Callback::processTask </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>instance</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>Perform a task. </p>
<p >The call is made on a thread owned by <a class="el" href="classripple_1_1Workers.html" title="Workers is effectively a thread pool.">Workers</a>. It is important that you only process one task from inside your callback. Each call to addTask will result in exactly one call to processTask.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">instance</td><td>The worker thread instance.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classripple_1_1Workers.html#aa65a05362bb7c77d7679cefce91a1514" title="Add a task to be performed.">Workers::addTask</a> </dd></dl>
<p>Implemented in <a class="el" href="structripple_1_1Workers__test_1_1TestCallback.html#a11b124034ba109c1320cc7b6b83d3bcb">ripple::Workers_test::TestCallback</a>, and <a class="el" href="classripple_1_1JobQueue.html#ace46ddb99e1da2748bc42a4243c5a187">ripple::JobQueue</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.5
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink