139 lines
13 KiB
HTML
139 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" 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.6"/>
|
|
<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 id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">uvw<span id="projectnumber"> 3.1.0</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.6 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&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&dn=expat.txt MIT */
|
|
$(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">
|
|
<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_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 id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#ifndef UVW_TIMER_INCLUDE_H</span></div>
|
|
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define UVW_TIMER_INCLUDE_H</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="preprocessor">#include <cstdint></span></div>
|
|
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include <chrono></span></div>
|
|
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include <uv.h></span></div>
|
|
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include "handle.hpp"</span></div>
|
|
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include "loop.h"</span></div>
|
|
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> </div>
|
|
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceuvw.html">uvw</a> {</div>
|
|
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> </div>
|
|
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"><a class="line" href="structuvw_1_1timer__event.html"> 13</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structuvw_1_1timer__event.html">timer_event</a> {};</div>
|
|
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> </div>
|
|
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"><a class="line" href="classuvw_1_1timer__handle.html"> 22</a></span><span class="keyword">class </span><a class="code hl_class" href="classuvw_1_1timer__handle.html">timer_handle</a> final: <span class="keyword">public</span> <a class="code hl_class" href="classuvw_1_1handle.html">handle</a><timer_handle, uv_timer_t, timer_event> {</div>
|
|
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">static</span> <span class="keywordtype">void</span> start_callback(uv_timer_t *hndl);</div>
|
|
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div>
|
|
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="keyword">public</span>:</div>
|
|
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> <span class="keyword">using </span>time = std::chrono::duration<uint64_t, std::milli>;</div>
|
|
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div>
|
|
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">using </span>handle::handle;</div>
|
|
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div>
|
|
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"><a class="line" href="classuvw_1_1timer__handle.html#a7c677b3ac518468618c66be6924772c6"> 34</a></span> <span class="keywordtype">int</span> <a class="code hl_function" href="classuvw_1_1timer__handle.html#a7c677b3ac518468618c66be6924772c6">init</a>() final;</div>
|
|
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> </div>
|
|
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"><a class="line" href="classuvw_1_1timer__handle.html#aff8e19bf0e47f35c25021d01f6820aef"> 50</a></span> <span class="keywordtype">int</span> <a class="code hl_function" href="classuvw_1_1timer__handle.html#aff8e19bf0e47f35c25021d01f6820aef">start</a>(time timeout, time <a class="code hl_function" href="classuvw_1_1timer__handle.html#ae4ddef86d79cc245965af82adefcf980">repeat</a>);</div>
|
|
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> </div>
|
|
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"><a class="line" href="classuvw_1_1timer__handle.html#a1550de6938831bc02fa808b25ba746e6"> 56</a></span> <span class="keywordtype">int</span> <a class="code hl_function" href="classuvw_1_1timer__handle.html#a1550de6938831bc02fa808b25ba746e6">stop</a>();</div>
|
|
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> </div>
|
|
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"><a class="line" href="classuvw_1_1timer__handle.html#aa14ebfef0c7ba9f5a26d837b1c118ff0"> 66</a></span> <span class="keywordtype">int</span> <a class="code hl_function" href="classuvw_1_1timer__handle.html#aa14ebfef0c7ba9f5a26d837b1c118ff0">again</a>();</div>
|
|
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> </div>
|
|
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"><a class="line" href="classuvw_1_1timer__handle.html#a0f1c0d66f9960445c7c4a97ea1f3cb04"> 86</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="classuvw_1_1timer__handle.html#ae4ddef86d79cc245965af82adefcf980">repeat</a>(time <a class="code hl_function" href="classuvw_1_1timer__handle.html#ae4ddef86d79cc245965af82adefcf980">repeat</a>);</div>
|
|
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> </div>
|
|
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"><a class="line" href="classuvw_1_1timer__handle.html#ae4ddef86d79cc245965af82adefcf980"> 93</a></span> time <a class="code hl_function" href="classuvw_1_1timer__handle.html#ae4ddef86d79cc245965af82adefcf980">repeat</a>();</div>
|
|
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> </div>
|
|
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"><a class="line" href="classuvw_1_1timer__handle.html#ac80f47c827c13e8bdeaf6ee9fd73c38e"> 102</a></span> time <a class="code hl_function" href="classuvw_1_1timer__handle.html#ac80f47c827c13e8bdeaf6ee9fd73c38e">due_in</a>();</div>
|
|
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span>};</div>
|
|
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> </div>
|
|
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span>} <span class="comment">// namespace uvw</span></div>
|
|
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> </div>
|
|
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span><span class="preprocessor">#ifndef UVW_AS_LIB</span></div>
|
|
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span><span class="preprocessor"># include "timer.cpp"</span></div>
|
|
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span><span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span> </div>
|
|
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</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#l00023">handle.hpp:23</a></div></div>
|
|
<div class="ttc" id="aclassuvw_1_1timer__handle_html"><div class="ttname"><a href="classuvw_1_1timer__handle.html">uvw::timer_handle</a></div><div class="ttdoc">The timer handle.</div><div class="ttdef"><b>Definition:</b> <a href="timer_8h_source.html#l00022">timer.h:22</a></div></div>
|
|
<div class="ttc" id="aclassuvw_1_1timer__handle_html_a1550de6938831bc02fa808b25ba746e6"><div class="ttname"><a href="classuvw_1_1timer__handle.html#a1550de6938831bc02fa808b25ba746e6">uvw::timer_handle::stop</a></div><div class="ttdeci">int stop()</div><div class="ttdoc">Stops the handle.</div></div>
|
|
<div class="ttc" id="aclassuvw_1_1timer__handle_html_a7c677b3ac518468618c66be6924772c6"><div class="ttname"><a href="classuvw_1_1timer__handle.html#a7c677b3ac518468618c66be6924772c6">uvw::timer_handle::init</a></div><div class="ttdeci">int init() final</div><div class="ttdoc">Initializes the handle.</div></div>
|
|
<div class="ttc" id="aclassuvw_1_1timer__handle_html_aa14ebfef0c7ba9f5a26d837b1c118ff0"><div class="ttname"><a href="classuvw_1_1timer__handle.html#aa14ebfef0c7ba9f5a26d837b1c118ff0">uvw::timer_handle::again</a></div><div class="ttdeci">int again()</div><div class="ttdoc">Stops the timer and restarts it if it was repeating.</div></div>
|
|
<div class="ttc" id="aclassuvw_1_1timer__handle_html_ac80f47c827c13e8bdeaf6ee9fd73c38e"><div class="ttname"><a href="classuvw_1_1timer__handle.html#ac80f47c827c13e8bdeaf6ee9fd73c38e">uvw::timer_handle::due_in</a></div><div class="ttdeci">time due_in()</div><div class="ttdoc">Gets the timer due value.</div></div>
|
|
<div class="ttc" id="aclassuvw_1_1timer__handle_html_ae4ddef86d79cc245965af82adefcf980"><div class="ttname"><a href="classuvw_1_1timer__handle.html#ae4ddef86d79cc245965af82adefcf980">uvw::timer_handle::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_1timer__handle_html_aff8e19bf0e47f35c25021d01f6820aef"><div class="ttname"><a href="classuvw_1_1timer__handle.html#aff8e19bf0e47f35c25021d01f6820aef">uvw::timer_handle::start</a></div><div class="ttdeci">int start(time timeout, time repeat)</div><div class="ttdoc">Starts the timer.</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_1timer__event_html"><div class="ttname"><a href="structuvw_1_1timer__event.html">uvw::timer_event</a></div><div class="ttdoc">Timer event.</div><div class="ttdef"><b>Definition:</b> <a href="timer_8h_source.html#l00013">timer.h:13</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.6
|
|
</small></address>
|
|
</body>
|
|
</html>
|