mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-21 19:45:53 +00:00
169 lines
20 KiB
HTML
169 lines
20 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: UptimeClock.cpp 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 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&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&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="dir_df9c78dcf3f59a33b12284f95992a64b.html">ripple</a></li><li class="navelem"><a class="el" href="dir_5f536ab1985a8dcd28bcfd618bc58e92.html">basics</a></li><li class="navelem"><a class="el" href="dir_6f921693cf6aba7edd915fbfc33f741e.html">impl</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">UptimeClock.cpp</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">//------------------------------------------------------------------------------</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> This file is part of rippled: https://github.com/ripple/rippled</span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> Copyright (c) 2012, 2013 Ripple Labs Inc.</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> Permission to use, copy, modify, and/or distribute this software for any</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> purpose with or without fee is hereby granted, provided that the above</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> copyright notice and this permission notice appear in all copies.</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF</span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES</span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF</span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">//==============================================================================</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  </div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include <ripple/basics/UptimeClock.h></span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  </div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="keyword">namespace </span><a class="code" href="namespaceripple.html">ripple</a> {</div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  </div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <a class="codeRef" href="http://en.cppreference.com/w/cpp/atomic/atomic.html">std::atomic<UptimeClock::rep></a> <a class="code" href="classripple_1_1UptimeClock.html#acb9cbc691e8c4a7c7554ecc4b46a9dbf">UptimeClock::now_</a>{0}; <span class="comment">// seconds since start</span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <a class="codeRef" href="http://en.cppreference.com/w/cpp/atomic/atomic.html">std::atomic<bool></a> <a class="code" href="classripple_1_1UptimeClock.html#aff526184e48d4ddfb8c0b000e941896b">UptimeClock::stop_</a>{<span class="keyword">false</span>}; <span class="comment">// stop update thread</span></div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  </div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">// On rippled shutdown, cancel and wait for the update thread</span></div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="structripple_1_1UptimeClock_1_1update__thread.html#a410d6c334f6e6ba383a0c00efb27ac4b"> 28</a></span> <a class="code" href="structripple_1_1UptimeClock_1_1update__thread.html#a410d6c334f6e6ba383a0c00efb27ac4b">UptimeClock::update_thread::~update_thread</a>()</div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> {</div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="keywordflow">if</span> (<a class="codeRef" href="http://en.cppreference.com/w/cpp/thread/thread/joinable.html">joinable</a>())</div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  {</div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <a class="code" href="classripple_1_1UptimeClock.html#aff526184e48d4ddfb8c0b000e941896b">stop_</a> = <span class="keyword">true</span>;</div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="comment">// This join() may take up to a 1s, but happens only</span></div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="comment">// once at rippled shutdown.</span></div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/thread/thread/join.html">join</a>();</div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  }</div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> }</div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  </div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment">// Launch the update thread</span></div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <a class="code" href="structripple_1_1UptimeClock_1_1update__thread.html">UptimeClock::update_thread</a></div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="classripple_1_1UptimeClock.html#ab2d08a5c727dee9ccfef0e7eac180a51"> 41</a></span> <a class="code" href="classripple_1_1UptimeClock.html#ab2d08a5c727dee9ccfef0e7eac180a51">UptimeClock::start_clock</a>()</div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> {</div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keywordflow">return</span> <a class="code" href="structripple_1_1UptimeClock_1_1update__thread.html">update_thread</a>{[]</div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  {</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keyword">using namespace </span><a class="code" href="namespacestd.html">std</a>;</div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keyword">using namespace </span><a class="codeRef" href="http://en.cppreference.com/w/namespacestd_1_1chrono.html">std::chrono</a>;</div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  </div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="comment">// Wake up every second and update now_</span></div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keyword">auto</span> <a class="codeRef" href="http://en.cppreference.com/w/cpp/iterator/next.html">next</a> = system_clock::now() + 1s;</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keywordflow">while</span> (!<a class="code" href="classripple_1_1UptimeClock.html#aff526184e48d4ddfb8c0b000e941896b">stop_</a>)</div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  {</div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  this_thread::sleep_until(<a class="codeRef" href="http://en.cppreference.com/w/cpp/iterator/next.html">next</a>);</div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/iterator/next.html">next</a> += 1s;</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  ++<a class="code" href="classripple_1_1UptimeClock.html#acb9cbc691e8c4a7c7554ecc4b46a9dbf">now_</a>;</div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  }</div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  }};</div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> }</div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  </div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment">// This actually measures time since first use, instead of since rippled start.</span></div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment">// However the difference between these two epochs is a small fraction of a second</span></div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment">// and unimportant.</span></div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  </div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <a class="codeRef" href="http://en.cppreference.com/w/cpp/chrono/time_point.html">UptimeClock::time_point</a></div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="classripple_1_1UptimeClock.html#ae854244a4dcf8de363337e93d5a04444"> 64</a></span> <a class="code" href="classripple_1_1UptimeClock.html#ae854244a4dcf8de363337e93d5a04444">UptimeClock::now</a>()</div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> {</div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="comment">// start the update thread on first use</span></div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keyword">static</span> <span class="keyword">const</span> <span class="keyword">auto</span> init = <a class="code" href="classripple_1_1UptimeClock.html#ab2d08a5c727dee9ccfef0e7eac180a51">start_clock</a>();</div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  </div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="comment">// Return the number of seconds since rippled start</span></div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keywordflow">return</span> <a class="codeRef" href="http://en.cppreference.com/w/cpp/chrono/time_point.html">time_point</a>{<a class="codeRef" href="http://en.cppreference.com/w/cpp/chrono/duration.html">duration</a>{<a class="code" href="classripple_1_1UptimeClock.html#acb9cbc691e8c4a7c7554ecc4b46a9dbf">now_</a>}};</div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> }</div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  </div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> } <span class="comment">// ripple</span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<div class="ttc" id="aclassripple_1_1UptimeClock_html_aff526184e48d4ddfb8c0b000e941896b"><div class="ttname"><a href="classripple_1_1UptimeClock.html#aff526184e48d4ddfb8c0b000e941896b">ripple::UptimeClock::stop_</a></div><div class="ttdeci">static std::atomic< bool > stop_</div><div class="ttdef"><b>Definition:</b> <a href="UptimeClock_8h_source.html#l00052">UptimeClock.h:52</a></div></div>
|
|
<div class="ttc" id="aduration_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/chrono/duration.html">std::chrono::duration< rep, period ></a></div></div>
|
|
<div class="ttc" id="ajoinable_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/thread/thread/joinable.html">std::thread::joinable</a></div><div class="ttdeci">T joinable(T... args)</div></div>
|
|
<div class="ttc" id="astructripple_1_1UptimeClock_1_1update__thread_html_a410d6c334f6e6ba383a0c00efb27ac4b"><div class="ttname"><a href="structripple_1_1UptimeClock_1_1update__thread.html#a410d6c334f6e6ba383a0c00efb27ac4b">ripple::UptimeClock::update_thread::~update_thread</a></div><div class="ttdeci">~update_thread()</div><div class="ttdef"><b>Definition:</b> <a href="UptimeClock_8cpp_source.html#l00028">UptimeClock.cpp:28</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1UptimeClock_html_ae854244a4dcf8de363337e93d5a04444"><div class="ttname"><a href="classripple_1_1UptimeClock.html#ae854244a4dcf8de363337e93d5a04444">ripple::UptimeClock::now</a></div><div class="ttdeci">static time_point now()</div><div class="ttdef"><b>Definition:</b> <a href="UptimeClock_8cpp_source.html#l00064">UptimeClock.cpp:64</a></div></div>
|
|
<div class="ttc" id="atime_point_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/chrono/time_point.html">std::chrono::time_point</a></div></div>
|
|
<div class="ttc" id="aatomic_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/atomic/atomic.html">std::atomic</a></div><div class="ttdoc">STL class.</div></div>
|
|
<div class="ttc" id="astructripple_1_1UptimeClock_1_1update__thread_html"><div class="ttname"><a href="structripple_1_1UptimeClock_1_1update__thread.html">ripple::UptimeClock::update_thread</a></div><div class="ttdef"><b>Definition:</b> <a href="UptimeClock_8h_source.html#l00054">UptimeClock.h:54</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_html"><div class="ttname"><a href="namespaceripple.html">ripple</a></div><div class="ttdoc">Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.</div><div class="ttdef"><b>Definition:</b> <a href="RCLCensorshipDetector_8h_source.html#l00029">RCLCensorshipDetector.h:29</a></div></div>
|
|
<div class="ttc" id="anamespacestd_html"><div class="ttname"><a href="namespacestd.html">std</a></div><div class="ttdoc">STL namespace.</div></div>
|
|
<div class="ttc" id="aclassripple_1_1UptimeClock_html_acb9cbc691e8c4a7c7554ecc4b46a9dbf"><div class="ttname"><a href="classripple_1_1UptimeClock.html#acb9cbc691e8c4a7c7554ecc4b46a9dbf">ripple::UptimeClock::now_</a></div><div class="ttdeci">static std::atomic< rep > now_</div><div class="ttdef"><b>Definition:</b> <a href="UptimeClock_8h_source.html#l00051">UptimeClock.h:51</a></div></div>
|
|
<div class="ttc" id="ajoin_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/thread/thread/join.html">std::thread::join</a></div><div class="ttdeci">T join(T... args)</div></div>
|
|
<div class="ttc" id="aclassripple_1_1UptimeClock_html_ab2d08a5c727dee9ccfef0e7eac180a51"><div class="ttname"><a href="classripple_1_1UptimeClock.html#ab2d08a5c727dee9ccfef0e7eac180a51">ripple::UptimeClock::start_clock</a></div><div class="ttdeci">static update_thread start_clock()</div><div class="ttdef"><b>Definition:</b> <a href="UptimeClock_8cpp_source.html#l00041">UptimeClock.cpp:41</a></div></div>
|
|
<div class="ttc" id="anext_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/iterator/next.html">std::next</a></div><div class="ttdeci">T next(T... args)</div></div>
|
|
<div class="ttc" id="anamespacestd_1_1chrono_html"><div class="ttname"><a href="http://en.cppreference.com/w/namespacestd_1_1chrono.html">std::chrono</a></div></div>
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.17
|
|
</small></address>
|
|
</body>
|
|
</html>
|