Files
rippled/abstract__clock_8h_source.html
2025-11-04 00:36:48 -08:00

176 lines
22 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" 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: abstract_clock.h Source File</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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<!-- 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="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_0103a8ad82dcc2c51f5cde661b4b5cb7.html">xrpl</a></li><li class="navelem"><a class="el" href="dir_31b47b71b675f5c4d1b67be42516b2a9.html">beast</a></li><li class="navelem"><a class="el" href="dir_074b1a10a9cf3bcc863c1a40553742ed.html">clock</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">abstract_clock.h</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#ifndef BEAST_CHRONO_ABSTRACT_CLOCK_H_INCLUDED</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define BEAST_CHRONO_ABSTRACT_CLOCK_H_INCLUDED</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacebeast.html">beast</a> {</div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span> </div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="keyword">template</span> &lt;<span class="keyword">class</span> Clock&gt;</div>
<div class="foldopen" id="foldopen00035" data-start="{" data-end="};">
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"><a class="line" href="classbeast_1_1abstract__clock.html"> 35</a></span><span class="keyword">class </span><a class="code hl_class" href="classbeast_1_1abstract__clock.html">abstract_clock</a></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span>{</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"><a class="line" href="classbeast_1_1abstract__clock.html#a4435fdfcd47c4f67bbb21940e5505208"> 38</a></span> <span class="keyword">using </span><a class="code hl_typedef" href="classbeast_1_1abstract__clock.html#a4435fdfcd47c4f67bbb21940e5505208">rep</a> = <span class="keyword">typename</span> Clock::rep;</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"><a class="line" href="classbeast_1_1abstract__clock.html#abba11dabb096d89ff62699b64efb472e"> 39</a></span> <span class="keyword">using </span><a class="code hl_typedef" href="classbeast_1_1abstract__clock.html#abba11dabb096d89ff62699b64efb472e">period</a> = <span class="keyword">typename</span> Clock::period;</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"><a class="line" href="classbeast_1_1abstract__clock.html#ad024b15fa67696e8d1eba3744e800d32"> 40</a></span> <span class="keyword">using </span><a class="code hl_typedef" href="classbeast_1_1abstract__clock.html#ad024b15fa67696e8d1eba3744e800d32">duration</a> = <span class="keyword">typename</span> Clock::duration;</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"><a class="line" href="classbeast_1_1abstract__clock.html#a4e16832b0bdf9392c5138bbbde024d8e"> 41</a></span> <span class="keyword">using </span><a class="code hl_typedef" href="classbeast_1_1abstract__clock.html#a4e16832b0bdf9392c5138bbbde024d8e">time_point</a> = <span class="keyword">typename</span> Clock::time_point;</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"><a class="line" href="classbeast_1_1abstract__clock.html#ab2db1e4273a58b6431b330e3c5ebd07f"> 42</a></span> <span class="keyword">using </span><a class="code hl_typedef" href="classbeast_1_1abstract__clock.html#ab2db1e4273a58b6431b330e3c5ebd07f">clock_type</a> = Clock;</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> </div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"><a class="line" href="classbeast_1_1abstract__clock.html#a76fc7ea130b22226cae0d891eff02f57"> 44</a></span> <span class="keyword">static</span> <span class="keywordtype">bool</span> <span class="keyword">const</span> <a class="code hl_variable" href="classbeast_1_1abstract__clock.html#a76fc7ea130b22226cae0d891eff02f57">is_steady</a> = Clock::is_steady;</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> </div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"><a class="line" href="classbeast_1_1abstract__clock.html#aaa505cdf3c83a46f6c2e5727ca5878dd"> 46</a></span> <span class="keyword">virtual</span> <a class="code hl_function" href="classbeast_1_1abstract__clock.html#aaa505cdf3c83a46f6c2e5727ca5878dd">~abstract_clock</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"><a class="line" href="classbeast_1_1abstract__clock.html#afa9ffe22af13542f15b7098db8950c78"> 47</a></span> <a class="code hl_function" href="classbeast_1_1abstract__clock.html#afa9ffe22af13542f15b7098db8950c78">abstract_clock</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"><a class="line" href="classbeast_1_1abstract__clock.html#aea4770a0091ddb7526d82aeac5796f88"> 48</a></span> <a class="code hl_function" href="classbeast_1_1abstract__clock.html#aea4770a0091ddb7526d82aeac5796f88">abstract_clock</a>(<a class="code hl_class" href="classbeast_1_1abstract__clock.html">abstract_clock</a> <span class="keyword">const</span>&amp;) = <span class="keywordflow">default</span>;</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> </div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> [[nodiscard]] <span class="keyword">virtual</span> <a class="code hl_typedef" href="classbeast_1_1abstract__clock.html#a4e16832b0bdf9392c5138bbbde024d8e">time_point</a></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"><a class="line" href="classbeast_1_1abstract__clock.html#ac9a577663353bfea66a096f12cb85293"> 52</a></span> <a class="code hl_function" href="classbeast_1_1abstract__clock.html#ac9a577663353bfea66a096f12cb85293">now</a>() <span class="keyword">const</span> = 0;</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span>};</div>
</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> </div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span><span class="comment">//------------------------------------------------------------------------------</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> </div>
<div class="foldopen" id="foldopen00057" data-start="{" data-end="}">
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"><a class="line" href="namespacebeast_1_1detail.html"> 57</a></span><span class="keyword">namespace </span>detail {</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> </div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span><span class="keyword">template</span> &lt;<span class="keyword">class</span> Facade, <span class="keyword">class</span> Clock&gt;</div>
<div class="foldopen" id="foldopen00060" data-start="{" data-end="};">
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"><a class="line" href="structbeast_1_1detail_1_1abstract__clock__wrapper.html"> 60</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structbeast_1_1detail_1_1abstract__clock__wrapper.html">abstract_clock_wrapper</a> : <span class="keyword">public</span> <a class="code hl_class" href="classbeast_1_1abstract__clock.html">abstract_clock</a>&lt;Facade&gt;</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span>{</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"><a class="line" href="structbeast_1_1detail_1_1abstract__clock__wrapper.html#a0d19ff492c6a8e05af1ba88e96aecf0c"> 62</a></span> <span class="keyword">explicit</span> <a class="code hl_function" href="structbeast_1_1detail_1_1abstract__clock__wrapper.html#a0d19ff492c6a8e05af1ba88e96aecf0c">abstract_clock_wrapper</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> </div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> <span class="keyword">using </span>typename <a class="code hl_typedef" href="classbeast_1_1abstract__clock.html#ad024b15fa67696e8d1eba3744e800d32">abstract_clock&lt;Facade&gt;::duration</a>;</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> <span class="keyword">using </span>typename <a class="code hl_typedef" href="classbeast_1_1abstract__clock.html#a4e16832b0bdf9392c5138bbbde024d8e">abstract_clock&lt;Facade&gt;::time_point</a>;</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> </div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> <a class="code hl_typedef" href="classbeast_1_1abstract__clock.html#a4e16832b0bdf9392c5138bbbde024d8e">time_point</a></div>
<div class="foldopen" id="foldopen00068" data-start="{" data-end="}">
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"><a class="line" href="structbeast_1_1detail_1_1abstract__clock__wrapper.html#a3775a924e74c34cd97d162b9f95e6bf5"> 68</a></span> <a class="code hl_function" href="structbeast_1_1detail_1_1abstract__clock__wrapper.html#a3775a924e74c34cd97d162b9f95e6bf5">now</a>()<span class="keyword"> const override</span></div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> <span class="keywordflow">return</span> Clock::now();</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> }</div>
</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span>};</div>
</div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> </div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span>} <span class="comment">// namespace detail</span></div>
</div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> </div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span><span class="comment">//------------------------------------------------------------------------------</span></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> </div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span><span class="keyword">template</span> &lt;<span class="keyword">class</span> Facade, <span class="keyword">class</span> Clock = Facade&gt;</div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span>abstract_clock&lt;Facade&gt;&amp;</div>
<div class="foldopen" id="foldopen00085" data-start="{" data-end="}">
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"><a class="line" href="namespacebeast.html#a9d2d0a0c2e839db2a9bce6ed53086d4a"> 85</a></span><a class="code hl_function" href="namespacebeast.html#a9d2d0a0c2e839db2a9bce6ed53086d4a">get_abstract_clock</a>()</div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span>{</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> <span class="keyword">static</span> <a class="code hl_struct" href="structbeast_1_1detail_1_1abstract__clock__wrapper.html">detail::abstract_clock_wrapper&lt;Facade, Clock&gt;</a> clock;</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> <span class="keywordflow">return</span> clock;</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span>}</div>
</div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> </div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span>} <span class="comment">// namespace beast</span></div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> </div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclassbeast_1_1abstract__clock_html"><div class="ttname"><a href="classbeast_1_1abstract__clock.html">beast::abstract_clock</a></div><div class="ttdoc">Abstract interface to a clock.</div><div class="ttdef"><b>Definition</b> <a href="abstract__clock_8h_source.html#l00035">abstract_clock.h:36</a></div></div>
<div class="ttc" id="aclassbeast_1_1abstract__clock_html_a4435fdfcd47c4f67bbb21940e5505208"><div class="ttname"><a href="classbeast_1_1abstract__clock.html#a4435fdfcd47c4f67bbb21940e5505208">beast::abstract_clock::rep</a></div><div class="ttdeci">typename Clock::rep rep</div><div class="ttdef"><b>Definition</b> <a href="abstract__clock_8h_source.html#l00038">abstract_clock.h:38</a></div></div>
<div class="ttc" id="aclassbeast_1_1abstract__clock_html_a4e16832b0bdf9392c5138bbbde024d8e"><div class="ttname"><a href="classbeast_1_1abstract__clock.html#a4e16832b0bdf9392c5138bbbde024d8e">beast::abstract_clock::time_point</a></div><div class="ttdeci">typename Clock::time_point time_point</div><div class="ttdef"><b>Definition</b> <a href="abstract__clock_8h_source.html#l00041">abstract_clock.h:41</a></div></div>
<div class="ttc" id="aclassbeast_1_1abstract__clock_html_a76fc7ea130b22226cae0d891eff02f57"><div class="ttname"><a href="classbeast_1_1abstract__clock.html#a76fc7ea130b22226cae0d891eff02f57">beast::abstract_clock::is_steady</a></div><div class="ttdeci">static bool const is_steady</div><div class="ttdef"><b>Definition</b> <a href="abstract__clock_8h_source.html#l00044">abstract_clock.h:44</a></div></div>
<div class="ttc" id="aclassbeast_1_1abstract__clock_html_aaa505cdf3c83a46f6c2e5727ca5878dd"><div class="ttname"><a href="classbeast_1_1abstract__clock.html#aaa505cdf3c83a46f6c2e5727ca5878dd">beast::abstract_clock::~abstract_clock</a></div><div class="ttdeci">virtual ~abstract_clock()=default</div></div>
<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#l00042">abstract_clock.h:42</a></div></div>
<div class="ttc" id="aclassbeast_1_1abstract__clock_html_abba11dabb096d89ff62699b64efb472e"><div class="ttname"><a href="classbeast_1_1abstract__clock.html#abba11dabb096d89ff62699b64efb472e">beast::abstract_clock::period</a></div><div class="ttdeci">typename Clock::period period</div><div class="ttdef"><b>Definition</b> <a href="abstract__clock_8h_source.html#l00039">abstract_clock.h:39</a></div></div>
<div class="ttc" id="aclassbeast_1_1abstract__clock_html_ac9a577663353bfea66a096f12cb85293"><div class="ttname"><a href="classbeast_1_1abstract__clock.html#ac9a577663353bfea66a096f12cb85293">beast::abstract_clock::now</a></div><div class="ttdeci">virtual time_point now() const =0</div><div class="ttdoc">Returns the current time.</div></div>
<div class="ttc" id="aclassbeast_1_1abstract__clock_html_ad024b15fa67696e8d1eba3744e800d32"><div class="ttname"><a href="classbeast_1_1abstract__clock.html#ad024b15fa67696e8d1eba3744e800d32">beast::abstract_clock::duration</a></div><div class="ttdeci">typename Clock::duration duration</div><div class="ttdef"><b>Definition</b> <a href="abstract__clock_8h_source.html#l00040">abstract_clock.h:40</a></div></div>
<div class="ttc" id="aclassbeast_1_1abstract__clock_html_aea4770a0091ddb7526d82aeac5796f88"><div class="ttname"><a href="classbeast_1_1abstract__clock.html#aea4770a0091ddb7526d82aeac5796f88">beast::abstract_clock::abstract_clock</a></div><div class="ttdeci">abstract_clock(abstract_clock const &amp;)=default</div></div>
<div class="ttc" id="aclassbeast_1_1abstract__clock_html_afa9ffe22af13542f15b7098db8950c78"><div class="ttname"><a href="classbeast_1_1abstract__clock.html#afa9ffe22af13542f15b7098db8950c78">beast::abstract_clock::abstract_clock</a></div><div class="ttdeci">abstract_clock()=default</div></div>
<div class="ttc" id="anamespacebeast_html"><div class="ttname"><a href="namespacebeast.html">beast</a></div><div class="ttdef"><b>Definition</b> <a href="base__uint_8h_source.html#l00653">base_uint.h:653</a></div></div>
<div class="ttc" id="anamespacebeast_html_a9d2d0a0c2e839db2a9bce6ed53086d4a"><div class="ttname"><a href="namespacebeast.html#a9d2d0a0c2e839db2a9bce6ed53086d4a">beast::get_abstract_clock</a></div><div class="ttdeci">abstract_clock&lt; Facade &gt; &amp; get_abstract_clock()</div><div class="ttdoc">Returns a global instance of an abstract clock.</div><div class="ttdef"><b>Definition</b> <a href="abstract__clock_8h_source.html#l00085">abstract_clock.h:85</a></div></div>
<div class="ttc" id="astructbeast_1_1detail_1_1abstract__clock__wrapper_html"><div class="ttname"><a href="structbeast_1_1detail_1_1abstract__clock__wrapper.html">beast::detail::abstract_clock_wrapper</a></div><div class="ttdef"><b>Definition</b> <a href="abstract__clock_8h_source.html#l00060">abstract_clock.h:61</a></div></div>
<div class="ttc" id="astructbeast_1_1detail_1_1abstract__clock__wrapper_html_a0d19ff492c6a8e05af1ba88e96aecf0c"><div class="ttname"><a href="structbeast_1_1detail_1_1abstract__clock__wrapper.html#a0d19ff492c6a8e05af1ba88e96aecf0c">beast::detail::abstract_clock_wrapper::abstract_clock_wrapper</a></div><div class="ttdeci">abstract_clock_wrapper()=default</div></div>
<div class="ttc" id="astructbeast_1_1detail_1_1abstract__clock__wrapper_html_a3775a924e74c34cd97d162b9f95e6bf5"><div class="ttname"><a href="structbeast_1_1detail_1_1abstract__clock__wrapper.html#a3775a924e74c34cd97d162b9f95e6bf5">beast::detail::abstract_clock_wrapper::now</a></div><div class="ttdeci">time_point now() const override</div><div class="ttdoc">Returns the current time.</div><div class="ttdef"><b>Definition</b> <a href="abstract__clock_8h_source.html#l00068">abstract_clock.h:68</a></div></div>
</div><!-- fragment --></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>