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

389 lines
21 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: beast::abstract_clock&lt; Clock &gt; Class Template 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="namespacebeast.html">beast</a></li><li class="navelem"><a class="el" href="classbeast_1_1abstract__clock.html">abstract_clock</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="classbeast_1_1abstract__clock-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">beast::abstract_clock&lt; Clock &gt; Class Template Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Abstract interface to a clock.
<a href="classbeast_1_1abstract__clock.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for beast::abstract_clock&lt; Clock &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="classbeast_1_1abstract__clock__inherit__graph.png" border="0" usemap="#beast_1_1abstract__clock_3_01Clock_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="beast_1_1abstract__clock_3_01Clock_01_4_inherit__map" id="beast_1_1abstract__clock_3_01Clock_01_4_inherit__map">
<area shape="rect" title="Abstract interface to a clock." alt="" coords="5,5,165,47"/>
<area shape="rect" href="classbeast_1_1manual__clock.html" title="Manual clock implementation." alt="" coords="7,95,163,136"/>
</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-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a4435fdfcd47c4f67bbb21940e5505208"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1abstract__clock.html#a4435fdfcd47c4f67bbb21940e5505208">rep</a> = typename Clock::rep</td></tr>
<tr class="separator:a4435fdfcd47c4f67bbb21940e5505208"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abba11dabb096d89ff62699b64efb472e"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1abstract__clock.html#abba11dabb096d89ff62699b64efb472e">period</a> = typename Clock::period</td></tr>
<tr class="separator:abba11dabb096d89ff62699b64efb472e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad024b15fa67696e8d1eba3744e800d32"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1abstract__clock.html#ad024b15fa67696e8d1eba3744e800d32">duration</a> = typename Clock::duration</td></tr>
<tr class="separator:ad024b15fa67696e8d1eba3744e800d32"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4e16832b0bdf9392c5138bbbde024d8e"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1abstract__clock.html#a4e16832b0bdf9392c5138bbbde024d8e">time_point</a> = typename Clock::time_point</td></tr>
<tr class="separator:a4e16832b0bdf9392c5138bbbde024d8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab2db1e4273a58b6431b330e3c5ebd07f"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1abstract__clock.html#ab2db1e4273a58b6431b330e3c5ebd07f">clock_type</a> = Clock</td></tr>
<tr class="separator:ab2db1e4273a58b6431b330e3c5ebd07f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:aaa505cdf3c83a46f6c2e5727ca5878dd"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1abstract__clock.html#aaa505cdf3c83a46f6c2e5727ca5878dd">~abstract_clock</a> ()=default</td></tr>
<tr class="separator:aaa505cdf3c83a46f6c2e5727ca5878dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afa9ffe22af13542f15b7098db8950c78"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1abstract__clock.html#afa9ffe22af13542f15b7098db8950c78">abstract_clock</a> ()=default</td></tr>
<tr class="separator:afa9ffe22af13542f15b7098db8950c78"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aea4770a0091ddb7526d82aeac5796f88"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1abstract__clock.html#aea4770a0091ddb7526d82aeac5796f88">abstract_clock</a> (<a class="el" href="classbeast_1_1abstract__clock.html">abstract_clock</a> const &amp;)=default</td></tr>
<tr class="separator:aea4770a0091ddb7526d82aeac5796f88"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac9a577663353bfea66a096f12cb85293"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classbeast_1_1abstract__clock.html#a4e16832b0bdf9392c5138bbbde024d8e">time_point</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1abstract__clock.html#ac9a577663353bfea66a096f12cb85293">now</a> () const =0</td></tr>
<tr class="memdesc:ac9a577663353bfea66a096f12cb85293"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the current time. <a href="classbeast_1_1abstract__clock.html#ac9a577663353bfea66a096f12cb85293">More...</a><br /></td></tr>
<tr class="separator:ac9a577663353bfea66a096f12cb85293"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:ad919604810f750a57e777e9985d742af"><td class="memItemLeft" align="right" valign="top">static const bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1abstract__clock.html#ad919604810f750a57e777e9985d742af">is_steady</a> = Clock::is_steady</td></tr>
<tr class="separator:ad919604810f750a57e777e9985d742af"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;class Clock&gt;<br />
class beast::abstract_clock&lt; Clock &gt;</h3>
<p>Abstract interface to a clock. </p>
<p>This makes <a class="el" href="classbeast_1_1abstract__clock.html#ac9a577663353bfea66a096f12cb85293" title="Returns the current time.">now()</a> a member function instead of a static member, so an instance of the class can be dependency injected, facilitating unit tests where time may be controlled.</p>
<p>An <a class="el" href="classbeast_1_1abstract__clock.html" title="Abstract interface to a clock.">abstract_clock</a> inherits all the nested types of the Clock template parameter.</p>
<p>Example:</p>
<div class="fragment"><div class="line"><span class="keyword">struct </span>Implementation</div>
<div class="line">{</div>
<div class="line"> <span class="keyword">using</span> <a class="code" href="classbeast_1_1abstract__clock.html#ab2db1e4273a58b6431b330e3c5ebd07f">clock_type</a> = abstract_clock &lt;std::chrono::steady_clock&gt;;</div>
<div class="line"> <a class="code" href="classbeast_1_1abstract__clock.html#ab2db1e4273a58b6431b330e3c5ebd07f">clock_type</a>&amp; clock_;</div>
<div class="line"> <span class="keyword">explicit</span> Implementation (<a class="code" href="classbeast_1_1abstract__clock.html#ab2db1e4273a58b6431b330e3c5ebd07f">clock_type</a>&amp; clock)</div>
<div class="line"> : clock_(<a class="codeRef" href="http://en.cppreference.com/w/cpp/chrono/c/clock.html">clock</a>)</div>
<div class="line"> {</div>
<div class="line"> }</div>
<div class="line">};</div>
</div><!-- fragment --><dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Clock</td><td>A type meeting these requirements: <a href="http://en.cppreference.com/w/cpp/concept/Clock">http://en.cppreference.com/w/cpp/concept/Clock</a> </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="abstract__clock_8h_source.html#l00057">57</a> of file <a class="el" href="abstract__clock_8h_source.html">abstract_clock.h</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a4435fdfcd47c4f67bbb21940e5505208"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4435fdfcd47c4f67bbb21940e5505208">&#9670;&nbsp;</a></span>rep</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Clock &gt; </div>
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classbeast_1_1abstract__clock.html">beast::abstract_clock</a>&lt; Clock &gt;::<a class="el" href="classbeast_1_1abstract__clock.html#a4435fdfcd47c4f67bbb21940e5505208">rep</a> = typename Clock::rep</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="abstract__clock_8h_source.html#l00060">60</a> of file <a class="el" href="abstract__clock_8h_source.html">abstract_clock.h</a>.</p>
</div>
</div>
<a id="abba11dabb096d89ff62699b64efb472e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abba11dabb096d89ff62699b64efb472e">&#9670;&nbsp;</a></span>period</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Clock &gt; </div>
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classbeast_1_1abstract__clock.html">beast::abstract_clock</a>&lt; Clock &gt;::<a class="el" href="classbeast_1_1abstract__clock.html#abba11dabb096d89ff62699b64efb472e">period</a> = typename Clock::period</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="abstract__clock_8h_source.html#l00061">61</a> of file <a class="el" href="abstract__clock_8h_source.html">abstract_clock.h</a>.</p>
</div>
</div>
<a id="ad024b15fa67696e8d1eba3744e800d32"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad024b15fa67696e8d1eba3744e800d32">&#9670;&nbsp;</a></span>duration</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Clock &gt; </div>
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classbeast_1_1abstract__clock.html">beast::abstract_clock</a>&lt; Clock &gt;::<a class="el" href="classbeast_1_1abstract__clock.html#ad024b15fa67696e8d1eba3744e800d32">duration</a> = typename Clock::duration</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="abstract__clock_8h_source.html#l00062">62</a> of file <a class="el" href="abstract__clock_8h_source.html">abstract_clock.h</a>.</p>
</div>
</div>
<a id="a4e16832b0bdf9392c5138bbbde024d8e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4e16832b0bdf9392c5138bbbde024d8e">&#9670;&nbsp;</a></span>time_point</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Clock &gt; </div>
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classbeast_1_1abstract__clock.html">beast::abstract_clock</a>&lt; Clock &gt;::<a class="el" href="classbeast_1_1abstract__clock.html#a4e16832b0bdf9392c5138bbbde024d8e">time_point</a> = typename Clock::time_point</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="abstract__clock_8h_source.html#l00063">63</a> of file <a class="el" href="abstract__clock_8h_source.html">abstract_clock.h</a>.</p>
</div>
</div>
<a id="ab2db1e4273a58b6431b330e3c5ebd07f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab2db1e4273a58b6431b330e3c5ebd07f">&#9670;&nbsp;</a></span>clock_type</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Clock &gt; </div>
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classbeast_1_1abstract__clock.html">beast::abstract_clock</a>&lt; Clock &gt;::<a class="el" href="classbeast_1_1abstract__clock.html#ab2db1e4273a58b6431b330e3c5ebd07f">clock_type</a> = Clock</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="abstract__clock_8h_source.html#l00064">64</a> of file <a class="el" href="abstract__clock_8h_source.html">abstract_clock.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="aaa505cdf3c83a46f6c2e5727ca5878dd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaa505cdf3c83a46f6c2e5727ca5878dd">&#9670;&nbsp;</a></span>~abstract_clock()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Clock &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classbeast_1_1abstract__clock.html">beast::abstract_clock</a>&lt; Clock &gt;::~<a class="el" href="classbeast_1_1abstract__clock.html">abstract_clock</a> </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="afa9ffe22af13542f15b7098db8950c78"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afa9ffe22af13542f15b7098db8950c78">&#9670;&nbsp;</a></span>abstract_clock() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Clock &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classbeast_1_1abstract__clock.html">beast::abstract_clock</a>&lt; Clock &gt;::<a class="el" href="classbeast_1_1abstract__clock.html">abstract_clock</a> </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="aea4770a0091ddb7526d82aeac5796f88"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aea4770a0091ddb7526d82aeac5796f88">&#9670;&nbsp;</a></span>abstract_clock() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Clock &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classbeast_1_1abstract__clock.html">beast::abstract_clock</a>&lt; Clock &gt;::<a class="el" href="classbeast_1_1abstract__clock.html">abstract_clock</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classbeast_1_1abstract__clock.html">abstract_clock</a>&lt; Clock &gt; 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">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ac9a577663353bfea66a096f12cb85293"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac9a577663353bfea66a096f12cb85293">&#9670;&nbsp;</a></span>now()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Clock &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classbeast_1_1abstract__clock.html#a4e16832b0bdf9392c5138bbbde024d8e">time_point</a> <a class="el" href="classbeast_1_1abstract__clock.html">beast::abstract_clock</a>&lt; Clock &gt;::now </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</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>Returns the current time. </p>
<p>Implemented in <a class="el" href="classbeast_1_1manual__clock.html#a4f068970e2af845fb9512c44fc32be0a">beast::manual_clock&lt; Clock &gt;</a>, and <a class="el" href="classbeast_1_1manual__clock.html#a4f068970e2af845fb9512c44fc32be0a">beast::manual_clock&lt; std::chrono::steady_clock &gt;</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="ad919604810f750a57e777e9985d742af"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad919604810f750a57e777e9985d742af">&#9670;&nbsp;</a></span>is_steady</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Clock &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const bool <a class="el" href="classbeast_1_1abstract__clock.html">beast::abstract_clock</a>&lt; Clock &gt;::is_steady = Clock::is_steady</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="abstract__clock_8h_source.html#l00066">66</a> of file <a class="el" href="abstract__clock_8h_source.html">abstract_clock.h</a>.</p>
</div>
</div>
</div><!-- contents -->
<div class="ttc" id="aclassbeast_1_1abstract__clock_html_ab2db1e4273a58b6431b330e3c5ebd07f"><div class="ttname"><a href="classbeast_1_1abstract__clock.html#ab2db1e4273a58b6431b330e3c5ebd07f">beast::abstract_clock::clock_type</a></div><div class="ttdeci">Clock clock_type</div><div class="ttdef"><b>Definition:</b> <a href="abstract__clock_8h_source.html#l00064">abstract_clock.h:64</a></div></div>
<div class="ttc" id="aclock_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/chrono/c/clock.html">std::clock</a></div><div class="ttdeci">T clock(T... args)</div></div>
<!-- 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>