412 lines
35 KiB
HTML
412 lines
35 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: uvw::timer_handle 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 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="namespaceuvw.html">uvw</a></li><li class="navelem"><a class="el" href="classuvw_1_1timer__handle.html">timer_handle</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="classuvw_1_1timer__handle-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">uvw::timer_handle Class Reference<span class="mlabels"><span class="mlabel">final</span></span></div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>The timer handle.
|
|
<a href="classuvw_1_1timer__handle.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="timer_8h_source.html">timer.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for uvw::timer_handle:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classuvw_1_1timer__handle__inherit__graph.png" border="0" usemap="#auvw_1_1timer__handle_inherit__map" alt="Inheritance graph"/></div>
|
|
<map name="auvw_1_1timer__handle_inherit__map" id="auvw_1_1timer__handle_inherit__map">
|
|
<area shape="rect" title="The timer handle." alt="" coords="88,255,213,280"/>
|
|
<area shape="rect" href="classuvw_1_1handle.html" title=" " alt="" coords="81,152,220,207"/>
|
|
<area shape="rect" href="classuvw_1_1resource.html" title="Common class for almost all the resources available in uvw." alt="" coords="67,79,234,104"/>
|
|
<area shape="rect" href="structuvw_1_1uv__type.html" title="Wrapper class for underlying types." alt="" coords="5,5,133,31"/>
|
|
<area shape="rect" href="classuvw_1_1emitter.html" title=" " alt="" coords="158,5,309,31"/>
|
|
</map>
|
|
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
|
|
<div class="dynheader">
|
|
Collaboration diagram for uvw::timer_handle:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classuvw_1_1timer__handle__coll__graph.png" border="0" usemap="#auvw_1_1timer__handle_coll__map" alt="Collaboration graph"/></div>
|
|
<map name="auvw_1_1timer__handle_coll__map" id="auvw_1_1timer__handle_coll__map">
|
|
<area shape="rect" title="The timer handle." alt="" coords="88,255,213,280"/>
|
|
<area shape="rect" href="classuvw_1_1handle.html" title=" " alt="" coords="81,152,220,207"/>
|
|
<area shape="rect" href="classuvw_1_1resource.html" title="Common class for almost all the resources available in uvw." alt="" coords="67,79,234,104"/>
|
|
<area shape="rect" href="structuvw_1_1uv__type.html" title="Wrapper class for underlying types." alt="" coords="5,5,133,31"/>
|
|
<area shape="rect" href="classuvw_1_1emitter.html" title=" " alt="" coords="158,5,309,31"/>
|
|
</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 id="pub-methods" name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a7c677b3ac518468618c66be6924772c6"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1timer__handle.html#a7c677b3ac518468618c66be6924772c6">init</a> () final</td></tr>
|
|
<tr class="memdesc:a7c677b3ac518468618c66be6924772c6"><td class="mdescLeft"> </td><td class="mdescRight">Initializes the handle. <br /></td></tr>
|
|
<tr class="separator:a7c677b3ac518468618c66be6924772c6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aff8e19bf0e47f35c25021d01f6820aef"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1timer__handle.html#aff8e19bf0e47f35c25021d01f6820aef">start</a> (time timeout, time <a class="el" href="classuvw_1_1timer__handle.html#a0f1c0d66f9960445c7c4a97ea1f3cb04">repeat</a>)</td></tr>
|
|
<tr class="memdesc:aff8e19bf0e47f35c25021d01f6820aef"><td class="mdescLeft"> </td><td class="mdescRight">Starts the timer. <br /></td></tr>
|
|
<tr class="separator:aff8e19bf0e47f35c25021d01f6820aef"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1550de6938831bc02fa808b25ba746e6"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1timer__handle.html#a1550de6938831bc02fa808b25ba746e6">stop</a> ()</td></tr>
|
|
<tr class="memdesc:a1550de6938831bc02fa808b25ba746e6"><td class="mdescLeft"> </td><td class="mdescRight">Stops the handle. <br /></td></tr>
|
|
<tr class="separator:a1550de6938831bc02fa808b25ba746e6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa14ebfef0c7ba9f5a26d837b1c118ff0"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1timer__handle.html#aa14ebfef0c7ba9f5a26d837b1c118ff0">again</a> ()</td></tr>
|
|
<tr class="memdesc:aa14ebfef0c7ba9f5a26d837b1c118ff0"><td class="mdescLeft"> </td><td class="mdescRight">Stops the timer and restarts it if it was repeating. <br /></td></tr>
|
|
<tr class="separator:aa14ebfef0c7ba9f5a26d837b1c118ff0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0f1c0d66f9960445c7c4a97ea1f3cb04"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1timer__handle.html#a0f1c0d66f9960445c7c4a97ea1f3cb04">repeat</a> (time repeat)</td></tr>
|
|
<tr class="memdesc:a0f1c0d66f9960445c7c4a97ea1f3cb04"><td class="mdescLeft"> </td><td class="mdescRight">Sets the repeat interval value. <br /></td></tr>
|
|
<tr class="separator:a0f1c0d66f9960445c7c4a97ea1f3cb04"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae4ddef86d79cc245965af82adefcf980"><td class="memItemLeft" align="right" valign="top">time </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1timer__handle.html#ae4ddef86d79cc245965af82adefcf980">repeat</a> ()</td></tr>
|
|
<tr class="memdesc:ae4ddef86d79cc245965af82adefcf980"><td class="mdescLeft"> </td><td class="mdescRight">Gets the timer repeat value. <br /></td></tr>
|
|
<tr class="separator:ae4ddef86d79cc245965af82adefcf980"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac80f47c827c13e8bdeaf6ee9fd73c38e"><td class="memItemLeft" align="right" valign="top">time </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1timer__handle.html#ac80f47c827c13e8bdeaf6ee9fd73c38e">due_in</a> ()</td></tr>
|
|
<tr class="memdesc:ac80f47c827c13e8bdeaf6ee9fd73c38e"><td class="mdescLeft"> </td><td class="mdescRight">Gets the timer due value. <br /></td></tr>
|
|
<tr class="separator:ac80f47c827c13e8bdeaf6ee9fd73c38e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_classuvw_1_1handle"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classuvw_1_1handle')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classuvw_1_1handle.html">uvw::handle< timer_handle, uv_timer_t, timer_event ></a></td></tr>
|
|
<tr class="memitem:a80c5ba8c4db128cc525406e998549b96 inherit pub_methods_classuvw_1_1handle"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceuvw.html#a9e28e1855691dd1af105626ed11f3ac4">handle_category</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1handle.html#a80c5ba8c4db128cc525406e998549b96">category</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a80c5ba8c4db128cc525406e998549b96 inherit pub_methods_classuvw_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Gets the category of the handle. <br /></td></tr>
|
|
<tr class="separator:a80c5ba8c4db128cc525406e998549b96 inherit pub_methods_classuvw_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a88018be1fa3105e958c50a9f1881baa9 inherit pub_methods_classuvw_1_1handle"><td class="memItemLeft" align="right" valign="top">handle_type </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1handle.html#a88018be1fa3105e958c50a9f1881baa9">type</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a88018be1fa3105e958c50a9f1881baa9 inherit pub_methods_classuvw_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Gets the type of the handle. <br /></td></tr>
|
|
<tr class="separator:a88018be1fa3105e958c50a9f1881baa9 inherit pub_methods_classuvw_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a938d3ac6e5cc78f9442f9bb851170643 inherit pub_methods_classuvw_1_1handle"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1handle.html#a938d3ac6e5cc78f9442f9bb851170643">active</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a938d3ac6e5cc78f9442f9bb851170643 inherit pub_methods_classuvw_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Checks if the handle is active. <br /></td></tr>
|
|
<tr class="separator:a938d3ac6e5cc78f9442f9bb851170643 inherit pub_methods_classuvw_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae93cbf2156f0d673093e48832104a3cc inherit pub_methods_classuvw_1_1handle"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1handle.html#ae93cbf2156f0d673093e48832104a3cc">closing</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:ae93cbf2156f0d673093e48832104a3cc inherit pub_methods_classuvw_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Checks if a handle is closing or closed. <br /></td></tr>
|
|
<tr class="separator:ae93cbf2156f0d673093e48832104a3cc inherit pub_methods_classuvw_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3648ed9805e8d0e8963f137f8584e483 inherit pub_methods_classuvw_1_1handle"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1handle.html#a3648ed9805e8d0e8963f137f8584e483">close</a> () noexcept</td></tr>
|
|
<tr class="memdesc:a3648ed9805e8d0e8963f137f8584e483 inherit pub_methods_classuvw_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Request handle to be closed. <br /></td></tr>
|
|
<tr class="separator:a3648ed9805e8d0e8963f137f8584e483 inherit pub_methods_classuvw_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2f0d788997368ab1af2dc475126a46d2 inherit pub_methods_classuvw_1_1handle"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1handle.html#a2f0d788997368ab1af2dc475126a46d2">reference</a> () noexcept</td></tr>
|
|
<tr class="memdesc:a2f0d788997368ab1af2dc475126a46d2 inherit pub_methods_classuvw_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Reference the given handle. <br /></td></tr>
|
|
<tr class="separator:a2f0d788997368ab1af2dc475126a46d2 inherit pub_methods_classuvw_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a83a91d1353c19f1a05aace78dc2cc453 inherit pub_methods_classuvw_1_1handle"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1handle.html#a83a91d1353c19f1a05aace78dc2cc453">unreference</a> () noexcept</td></tr>
|
|
<tr class="memdesc:a83a91d1353c19f1a05aace78dc2cc453 inherit pub_methods_classuvw_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Unreference the given handle. <br /></td></tr>
|
|
<tr class="separator:a83a91d1353c19f1a05aace78dc2cc453 inherit pub_methods_classuvw_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1403f961ab40063f79c4a293c78ed63c inherit pub_methods_classuvw_1_1handle"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1handle.html#a1403f961ab40063f79c4a293c78ed63c">referenced</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a1403f961ab40063f79c4a293c78ed63c inherit pub_methods_classuvw_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Checks if the given handle referenced. <br /></td></tr>
|
|
<tr class="separator:a1403f961ab40063f79c4a293c78ed63c inherit pub_methods_classuvw_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5852080ba1fd71a302c2424cf2df9a27 inherit pub_methods_classuvw_1_1handle"><td class="memItemLeft" align="right" valign="top">std::size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1handle.html#a5852080ba1fd71a302c2424cf2df9a27">size</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a5852080ba1fd71a302c2424cf2df9a27 inherit pub_methods_classuvw_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Returns the size of the underlying handle type. <br /></td></tr>
|
|
<tr class="separator:a5852080ba1fd71a302c2424cf2df9a27 inherit pub_methods_classuvw_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa99406ca909aeaac17522959db8c71a4 inherit pub_methods_classuvw_1_1handle"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1handle.html#aa99406ca909aeaac17522959db8c71a4">send_buffer_size</a> ()</td></tr>
|
|
<tr class="memdesc:aa99406ca909aeaac17522959db8c71a4 inherit pub_methods_classuvw_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Gets the size of the send buffer used for the socket. <br /></td></tr>
|
|
<tr class="separator:aa99406ca909aeaac17522959db8c71a4 inherit pub_methods_classuvw_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a917ab9c1f011232b50f9980f29167ee2 inherit pub_methods_classuvw_1_1handle"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1handle.html#a917ab9c1f011232b50f9980f29167ee2">send_buffer_size</a> (int value)</td></tr>
|
|
<tr class="memdesc:a917ab9c1f011232b50f9980f29167ee2 inherit pub_methods_classuvw_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Sets the size of the send buffer used for the socket. <br /></td></tr>
|
|
<tr class="separator:a917ab9c1f011232b50f9980f29167ee2 inherit pub_methods_classuvw_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7a3337ef0c68ed5ba0e9bea0e2e90539 inherit pub_methods_classuvw_1_1handle"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1handle.html#a7a3337ef0c68ed5ba0e9bea0e2e90539">recv_buffer_size</a> ()</td></tr>
|
|
<tr class="memdesc:a7a3337ef0c68ed5ba0e9bea0e2e90539 inherit pub_methods_classuvw_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Gets the size of the receive buffer used for the socket. <br /></td></tr>
|
|
<tr class="separator:a7a3337ef0c68ed5ba0e9bea0e2e90539 inherit pub_methods_classuvw_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ace23bb725f6f80ae7a611f5228ad9f8d inherit pub_methods_classuvw_1_1handle"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1handle.html#ace23bb725f6f80ae7a611f5228ad9f8d">recv_buffer_size</a> (int value)</td></tr>
|
|
<tr class="memdesc:ace23bb725f6f80ae7a611f5228ad9f8d inherit pub_methods_classuvw_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Sets the size of the receive buffer used for the socket. <br /></td></tr>
|
|
<tr class="separator:ace23bb725f6f80ae7a611f5228ad9f8d inherit pub_methods_classuvw_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0ce9568c94aa0122ff4cee6a57b4fae5 inherit pub_methods_classuvw_1_1handle"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceuvw.html#a1a4f79e341b89257a11403ee0739f2b4">os_file_descriptor</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1handle.html#a0ce9568c94aa0122ff4cee6a57b4fae5">fd</a> () const</td></tr>
|
|
<tr class="memdesc:a0ce9568c94aa0122ff4cee6a57b4fae5 inherit pub_methods_classuvw_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Gets the platform dependent file descriptor equivalent. <br /></td></tr>
|
|
<tr class="separator:a0ce9568c94aa0122ff4cee6a57b4fae5 inherit pub_methods_classuvw_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_classuvw_1_1resource"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classuvw_1_1resource')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classuvw_1_1resource.html">uvw::resource< T, U, E ></a></td></tr>
|
|
<tr class="memitem:a7c05e988ebaa14d1dbbc781951dc3a88 inherit pub_methods_classuvw_1_1resource"><td class="memTemplParams" colspan="2">template<typename R = void> </td></tr>
|
|
<tr class="memitem:a7c05e988ebaa14d1dbbc781951dc3a88 inherit pub_methods_classuvw_1_1resource"><td class="memTemplItemLeft" align="right" valign="top">std::shared_ptr< R > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classuvw_1_1resource.html#a7c05e988ebaa14d1dbbc781951dc3a88">data</a> () const</td></tr>
|
|
<tr class="memdesc:a7c05e988ebaa14d1dbbc781951dc3a88 inherit pub_methods_classuvw_1_1resource"><td class="mdescLeft"> </td><td class="mdescRight">Gets user-defined data. <code>uvw</code> won't use this field in any case. <br /></td></tr>
|
|
<tr class="separator:a7c05e988ebaa14d1dbbc781951dc3a88 inherit pub_methods_classuvw_1_1resource"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a759079eb405e5d2fda795d199d8efa80 inherit pub_methods_classuvw_1_1resource"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1resource.html#a759079eb405e5d2fda795d199d8efa80">data</a> (std::shared_ptr< void > udata)</td></tr>
|
|
<tr class="memdesc:a759079eb405e5d2fda795d199d8efa80 inherit pub_methods_classuvw_1_1resource"><td class="mdescLeft"> </td><td class="mdescRight">Sets arbitrary data. <code>uvw</code> won't use this field in any case. <br /></td></tr>
|
|
<tr class="separator:a759079eb405e5d2fda795d199d8efa80 inherit pub_methods_classuvw_1_1resource"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_structuvw_1_1uv__type"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_structuvw_1_1uv__type')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="structuvw_1_1uv__type.html">uvw::uv_type< U ></a></td></tr>
|
|
<tr class="memitem:ae97ffacc0b381610d8d18a62a957a69c inherit pub_methods_structuvw_1_1uv__type"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1uv__type.html#ae97ffacc0b381610d8d18a62a957a69c">init</a> ()</td></tr>
|
|
<tr class="memdesc:ae97ffacc0b381610d8d18a62a957a69c inherit pub_methods_structuvw_1_1uv__type"><td class="mdescLeft"> </td><td class="mdescRight">Initializes the handle. <br /></td></tr>
|
|
<tr class="separator:ae97ffacc0b381610d8d18a62a957a69c inherit pub_methods_structuvw_1_1uv__type"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae03b0ebbae151c6157c5ba6a24a39a7b inherit pub_methods_structuvw_1_1uv__type"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classuvw_1_1loop.html">loop</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1uv__type.html#ae03b0ebbae151c6157c5ba6a24a39a7b">parent</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:ae03b0ebbae151c6157c5ba6a24a39a7b inherit pub_methods_structuvw_1_1uv__type"><td class="mdescLeft"> </td><td class="mdescRight">Gets the loop from which the resource was originated. <br /></td></tr>
|
|
<tr class="separator:ae03b0ebbae151c6157c5ba6a24a39a7b inherit pub_methods_structuvw_1_1uv__type"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a06a6cb7ebde27aa348e340b76e49c6ae inherit pub_methods_structuvw_1_1uv__type"><td class="memItemLeft" align="right" valign="top">const U * </td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1uv__type.html#a06a6cb7ebde27aa348e340b76e49c6ae">raw</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a06a6cb7ebde27aa348e340b76e49c6ae inherit pub_methods_structuvw_1_1uv__type"><td class="mdescLeft"> </td><td class="mdescRight">Gets the underlying raw data structure. <br /></td></tr>
|
|
<tr class="separator:a06a6cb7ebde27aa348e340b76e49c6ae inherit pub_methods_structuvw_1_1uv__type"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af4b6f395815f2e99302b5f09be23767c inherit pub_methods_structuvw_1_1uv__type"><td class="memItemLeft" align="right" valign="top">U * </td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1uv__type.html#af4b6f395815f2e99302b5f09be23767c">raw</a> () noexcept</td></tr>
|
|
<tr class="memdesc:af4b6f395815f2e99302b5f09be23767c inherit pub_methods_structuvw_1_1uv__type"><td class="mdescLeft"> </td><td class="mdescRight">Gets the underlying raw data structure. <br /></td></tr>
|
|
<tr class="separator:af4b6f395815f2e99302b5f09be23767c inherit pub_methods_structuvw_1_1uv__type"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_classuvw_1_1emitter"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classuvw_1_1emitter')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classuvw_1_1emitter.html">uvw::emitter< T, E... ></a></td></tr>
|
|
<tr class="memitem:ab913fa1c005a33c73b2eb2b0d1051b1f inherit pub_methods_classuvw_1_1emitter"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1emitter.html#ab913fa1c005a33c73b2eb2b0d1051b1f">on</a> (listener_t< U > f)</td></tr>
|
|
<tr class="memdesc:ab913fa1c005a33c73b2eb2b0d1051b1f inherit pub_methods_classuvw_1_1emitter"><td class="mdescLeft"> </td><td class="mdescRight">Registers a long-lived listener with the event emitter. <br /></td></tr>
|
|
<tr class="separator:ab913fa1c005a33c73b2eb2b0d1051b1f inherit pub_methods_classuvw_1_1emitter"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:accff5c096692f5eebbe941189644e69d inherit pub_methods_classuvw_1_1emitter"><td class="memItemLeft" align="right" valign="top"><a id="accff5c096692f5eebbe941189644e69d" name="accff5c096692f5eebbe941189644e69d"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>reset</b> () noexcept</td></tr>
|
|
<tr class="memdesc:accff5c096692f5eebbe941189644e69d inherit pub_methods_classuvw_1_1emitter"><td class="mdescLeft"> </td><td class="mdescRight">Disconnects the listener for the given event type. <br /></td></tr>
|
|
<tr class="separator:accff5c096692f5eebbe941189644e69d inherit pub_methods_classuvw_1_1emitter"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa71435e74e775cfa7012fe2e52ca5193 inherit pub_methods_classuvw_1_1emitter"><td class="memItemLeft" align="right" valign="top"><a id="aa71435e74e775cfa7012fe2e52ca5193" name="aa71435e74e775cfa7012fe2e52ca5193"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>reset</b> () noexcept</td></tr>
|
|
<tr class="memdesc:aa71435e74e775cfa7012fe2e52ca5193 inherit pub_methods_classuvw_1_1emitter"><td class="mdescLeft"> </td><td class="mdescRight">Disconnects all listeners. <br /></td></tr>
|
|
<tr class="separator:aa71435e74e775cfa7012fe2e52ca5193 inherit pub_methods_classuvw_1_1emitter"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac02a29fe156faba7571b50450fc4f780 inherit pub_methods_classuvw_1_1emitter"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1emitter.html#ac02a29fe156faba7571b50450fc4f780">has</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:ac02a29fe156faba7571b50450fc4f780 inherit pub_methods_classuvw_1_1emitter"><td class="mdescLeft"> </td><td class="mdescRight">Checks if there is a listener registered for the specific event. <br /></td></tr>
|
|
<tr class="separator:ac02a29fe156faba7571b50450fc4f780 inherit pub_methods_classuvw_1_1emitter"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>The timer handle. </p>
|
|
<p>Timer handles are used to schedule events to be emitted in the future.</p>
|
|
<p>To create a <code><a class="el" href="classuvw_1_1timer__handle.html" title="The timer handle.">timer_handle</a></code> through a <code>loop</code>, no arguments are required. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="timer_8h_source.html#l00022">22</a> of file <a class="el" href="timer_8h_source.html">timer.h</a>.</p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="aa14ebfef0c7ba9f5a26d837b1c118ff0" name="aa14ebfef0c7ba9f5a26d837b1c118ff0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa14ebfef0c7ba9f5a26d837b1c118ff0">◆ </a></span>again()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int uvw::timer_handle::again </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Stops the timer and restarts it if it was repeating. </p>
|
|
<p>Stop the timer, and if it is repeating restart it using the repeat value as the timeout.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Underlying return value. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac80f47c827c13e8bdeaf6ee9fd73c38e" name="ac80f47c827c13e8bdeaf6ee9fd73c38e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac80f47c827c13e8bdeaf6ee9fd73c38e">◆ </a></span>due_in()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">time uvw::timer_handle::due_in </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the timer due value. </p>
|
|
<p>The time is relative to <code><a class="el" href="classuvw_1_1loop.html#ab48abde5d862db1a856900b08ecc02dd" title="Returns the current timestamp in milliseconds.">loop::now()</a></code>.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The timer due value or 0 if it has expired. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7c677b3ac518468618c66be6924772c6" name="a7c677b3ac518468618c66be6924772c6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7c677b3ac518468618c66be6924772c6">◆ </a></span>init()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int uvw::timer_handle::init </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">final</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Initializes the handle. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Underlying return value. </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="structuvw_1_1uv__type.html#ae97ffacc0b381610d8d18a62a957a69c">uvw::uv_type< U ></a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae4ddef86d79cc245965af82adefcf980" name="ae4ddef86d79cc245965af82adefcf980"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae4ddef86d79cc245965af82adefcf980">◆ </a></span>repeat() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">time uvw::timer_handle::repeat </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the timer repeat value. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Timer repeat value in milliseconds (as a <code>std::chrono::duration<uint64_t, std::milli></code>). </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0f1c0d66f9960445c7c4a97ea1f3cb04" name="a0f1c0d66f9960445c7c4a97ea1f3cb04"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0f1c0d66f9960445c7c4a97ea1f3cb04">◆ </a></span>repeat() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void uvw::timer_handle::repeat </td>
|
|
<td>(</td>
|
|
<td class="paramtype">time </td>
|
|
<td class="paramname"><em>repeat</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the repeat interval value. </p>
|
|
<p>The timer will be scheduled to run on the given interval and will follow normal timer semantics in the case of a time-slice overrun.<br />
|
|
For example, if a 50ms repeating timer first runs for 17ms, it will be scheduled to run again 33ms later. If other tasks consume more than the 33ms following the first timer event, then another event will be emitted as soon as possible.</p>
|
|
<p>If the repeat value is set from a listener bound to an event, it does not immediately take effect. If the timer was non-repeating before, it will have been stopped. If it was repeating, then the old repeat value will have been used to schedule the next timeout.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">repeat</td><td>Repeat interval in milliseconds (use <code>std::chrono::duration<uint64_t, std::milli></code>). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aff8e19bf0e47f35c25021d01f6820aef" name="aff8e19bf0e47f35c25021d01f6820aef"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aff8e19bf0e47f35c25021d01f6820aef">◆ </a></span>start()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int uvw::timer_handle::start </td>
|
|
<td>(</td>
|
|
<td class="paramtype">time </td>
|
|
<td class="paramname"><em>timeout</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">time </td>
|
|
<td class="paramname"><em>repeat</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Starts the timer. </p>
|
|
<p>If timeout is zero, a timer event is emitted on the next event loop iteration. If repeat is non-zero, a timer event is emitted first after timeout milliseconds and then repeatedly after repeat milliseconds.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">timeout</td><td>Milliseconds before to emit an event (use <code>std::chrono::duration<uint64_t, std::milli></code>). </td></tr>
|
|
<tr><td class="paramname">repeat</td><td>Milliseconds between successive events (use <code>std::chrono::duration<uint64_t, std::milli></code>).</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Underlying return value. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1550de6938831bc02fa808b25ba746e6" name="a1550de6938831bc02fa808b25ba746e6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1550de6938831bc02fa808b25ba746e6">◆ </a></span>stop()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int uvw::timer_handle::stop </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Stops the handle. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Underlying return value. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>src/uvw/<a class="el" href="timer_8h_source.html">timer.h</a></li>
|
|
</ul>
|
|
</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>
|