ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-12-06 17:27:55 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
6e4b4ad064564d5fe2e166d04d113d603ddab3f9
rippled/classripple_1_1UptimeClock.html
manojsdoshi 430f6c0cf3 deploy: 023f5704d0
2020-04-24 01:09:47 +00:00

371 lines
20 KiB
HTML
Raw 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">
<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::UptimeClock 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_1UptimeClock.html">UptimeClock</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="#pri-static-methods">Static Private Member Functions</a> &#124;
<a href="#pri-static-attribs">Static Private Attributes</a> &#124;
<a href="classripple_1_1UptimeClock-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ripple::UptimeClock Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Tracks program uptime to seconds precision.
<a href="classripple_1_1UptimeClock.html#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for ripple::UptimeClock:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1UptimeClock__coll__graph.png" border="0" usemap="#ripple_1_1UptimeClock_coll__map" alt="Collaboration graph"/></div>
<map name="ripple_1_1UptimeClock_coll__map" id="ripple_1_1UptimeClock_coll__map">
<area shape="rect" title="Tracks program uptime to seconds precision." alt="" coords="90,95,241,121"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/atomic/atomic.html" title=" " alt="" coords="5,5,152,32"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/atomic/atomic.html" title=" " alt="" coords="177,5,330,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="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1UptimeClock_1_1update__thread.html">update_thread</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:ae674ae28fa08923824a71da9761b3ffe"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1UptimeClock.html#ae674ae28fa08923824a71da9761b3ffe">rep</a> = int</td></tr>
<tr class="separator:ae674ae28fa08923824a71da9761b3ffe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:add29eb7d6f6e60e6a33e4d3dc474b298"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1UptimeClock.html#add29eb7d6f6e60e6a33e4d3dc474b298">period</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/numeric/ratio/ratio.html">std::ratio</a>&lt; 1 &gt;</td></tr>
<tr class="separator:add29eb7d6f6e60e6a33e4d3dc474b298"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac65a03f7831f831511985e0b3966ac51"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1UptimeClock.html#ac65a03f7831f831511985e0b3966ac51">duration</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/duration.html">std::chrono::duration</a>&lt; <a class="el" href="classripple_1_1UptimeClock.html#ae674ae28fa08923824a71da9761b3ffe">rep</a>, <a class="el" href="classripple_1_1UptimeClock.html#add29eb7d6f6e60e6a33e4d3dc474b298">period</a> &gt;</td></tr>
<tr class="separator:ac65a03f7831f831511985e0b3966ac51"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa38022139969f4d6a0f68932d5349f48"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1UptimeClock.html#aa38022139969f4d6a0f68932d5349f48">time_point</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/time_point.html">std::chrono::time_point</a>&lt; <a class="el" href="classripple_1_1UptimeClock.html">UptimeClock</a> &gt;</td></tr>
<tr class="separator:aa38022139969f4d6a0f68932d5349f48"><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:a03c13771ed6c0c76dbd738aa2df16293"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1UptimeClock.html#a03c13771ed6c0c76dbd738aa2df16293">UptimeClock</a> ()=default</td></tr>
<tr class="separator:a03c13771ed6c0c76dbd738aa2df16293"><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-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:ae854244a4dcf8de363337e93d5a04444"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classripple_1_1UptimeClock.html#aa38022139969f4d6a0f68932d5349f48">time_point</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1UptimeClock.html#ae854244a4dcf8de363337e93d5a04444">now</a> ()</td></tr>
<tr class="separator:ae854244a4dcf8de363337e93d5a04444"><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:a72b3ab30ffa11af67b3443bb4773ac93"><td class="memItemLeft" align="right" valign="top">static constexpr bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1UptimeClock.html#a72b3ab30ffa11af67b3443bb4773ac93">is_steady</a> = std::chrono::system_clock::is_steady</td></tr>
<tr class="separator:a72b3ab30ffa11af67b3443bb4773ac93"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-static-methods"></a>
Static Private Member Functions</h2></td></tr>
<tr class="memitem:ab2d08a5c727dee9ccfef0e7eac180a51"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structripple_1_1UptimeClock_1_1update__thread.html">update_thread</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1UptimeClock.html#ab2d08a5c727dee9ccfef0e7eac180a51">start_clock</a> ()</td></tr>
<tr class="separator:ab2d08a5c727dee9ccfef0e7eac180a51"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-static-attribs"></a>
Static Private Attributes</h2></td></tr>
<tr class="memitem:acb9cbc691e8c4a7c7554ecc4b46a9dbf"><td class="memItemLeft" align="right" valign="top">static <a class="elRef" href="http://en.cppreference.com/w/cpp/atomic/atomic.html">std::atomic</a>&lt; <a class="el" href="classripple_1_1UptimeClock.html#ae674ae28fa08923824a71da9761b3ffe">rep</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1UptimeClock.html#acb9cbc691e8c4a7c7554ecc4b46a9dbf">now_</a> {0}</td></tr>
<tr class="separator:acb9cbc691e8c4a7c7554ecc4b46a9dbf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aff526184e48d4ddfb8c0b000e941896b"><td class="memItemLeft" align="right" valign="top">static <a class="elRef" href="http://en.cppreference.com/w/cpp/atomic/atomic.html">std::atomic</a>&lt; bool &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1UptimeClock.html#aff526184e48d4ddfb8c0b000e941896b">stop_</a> {false}</td></tr>
<tr class="separator:aff526184e48d4ddfb8c0b000e941896b"><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>Tracks program uptime to seconds precision. </p>
<p>The timer caches the current time as a performance optimization. This allows clients to query the current time thousands of times per second. </p>
<p class="definition">Definition at line <a class="el" href="UptimeClock_8h_source.html#l00037">37</a> of file <a class="el" href="UptimeClock_8h_source.html">UptimeClock.h</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="ae674ae28fa08923824a71da9761b3ffe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae674ae28fa08923824a71da9761b3ffe">&#9670;&nbsp;</a></span>rep</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classripple_1_1UptimeClock.html#ae674ae28fa08923824a71da9761b3ffe">ripple::UptimeClock::rep</a> = int</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="UptimeClock_8h_source.html#l00040">40</a> of file <a class="el" href="UptimeClock_8h_source.html">UptimeClock.h</a>.</p>
</div>
</div>
<a id="add29eb7d6f6e60e6a33e4d3dc474b298"></a>
<h2 class="memtitle"><span class="permalink"><a href="#add29eb7d6f6e60e6a33e4d3dc474b298">&#9670;&nbsp;</a></span>period</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classripple_1_1UptimeClock.html#add29eb7d6f6e60e6a33e4d3dc474b298">ripple::UptimeClock::period</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/numeric/ratio/ratio.html">std::ratio</a>&lt;1&gt;</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="UptimeClock_8h_source.html#l00041">41</a> of file <a class="el" href="UptimeClock_8h_source.html">UptimeClock.h</a>.</p>
</div>
</div>
<a id="ac65a03f7831f831511985e0b3966ac51"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac65a03f7831f831511985e0b3966ac51">&#9670;&nbsp;</a></span>duration</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classripple_1_1UptimeClock.html#ac65a03f7831f831511985e0b3966ac51">ripple::UptimeClock::duration</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/duration.html">std::chrono::duration</a>&lt;<a class="el" href="classripple_1_1UptimeClock.html#ae674ae28fa08923824a71da9761b3ffe">rep</a>, <a class="el" href="classripple_1_1UptimeClock.html#add29eb7d6f6e60e6a33e4d3dc474b298">period</a>&gt;</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="UptimeClock_8h_source.html#l00042">42</a> of file <a class="el" href="UptimeClock_8h_source.html">UptimeClock.h</a>.</p>
</div>
</div>
<a id="aa38022139969f4d6a0f68932d5349f48"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa38022139969f4d6a0f68932d5349f48">&#9670;&nbsp;</a></span>time_point</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classripple_1_1UptimeClock.html#aa38022139969f4d6a0f68932d5349f48">ripple::UptimeClock::time_point</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/time_point.html">std::chrono::time_point</a>&lt;<a class="el" href="classripple_1_1UptimeClock.html">UptimeClock</a>&gt;</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="UptimeClock_8h_source.html#l00043">43</a> of file <a class="el" href="UptimeClock_8h_source.html">UptimeClock.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a03c13771ed6c0c76dbd738aa2df16293"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a03c13771ed6c0c76dbd738aa2df16293">&#9670;&nbsp;</a></span>UptimeClock()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ripple::UptimeClock::UptimeClock </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ae854244a4dcf8de363337e93d5a04444"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae854244a4dcf8de363337e93d5a04444">&#9670;&nbsp;</a></span>now()</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_1UptimeClock.html#aa38022139969f4d6a0f68932d5349f48">UptimeClock::time_point</a> ripple::UptimeClock::now </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></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="UptimeClock_8cpp_source.html#l00063">63</a> of file <a class="el" href="UptimeClock_8cpp_source.html">UptimeClock.cpp</a>.</p>
</div>
</div>
<a id="ab2d08a5c727dee9ccfef0e7eac180a51"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab2d08a5c727dee9ccfef0e7eac180a51">&#9670;&nbsp;</a></span>start_clock()</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="structripple_1_1UptimeClock_1_1update__thread.html">UptimeClock::update_thread</a> ripple::UptimeClock::start_clock </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="UptimeClock_8cpp_source.html#l00041">41</a> of file <a class="el" href="UptimeClock_8cpp_source.html">UptimeClock.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a72b3ab30ffa11af67b3443bb4773ac93"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a72b3ab30ffa11af67b3443bb4773ac93">&#9670;&nbsp;</a></span>is_steady</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr bool ripple::UptimeClock::is_steady = std::chrono::system_clock::is_steady</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="UptimeClock_8h_source.html#l00044">44</a> of file <a class="el" href="UptimeClock_8h_source.html">UptimeClock.h</a>.</p>
</div>
</div>
<a id="acb9cbc691e8c4a7c7554ecc4b46a9dbf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acb9cbc691e8c4a7c7554ecc4b46a9dbf">&#9670;&nbsp;</a></span>now_</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/atomic/atomic.html">std::atomic</a>&lt; <a class="el" href="classripple_1_1UptimeClock.html#ae674ae28fa08923824a71da9761b3ffe">UptimeClock::rep</a> &gt; ripple::UptimeClock::now_ {0}</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="UptimeClock_8h_source.html#l00052">52</a> of file <a class="el" href="UptimeClock_8h_source.html">UptimeClock.h</a>.</p>
</div>
</div>
<a id="aff526184e48d4ddfb8c0b000e941896b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aff526184e48d4ddfb8c0b000e941896b">&#9670;&nbsp;</a></span>stop_</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/atomic/atomic.html">std::atomic</a>&lt; bool &gt; ripple::UptimeClock::stop_ {false}</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="UptimeClock_8h_source.html#l00053">53</a> of file <a class="el" href="UptimeClock_8h_source.html">UptimeClock.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>
Reference in New Issue View Git Blame Copy Permalink