133 lines
13 KiB
HTML
133 lines
13 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.9.1"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>uvw: src/uvw/timer.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 style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">uvw
|
|
 <span id="projectnumber">2.12.1</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.1 -->
|
|
<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','.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: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_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_98934c98f70735fe3a272005a9eb8736.html">uvw</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">timer.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 UVW_TIMER_INCLUDE_H</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define UVW_TIMER_INCLUDE_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 <chrono></span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#include <uv.h></span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#include "handle.hpp"</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#include "loop.h"</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>  </div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="keyword">namespace </span><a class="code" href="namespaceuvw.html">uvw</a> {</div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>  </div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="structuvw_1_1TimerEvent.html"> 16</a></span> <span class="keyword">struct </span><a class="code" href="structuvw_1_1TimerEvent.html">TimerEvent</a> {};</div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  </div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="classuvw_1_1TimerHandle.html"> 25</a></span> <span class="keyword">class </span><a class="code" href="classuvw_1_1TimerHandle.html">TimerHandle</a> final: <span class="keyword">public</span> <a class="code" href="classuvw_1_1Handle.html">Handle</a><TimerHandle, uv_timer_t> {</div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> startCallback(uv_timer_t *handle);</div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  </div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <span class="keyword">using</span> Time = std::chrono::duration<uint64_t, std::milli>;</div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  </div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="keyword">using</span> Handle::Handle;</div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  </div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="classuvw_1_1TimerHandle.html#af810fe73763e651884aa47bd86818dc4"> 37</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classuvw_1_1TimerHandle.html#af810fe73763e651884aa47bd86818dc4">init</a>();</div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  </div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="classuvw_1_1TimerHandle.html#aa3df1b355aaf0f87e13e00037109991d"> 51</a></span>  <span class="keywordtype">void</span> <a class="code" href="classuvw_1_1TimerHandle.html#aa3df1b355aaf0f87e13e00037109991d">start</a>(Time timeout, Time <a class="code" href="classuvw_1_1TimerHandle.html#acfaaf46d6fe0009df9dd45f70abe314f">repeat</a>);</div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  </div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="classuvw_1_1TimerHandle.html#a008fcb3e5212d2bb6649644a8fff78ba"> 56</a></span>  <span class="keywordtype">void</span> <a class="code" href="classuvw_1_1TimerHandle.html#a008fcb3e5212d2bb6649644a8fff78ba">stop</a>();</div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  </div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="classuvw_1_1TimerHandle.html#a5bdda2de41ca55f4a54741c02e53c390"> 65</a></span>  <span class="keywordtype">void</span> <a class="code" href="classuvw_1_1TimerHandle.html#a5bdda2de41ca55f4a54741c02e53c390">again</a>();</div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  </div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"><a class="line" href="classuvw_1_1TimerHandle.html#a1775eedcc2a75f04a5b4bba61584a881"> 85</a></span>  <span class="keywordtype">void</span> <a class="code" href="classuvw_1_1TimerHandle.html#a1775eedcc2a75f04a5b4bba61584a881">repeat</a>(Time <a class="code" href="classuvw_1_1TimerHandle.html#acfaaf46d6fe0009df9dd45f70abe314f">repeat</a>);</div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  </div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"><a class="line" href="classuvw_1_1TimerHandle.html#acfaaf46d6fe0009df9dd45f70abe314f"> 92</a></span>  Time <a class="code" href="classuvw_1_1TimerHandle.html#acfaaf46d6fe0009df9dd45f70abe314f">repeat</a>();</div>
|
|
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  </div>
|
|
<div class="line"><a name="l00101"></a><span class="lineno"><a class="line" href="classuvw_1_1TimerHandle.html#a6917943888bb2e2a18804e537ab841c3"> 101</a></span>  Time <a class="code" href="classuvw_1_1TimerHandle.html#a6917943888bb2e2a18804e537ab841c3">dueIn</a>();</div>
|
|
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> };</div>
|
|
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  </div>
|
|
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> } <span class="comment">// namespace uvw</span></div>
|
|
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  </div>
|
|
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="preprocessor">#ifndef UVW_AS_LIB</span></div>
|
|
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="preprocessor"># include "timer.cpp"</span></div>
|
|
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  </div>
|
|
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="preprocessor">#endif </span><span class="comment">// UVW_TIMER_INCLUDE_H</span></div>
|
|
<div class="ttc" id="aclassuvw_1_1Handle_html"><div class="ttname"><a href="classuvw_1_1Handle.html">uvw::Handle</a></div><div class="ttdoc">Handle base class.</div><div class="ttdef"><b>Definition:</b> <a href="handle_8hpp_source.html#l00026">handle.hpp:26</a></div></div>
|
|
<div class="ttc" id="aclassuvw_1_1TimerHandle_html"><div class="ttname"><a href="classuvw_1_1TimerHandle.html">uvw::TimerHandle</a></div><div class="ttdoc">The TimerHandle handle.</div><div class="ttdef"><b>Definition:</b> <a href="timer_8h_source.html#l00025">timer.h:25</a></div></div>
|
|
<div class="ttc" id="aclassuvw_1_1TimerHandle_html_a008fcb3e5212d2bb6649644a8fff78ba"><div class="ttname"><a href="classuvw_1_1TimerHandle.html#a008fcb3e5212d2bb6649644a8fff78ba">uvw::TimerHandle::stop</a></div><div class="ttdeci">void stop()</div><div class="ttdoc">Stops the handle.</div></div>
|
|
<div class="ttc" id="aclassuvw_1_1TimerHandle_html_a1775eedcc2a75f04a5b4bba61584a881"><div class="ttname"><a href="classuvw_1_1TimerHandle.html#a1775eedcc2a75f04a5b4bba61584a881">uvw::TimerHandle::repeat</a></div><div class="ttdeci">void repeat(Time repeat)</div><div class="ttdoc">Sets the repeat interval value.</div></div>
|
|
<div class="ttc" id="aclassuvw_1_1TimerHandle_html_a5bdda2de41ca55f4a54741c02e53c390"><div class="ttname"><a href="classuvw_1_1TimerHandle.html#a5bdda2de41ca55f4a54741c02e53c390">uvw::TimerHandle::again</a></div><div class="ttdeci">void again()</div><div class="ttdoc">Stops the timer and restarts it if it was repeating.</div></div>
|
|
<div class="ttc" id="aclassuvw_1_1TimerHandle_html_a6917943888bb2e2a18804e537ab841c3"><div class="ttname"><a href="classuvw_1_1TimerHandle.html#a6917943888bb2e2a18804e537ab841c3">uvw::TimerHandle::dueIn</a></div><div class="ttdeci">Time dueIn()</div><div class="ttdoc">Gets the timer due value.</div></div>
|
|
<div class="ttc" id="aclassuvw_1_1TimerHandle_html_aa3df1b355aaf0f87e13e00037109991d"><div class="ttname"><a href="classuvw_1_1TimerHandle.html#aa3df1b355aaf0f87e13e00037109991d">uvw::TimerHandle::start</a></div><div class="ttdeci">void start(Time timeout, Time repeat)</div><div class="ttdoc">Starts the timer.</div></div>
|
|
<div class="ttc" id="aclassuvw_1_1TimerHandle_html_acfaaf46d6fe0009df9dd45f70abe314f"><div class="ttname"><a href="classuvw_1_1TimerHandle.html#acfaaf46d6fe0009df9dd45f70abe314f">uvw::TimerHandle::repeat</a></div><div class="ttdeci">Time repeat()</div><div class="ttdoc">Gets the timer repeat value.</div></div>
|
|
<div class="ttc" id="aclassuvw_1_1TimerHandle_html_af810fe73763e651884aa47bd86818dc4"><div class="ttname"><a href="classuvw_1_1TimerHandle.html#af810fe73763e651884aa47bd86818dc4">uvw::TimerHandle::init</a></div><div class="ttdeci">bool init()</div><div class="ttdoc">Initializes the handle.</div></div>
|
|
<div class="ttc" id="anamespaceuvw_html"><div class="ttname"><a href="namespaceuvw.html">uvw</a></div><div class="ttdoc">uvw default namespace.</div><div class="ttdef"><b>Definition:</b> <a href="async_8h_source.html#l00008">async.h:8</a></div></div>
|
|
<div class="ttc" id="astructuvw_1_1TimerEvent_html"><div class="ttname"><a href="structuvw_1_1TimerEvent.html">uvw::TimerEvent</a></div><div class="ttdoc">TimerEvent event.</div><div class="ttdef"><b>Definition:</b> <a href="timer_8h_source.html#l00016">timer.h:16</a></div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
|
|
</small></address>
|
|
</body>
|
|
</html>
|