Files
rippled/classripple_1_1ConsensusTimer.html
2020-04-15 21:15:02 +00:00

280 lines
14 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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: ripple::ConsensusTimer 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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">rippled
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</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_1ConsensusTimer.html">ConsensusTimer</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-types">Private Types</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classripple_1_1ConsensusTimer-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ripple::ConsensusTimer Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Measures the duration of phases of consensus.
<a href="classripple_1_1ConsensusTimer.html#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for ripple::ConsensusTimer:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1ConsensusTimer__coll__graph.png" border="0" usemap="#ripple_1_1ConsensusTimer_coll__map" alt="Collaboration graph"/></div>
<map name="ripple_1_1ConsensusTimer_coll__map" id="ripple_1_1ConsensusTimer_coll__map">
<area shape="rect" title="Measures the duration of phases of consensus." alt="" coords="10,95,185,121"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/chrono/duration.html" title=" " alt="" coords="5,5,189,32"/>
</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 name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a3c6486c5da8f92bc3d05c0a45be4f0d8"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/duration.html">std::chrono::milliseconds</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ConsensusTimer.html#a3c6486c5da8f92bc3d05c0a45be4f0d8">read</a> () const</td></tr>
<tr class="separator:a3c6486c5da8f92bc3d05c0a45be4f0d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa1622d363e3b90aa2b36c772c1bc9b1f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ConsensusTimer.html#aa1622d363e3b90aa2b36c772c1bc9b1f">tick</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/duration.html">std::chrono::milliseconds</a> fixed)</td></tr>
<tr class="separator:aa1622d363e3b90aa2b36c772c1bc9b1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4ed4c7abd53a5919320beec03501dcc3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ConsensusTimer.html#a4ed4c7abd53a5919320beec03501dcc3">reset</a> (<a class="el" href="classripple_1_1ConsensusTimer.html#a84fc1bfda7bcaca6f33df2c8035e301e">time_point</a> tp)</td></tr>
<tr class="separator:a4ed4c7abd53a5919320beec03501dcc3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae7dd7a076b15810123615aa8718981d0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ConsensusTimer.html#ae7dd7a076b15810123615aa8718981d0">tick</a> (<a class="el" href="classripple_1_1ConsensusTimer.html#a84fc1bfda7bcaca6f33df2c8035e301e">time_point</a> tp)</td></tr>
<tr class="separator:ae7dd7a076b15810123615aa8718981d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-types"></a>
Private Types</h2></td></tr>
<tr class="memitem:a84fc1bfda7bcaca6f33df2c8035e301e"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ConsensusTimer.html#a84fc1bfda7bcaca6f33df2c8035e301e">time_point</a> = std::chrono::steady_clock::time_point</td></tr>
<tr class="separator:a84fc1bfda7bcaca6f33df2c8035e301e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a1b45e06eb52e00903e024c3711e4a868"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1ConsensusTimer.html#a84fc1bfda7bcaca6f33df2c8035e301e">time_point</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ConsensusTimer.html#a1b45e06eb52e00903e024c3711e4a868">start_</a></td></tr>
<tr class="separator:a1b45e06eb52e00903e024c3711e4a868"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a69a65edecf1cb8f15ba5040cf9bad19f"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/duration.html">std::chrono::milliseconds</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ConsensusTimer.html#a69a65edecf1cb8f15ba5040cf9bad19f">dur_</a></td></tr>
<tr class="separator:a69a65edecf1cb8f15ba5040cf9bad19f"><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>Measures the duration of phases of consensus. </p>
<p class="definition">Definition at line <a class="el" href="ConsensusTypes_8h_source.html#l00134">134</a> of file <a class="el" href="ConsensusTypes_8h_source.html">ConsensusTypes.h</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a84fc1bfda7bcaca6f33df2c8035e301e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a84fc1bfda7bcaca6f33df2c8035e301e">&#9670;&nbsp;</a></span>time_point</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classripple_1_1ConsensusTimer.html#a84fc1bfda7bcaca6f33df2c8035e301e">ripple::ConsensusTimer::time_point</a> = std::chrono::steady_clock::time_point</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="ConsensusTypes_8h_source.html#l00136">136</a> of file <a class="el" href="ConsensusTypes_8h_source.html">ConsensusTypes.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a3c6486c5da8f92bc3d05c0a45be4f0d8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3c6486c5da8f92bc3d05c0a45be4f0d8">&#9670;&nbsp;</a></span>read()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/duration.html">std::chrono::milliseconds</a> ripple::ConsensusTimer::read </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="ConsensusTypes_8h_source.html#l00142">142</a> of file <a class="el" href="ConsensusTypes_8h_source.html">ConsensusTypes.h</a>.</p>
</div>
</div>
<a id="aa1622d363e3b90aa2b36c772c1bc9b1f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa1622d363e3b90aa2b36c772c1bc9b1f">&#9670;&nbsp;</a></span>tick() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ripple::ConsensusTimer::tick </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/duration.html">std::chrono::milliseconds</a>&#160;</td>
<td class="paramname"><em>fixed</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="ConsensusTypes_8h_source.html#l00148">148</a> of file <a class="el" href="ConsensusTypes_8h_source.html">ConsensusTypes.h</a>.</p>
</div>
</div>
<a id="a4ed4c7abd53a5919320beec03501dcc3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4ed4c7abd53a5919320beec03501dcc3">&#9670;&nbsp;</a></span>reset()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ripple::ConsensusTimer::reset </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1ConsensusTimer.html#a84fc1bfda7bcaca6f33df2c8035e301e">time_point</a>&#160;</td>
<td class="paramname"><em>tp</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="ConsensusTypes_8h_source.html#l00154">154</a> of file <a class="el" href="ConsensusTypes_8h_source.html">ConsensusTypes.h</a>.</p>
</div>
</div>
<a id="ae7dd7a076b15810123615aa8718981d0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae7dd7a076b15810123615aa8718981d0">&#9670;&nbsp;</a></span>tick() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ripple::ConsensusTimer::tick </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1ConsensusTimer.html#a84fc1bfda7bcaca6f33df2c8035e301e">time_point</a>&#160;</td>
<td class="paramname"><em>tp</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="ConsensusTypes_8h_source.html#l00161">161</a> of file <a class="el" href="ConsensusTypes_8h_source.html">ConsensusTypes.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a1b45e06eb52e00903e024c3711e4a868"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1b45e06eb52e00903e024c3711e4a868">&#9670;&nbsp;</a></span>start_</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_1ConsensusTimer.html#a84fc1bfda7bcaca6f33df2c8035e301e">time_point</a> ripple::ConsensusTimer::start_</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="ConsensusTypes_8h_source.html#l00137">137</a> of file <a class="el" href="ConsensusTypes_8h_source.html">ConsensusTypes.h</a>.</p>
</div>
</div>
<a id="a69a65edecf1cb8f15ba5040cf9bad19f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a69a65edecf1cb8f15ba5040cf9bad19f">&#9670;&nbsp;</a></span>dur_</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/chrono/duration.html">std::chrono::milliseconds</a> ripple::ConsensusTimer::dur_</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="ConsensusTypes_8h_source.html#l00138">138</a> of file <a class="el" href="ConsensusTypes_8h_source.html">ConsensusTypes.h</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>