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/structripple_1_1Workers__test_1_1TestCallback.html
bthomee 33451fdc96 deploy: 1d42c4f6de
2025-11-04 00:36:48 -08:00

223 lines
12 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::Workers_test::TestCallback 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="classripple_1_1Workers__test.html">Workers_test</a></li><li class="navelem"><a class="el" href="structripple_1_1Workers__test_1_1TestCallback.html">TestCallback</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structripple_1_1Workers__test_1_1TestCallback-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::Workers_test::TestCallback Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for ripple::Workers_test::TestCallback:</div>
<div class="dyncontent">
<div class="center"><img src="structripple_1_1Workers__test_1_1TestCallback__inherit__graph.png" border="0" usemap="#aripple_1_1Workers__test_1_1TestCallback_inherit__map" alt="Inheritance graph"/></div>
<map name="aripple_1_1Workers__test_1_1TestCallback_inherit__map" id="aripple_1_1Workers__test_1_1TestCallback_inherit__map">
<area shape="rect" title=" " alt="" coords="21,79,172,119"/>
<area shape="rect" href="structripple_1_1Workers_1_1Callback.html" title="Called to perform tasks as needed." alt="" coords="5,5,188,31"/>
<area shape="poly" title=" " alt="" coords="99,44,99,79,94,79,94,44"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ripple::Workers_test::TestCallback:</div>
<div class="dyncontent">
<div class="center"><img src="structripple_1_1Workers__test_1_1TestCallback__coll__graph.png" border="0" usemap="#aripple_1_1Workers__test_1_1TestCallback_coll__map" alt="Collaboration graph"/></div>
<map name="aripple_1_1Workers__test_1_1TestCallback_coll__map" id="aripple_1_1Workers__test_1_1TestCallback_coll__map">
<area shape="rect" title=" " alt="" coords="223,93,373,133"/>
<area shape="rect" href="structripple_1_1Workers_1_1Callback.html" title="Called to perform tasks as needed." alt="" coords="5,5,188,31"/>
<area shape="poly" title=" " alt="" coords="135,34,259,91,256,96,133,39"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/thread/condition_variable.html" title=" " alt="" coords="213,5,383,31"/>
<area shape="poly" title=" " alt="" coords="301,44,301,93,295,93,295,44"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/thread/mutex.html" title=" " alt="" coords="408,5,500,31"/>
<area shape="poly" title=" " alt="" coords="425,40,331,95,328,91,422,35"/>
</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:a11b124034ba109c1320cc7b6b83d3bcb" id="r_a11b124034ba109c1320cc7b6b83d3bcb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1Workers__test_1_1TestCallback.html#a11b124034ba109c1320cc7b6b83d3bcb">processTask</a> (int instance) override</td></tr>
<tr class="memdesc:a11b124034ba109c1320cc7b6b83d3bcb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Perform a task. <br /></td></tr>
<tr class="separator:a11b124034ba109c1320cc7b6b83d3bcb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:aae623642bb3b4d081e97f1c386783a1b" id="r_aae623642bb3b4d081e97f1c386783a1b"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/thread/condition_variable.html">std::condition_variable</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1Workers__test_1_1TestCallback.html#aae623642bb3b4d081e97f1c386783a1b">cv</a></td></tr>
<tr class="separator:aae623642bb3b4d081e97f1c386783a1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abbc0372ac2c5c6de921a60887dbd3c05" id="r_abbc0372ac2c5c6de921a60887dbd3c05"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/thread/mutex.html">std::mutex</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1Workers__test_1_1TestCallback.html#abbc0372ac2c5c6de921a60887dbd3c05">mut</a></td></tr>
<tr class="separator:abbc0372ac2c5c6de921a60887dbd3c05"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aff109385128d25f79adb6622677698ea" id="r_aff109385128d25f79adb6622677698ea"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1Workers__test_1_1TestCallback.html#aff109385128d25f79adb6622677698ea">count</a> = 0</td></tr>
<tr class="separator:aff109385128d25f79adb6622677698ea"><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 class="definition">Definition at line <a class="el" href="Workers__test_8cpp_source.html#l00088">88</a> of file <a class="el" href="Workers__test_8cpp_source.html">Workers_test.cpp</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a11b124034ba109c1320cc7b6b83d3bcb" name="a11b124034ba109c1320cc7b6b83d3bcb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a11b124034ba109c1320cc7b6b83d3bcb">&#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">void ripple::Workers_test::TestCallback::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">override</span><span class="mlabel">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>Implements <a class="el" href="structripple_1_1Workers_1_1Callback.html#aaf9d435c1413c9a7ac8f662518e16312">ripple::Workers::Callback</a>.</p>
<p class="definition">Definition at line <a class="el" href="Workers__test_8cpp_source.html#l00091">91</a> of file <a class="el" href="Workers__test_8cpp_source.html">Workers_test.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="aae623642bb3b4d081e97f1c386783a1b" name="aae623642bb3b4d081e97f1c386783a1b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aae623642bb3b4d081e97f1c386783a1b">&#9670;&#160;</a></span>cv</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/thread/condition_variable.html">std::condition_variable</a> ripple::Workers_test::TestCallback::cv</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Workers__test_8cpp_source.html#l00098">98</a> of file <a class="el" href="Workers__test_8cpp_source.html">Workers_test.cpp</a>.</p>
</div>
</div>
<a id="abbc0372ac2c5c6de921a60887dbd3c05" name="abbc0372ac2c5c6de921a60887dbd3c05"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abbc0372ac2c5c6de921a60887dbd3c05">&#9670;&#160;</a></span>mut</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/thread/mutex.html">std::mutex</a> ripple::Workers_test::TestCallback::mut</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Workers__test_8cpp_source.html#l00099">99</a> of file <a class="el" href="Workers__test_8cpp_source.html">Workers_test.cpp</a>.</p>
</div>
</div>
<a id="aff109385128d25f79adb6622677698ea" name="aff109385128d25f79adb6622677698ea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aff109385128d25f79adb6622677698ea">&#9670;&#160;</a></span>count</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ripple::Workers_test::TestCallback::count = 0</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Workers__test_8cpp_source.html#l00100">100</a> of file <a class="el" href="Workers__test_8cpp_source.html">Workers_test.cpp</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