<!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.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Crypto++: hrtimer.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="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">Crypto++
 <span id="projectnumber">7.0</span>
</div>
<div id="projectbrief">Free C++ class library of cryptographic schemes</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<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('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">hrtimer.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#ifndef CRYPTOPP_HRTIMER_H</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define CRYPTOPP_HRTIMER_H</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> </div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include "<a class="code" href="config_8h.html">config.h</a>"</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> </div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#if !defined(HIGHRES_TIMER_AVAILABLE) || (defined(CRYPTOPP_WIN32_AVAILABLE) && !defined(THREAD_TIMER_AVAILABLE))</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#include <time.h></span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> </div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> NAMESPACE_BEGIN(<a class="code" href="namespace_crypto_p_p.html">CryptoPP</a>)</div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> </div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#ifdef HIGHRES_TIMER_AVAILABLE</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>  <span class="keyword">typedef</span> word64 TimerWord;</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>  <span class="keyword">typedef</span> clock_t TimerWord;</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#endif</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">/// \brief Base class for timers</span></div><div class="line"><a name="l00019"></a><span class="lineno"><a class="line" href="class_timer_base.html"> 19</a></span> <span class="comment"></span><span class="keyword">class </span>CRYPTOPP_DLL CRYPTOPP_NO_VTABLE <a class="code" href="class_timer_base.html">TimerBase</a></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> {</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  <span class="keyword">enum</span> Unit {SECONDS = 0, MILLISECONDS, MICROSECONDS, NANOSECONDS};</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  <a class="code" href="class_timer_base.html">TimerBase</a>(Unit unit, <span class="keywordtype">bool</span> stuckAtZero)</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  : m_timerUnit(unit), m_stuckAtZero(stuckAtZero), m_started(<span class="keyword">false</span>)</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  , m_start(0), m_last(0) {}</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="keyword">virtual</span> TimerWord GetCurrentTimerValue() =0; <span class="comment">// GetCurrentTime is a macro in MSVC 6.0</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <span class="keyword">virtual</span> TimerWord TicksPerSecond() =0; <span class="comment">// this is not the resolution, just a conversion factor into seconds</span></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="keywordtype">void</span> StartTimer();</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="keywordtype">double</span> ElapsedTimeAsDouble();</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> ElapsedTime();</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keywordtype">double</span> ConvertTo(TimerWord t, Unit unit);</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>  Unit m_timerUnit; <span class="comment">// HPUX workaround: m_unit is a system macro on HPUX</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keywordtype">bool</span> m_stuckAtZero, m_started;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  TimerWord m_start, m_last;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> };</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"></span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment">/// \brief Measure CPU time spent executing instructions of this thread (if supported by OS)</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment">/// \note ThreadUserTimer only works correctly on Windows NT or later desktops and servers.</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment">/// On Unix-based it reports process time. On Windows Phone and Windows Store it reports wall</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment">/// clock time with performance counter precision. On all others it reports wall clock time.</span></div><div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="class_thread_user_timer.html"> 46</a></span> <span class="comment"></span><span class="keyword">class </span><a class="code" href="class_thread_user_timer.html">ThreadUserTimer</a> : <span class="keyword">public</span> <a class="code" href="class_timer_base.html">TimerBase</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="keyword">public</span>:</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <a class="code" href="class_thread_user_timer.html">ThreadUserTimer</a>(Unit unit = TimerBase::SECONDS, <span class="keywordtype">bool</span> stuckAtZero = <span class="keyword">false</span>) : <a class="code" href="class_timer_base.html">TimerBase</a>(unit, stuckAtZero) {}</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  TimerWord GetCurrentTimerValue();</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  TimerWord TicksPerSecond();</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> };</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"></span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment">/// high resolution timer</span></div><div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="class_timer.html"> 55</a></span> <span class="comment"></span><span class="keyword">class </span>CRYPTOPP_DLL <a class="code" href="class_timer.html">Timer</a> : <span class="keyword">public</span> <a class="code" href="class_timer_base.html">TimerBase</a></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> <span class="keyword">public</span>:</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <a class="code" href="class_timer.html">Timer</a>(Unit unit = TimerBase::SECONDS, <span class="keywordtype">bool</span> stuckAtZero = <span class="keyword">false</span>) : <a class="code" href="class_timer_base.html">TimerBase</a>(unit, stuckAtZero) {}</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  TimerWord GetCurrentTimerValue();</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  TimerWord TicksPerSecond();</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</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> NAMESPACE_END</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="class_timer_html"><div class="ttname"><a href="class_timer.html">Timer</a></div><div class="ttdoc">high resolution timer</div><div class="ttdef"><b>Definition:</b> <a href="hrtimer_8h_source.html#l00055">hrtimer.h:55</a></div></div>
<div class="ttc" id="config_8h_html"><div class="ttname"><a href="config_8h.html">config.h</a></div><div class="ttdoc">Library configuration file.</div></div>
<div class="ttc" id="namespace_crypto_p_p_html"><div class="ttname"><a href="namespace_crypto_p_p.html">CryptoPP</a></div><div class="ttdoc">Crypto++ library namespace.</div></div>
<div class="ttc" id="class_thread_user_timer_html"><div class="ttname"><a href="class_thread_user_timer.html">ThreadUserTimer</a></div><div class="ttdoc">Measure CPU time spent executing instructions of this thread (if supported by OS)</div><div class="ttdef"><b>Definition:</b> <a href="hrtimer_8h_source.html#l00046">hrtimer.h:46</a></div></div>
<div class="ttc" id="class_timer_base_html"><div class="ttname"><a href="class_timer_base.html">TimerBase</a></div><div class="ttdoc">Base class for timers.</div><div class="ttdef"><b>Definition:</b> <a href="hrtimer_8h_source.html#l00019">hrtimer.h:19</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Nov 27 2019 15:03:33 for Crypto++ by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.15
</small></address>
</body>
</html>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-updates
>
by-pkgid
>
17f48c047155a7d4c992d6a672acd57f
>
files
>
2392
