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

344 lines
19 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::test::csf::HeartbeatTimer 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_1test.html">test</a></li><li class="navelem"><a class="el" href="namespaceripple_1_1test_1_1csf.html">csf</a></li><li class="navelem"><a class="el" href="classripple_1_1test_1_1csf_1_1HeartbeatTimer.html">HeartbeatTimer</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classripple_1_1test_1_1csf_1_1HeartbeatTimer-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::test::csf::HeartbeatTimer Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Gives heartbeat of simulation to signal simulation progression.
<a href="classripple_1_1test_1_1csf_1_1HeartbeatTimer.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="timers_8h_source.html">timers.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for ripple::test::csf::HeartbeatTimer:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1test_1_1csf_1_1HeartbeatTimer__coll__graph.png" border="0" usemap="#aripple_1_1test_1_1csf_1_1HeartbeatTimer_coll__map" alt="Collaboration graph"/></div>
<map name="aripple_1_1test_1_1csf_1_1HeartbeatTimer_coll__map" id="aripple_1_1test_1_1csf_1_1HeartbeatTimer_coll__map">
<area shape="rect" title="Gives heartbeat of simulation to signal simulation progression." alt="" coords="901,111,1028,151"/>
<area shape="rect" href="classripple_1_1test_1_1csf_1_1Scheduler.html" title="Simulated discrete&#45;event scheduler." alt="" coords="652,77,779,117"/>
<area shape="poly" title=" " alt="" coords="793,105,901,120,901,125,792,110"/>
<area shape="rect" href="classripple_1_1test_1_1csf_1_1Scheduler_1_1queue__type.html" title=" " alt="" coords="381,5,552,45"/>
<area shape="poly" title=" " alt="" coords="550,47,652,77,651,82,549,52"/>
<area shape="rect" href="classbeast_1_1manual__clock.html" title=" " alt="" coords="386,70,547,125"/>
<area shape="poly" title=" " alt="" coords="561,95,652,95,652,100,561,100"/>
<area shape="rect" href="classbeast_1_1abstract__clock.html" title="Abstract interface to a clock." alt="" coords="167,77,327,117"/>
<area shape="poly" title=" " alt="" coords="341,95,386,95,386,100,341,100"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html" title=" " alt="" coords="663,146,767,171"/>
<area shape="poly" title=" " alt="" coords="781,155,877,147,901,143,902,148,878,152,781,160"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html" title=" " alt="" coords="394,149,539,189"/>
<area shape="poly" title=" " alt="" coords="553,163,663,158,663,164,554,168"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/io/basic_ios.html" title=" " alt="" coords="161,157,332,182"/>
<area shape="poly" title=" " alt="" coords="346,167,394,167,394,172,346,172"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/io/ios_base.html" title=" " alt="" coords="5,157,112,182"/>
<area shape="poly" title=" " alt="" coords="126,167,161,167,161,172,126,172"/>
</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:a04dcb8c9b31380151c58af4713d1de55" id="r_a04dcb8c9b31380151c58af4713d1de55"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1test_1_1csf_1_1HeartbeatTimer.html#a04dcb8c9b31380151c58af4713d1de55">HeartbeatTimer</a> (<a class="el" href="classripple_1_1test_1_1csf_1_1Scheduler.html">Scheduler</a> &amp;sched, <a class="el" href="namespaceripple_1_1test_1_1csf.html#a2cc5b9919f5be7d4d0dac98f48da80f2">SimDuration</a> interval=<a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/duration.html">std::chrono::seconds</a>{60}, <a class="elRef" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::ostream</a> &amp;<a class="el" href="namespaceripple.html#a7cc64e12723fbc9606d85442a2569fedac68271a63ddbc431c307beb7d2918275">out</a>=<a class="elRef" href="http://en.cppreference.com/w/cpp/io/cerr.html">std::cerr</a>)</td></tr>
<tr class="separator:a04dcb8c9b31380151c58af4713d1de55"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa60b1954bcf75edf39944048f4c5a4bc" id="r_aa60b1954bcf75edf39944048f4c5a4bc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1test_1_1csf_1_1HeartbeatTimer.html#aa60b1954bcf75edf39944048f4c5a4bc">start</a> ()</td></tr>
<tr class="separator:aa60b1954bcf75edf39944048f4c5a4bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af2202bfcbc8b97d609fdbf5d65f0e856" id="r_af2202bfcbc8b97d609fdbf5d65f0e856"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1test_1_1csf_1_1HeartbeatTimer.html#af2202bfcbc8b97d609fdbf5d65f0e856">beat</a> (<a class="el" href="namespaceripple_1_1test_1_1csf.html#a94af4815b9aaf71de676cd8377415473">SimTime</a> when)</td></tr>
<tr class="separator:af2202bfcbc8b97d609fdbf5d65f0e856"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a6c22041a47505f00aaaa5b7e5b1fa3a2" id="r_a6c22041a47505f00aaaa5b7e5b1fa3a2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1test_1_1csf_1_1Scheduler.html">Scheduler</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1test_1_1csf_1_1HeartbeatTimer.html#a6c22041a47505f00aaaa5b7e5b1fa3a2">scheduler_</a></td></tr>
<tr class="separator:a6c22041a47505f00aaaa5b7e5b1fa3a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5af1c0c2196c10542e512618d1860062" id="r_a5af1c0c2196c10542e512618d1860062"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple_1_1test_1_1csf.html#a2cc5b9919f5be7d4d0dac98f48da80f2">SimDuration</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1test_1_1csf_1_1HeartbeatTimer.html#a5af1c0c2196c10542e512618d1860062">interval_</a></td></tr>
<tr class="separator:a5af1c0c2196c10542e512618d1860062"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a93ed5fb873e7f4db4b9930489ba8043a" id="r_a93ed5fb873e7f4db4b9930489ba8043a"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::ostream</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1test_1_1csf_1_1HeartbeatTimer.html#a93ed5fb873e7f4db4b9930489ba8043a">out_</a></td></tr>
<tr class="separator:a93ed5fb873e7f4db4b9930489ba8043a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a690f8fbb9915011de9b736ddf710cf4b" id="r_a690f8fbb9915011de9b736ddf710cf4b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple_1_1test_1_1csf.html#a73f0454e06c632f7f1dca93e3adc97b8">RealTime</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1test_1_1csf_1_1HeartbeatTimer.html#a690f8fbb9915011de9b736ddf710cf4b">startRealTime_</a></td></tr>
<tr class="separator:a690f8fbb9915011de9b736ddf710cf4b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaf4351539f0c09bf7a8bddae00f08c06" id="r_aaf4351539f0c09bf7a8bddae00f08c06"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple_1_1test_1_1csf.html#a94af4815b9aaf71de676cd8377415473">SimTime</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1test_1_1csf_1_1HeartbeatTimer.html#aaf4351539f0c09bf7a8bddae00f08c06">startSimTime_</a></td></tr>
<tr class="separator:aaf4351539f0c09bf7a8bddae00f08c06"><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>Gives heartbeat of simulation to signal simulation progression. </p>
<p class="definition">Definition at line <a class="el" href="timers_8h_source.html#l00019">19</a> of file <a class="el" href="timers_8h_source.html">timers.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a04dcb8c9b31380151c58af4713d1de55" name="a04dcb8c9b31380151c58af4713d1de55"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a04dcb8c9b31380151c58af4713d1de55">&#9670;&#160;</a></span>HeartbeatTimer()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ripple::test::csf::HeartbeatTimer::HeartbeatTimer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1test_1_1csf_1_1Scheduler.html">Scheduler</a> &amp;&#160;</td>
<td class="paramname"><em>sched</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceripple_1_1test_1_1csf.html#a2cc5b9919f5be7d4d0dac98f48da80f2">SimDuration</a>&#160;</td>
<td class="paramname"><em>interval</em> = <code><a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/duration.html">std::chrono::seconds</a>{60}</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::ostream</a> &amp;&#160;</td>
<td class="paramname"><em>out</em> = <code><a class="elRef" href="http://en.cppreference.com/w/cpp/io/cerr.html">std::cerr</a></code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="timers_8h_source.html#l00029">29</a> of file <a class="el" href="timers_8h_source.html">timers.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aa60b1954bcf75edf39944048f4c5a4bc" name="aa60b1954bcf75edf39944048f4c5a4bc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa60b1954bcf75edf39944048f4c5a4bc">&#9670;&#160;</a></span>start()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ripple::test::csf::HeartbeatTimer::start </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="timers_8h_source.html#l00042">42</a> of file <a class="el" href="timers_8h_source.html">timers.h</a>.</p>
</div>
</div>
<a id="af2202bfcbc8b97d609fdbf5d65f0e856" name="af2202bfcbc8b97d609fdbf5d65f0e856"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af2202bfcbc8b97d609fdbf5d65f0e856">&#9670;&#160;</a></span>beat()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ripple::test::csf::HeartbeatTimer::beat </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceripple_1_1test_1_1csf.html#a94af4815b9aaf71de676cd8377415473">SimTime</a>&#160;</td>
<td class="paramname"><em>when</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="timers_8h_source.html#l00048">48</a> of file <a class="el" href="timers_8h_source.html">timers.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a6c22041a47505f00aaaa5b7e5b1fa3a2" name="a6c22041a47505f00aaaa5b7e5b1fa3a2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6c22041a47505f00aaaa5b7e5b1fa3a2">&#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"><a class="el" href="classripple_1_1test_1_1csf_1_1Scheduler.html">Scheduler</a>&amp; ripple::test::csf::HeartbeatTimer::scheduler_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="timers_8h_source.html#l00021">21</a> of file <a class="el" href="timers_8h_source.html">timers.h</a>.</p>
</div>
</div>
<a id="a5af1c0c2196c10542e512618d1860062" name="a5af1c0c2196c10542e512618d1860062"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5af1c0c2196c10542e512618d1860062">&#9670;&#160;</a></span>interval_</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="namespaceripple_1_1test_1_1csf.html#a2cc5b9919f5be7d4d0dac98f48da80f2">SimDuration</a> ripple::test::csf::HeartbeatTimer::interval_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="timers_8h_source.html#l00022">22</a> of file <a class="el" href="timers_8h_source.html">timers.h</a>.</p>
</div>
</div>
<a id="a93ed5fb873e7f4db4b9930489ba8043a" name="a93ed5fb873e7f4db4b9930489ba8043a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a93ed5fb873e7f4db4b9930489ba8043a">&#9670;&#160;</a></span>out_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::ostream</a>&amp; ripple::test::csf::HeartbeatTimer::out_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="timers_8h_source.html#l00023">23</a> of file <a class="el" href="timers_8h_source.html">timers.h</a>.</p>
</div>
</div>
<a id="a690f8fbb9915011de9b736ddf710cf4b" name="a690f8fbb9915011de9b736ddf710cf4b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a690f8fbb9915011de9b736ddf710cf4b">&#9670;&#160;</a></span>startRealTime_</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="namespaceripple_1_1test_1_1csf.html#a73f0454e06c632f7f1dca93e3adc97b8">RealTime</a> ripple::test::csf::HeartbeatTimer::startRealTime_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="timers_8h_source.html#l00025">25</a> of file <a class="el" href="timers_8h_source.html">timers.h</a>.</p>
</div>
</div>
<a id="aaf4351539f0c09bf7a8bddae00f08c06" name="aaf4351539f0c09bf7a8bddae00f08c06"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaf4351539f0c09bf7a8bddae00f08c06">&#9670;&#160;</a></span>startSimTime_</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="namespaceripple_1_1test_1_1csf.html#a94af4815b9aaf71de676cd8377415473">SimTime</a> ripple::test::csf::HeartbeatTimer::startSimTime_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="timers_8h_source.html#l00026">26</a> of file <a class="el" href="timers_8h_source.html">timers.h</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