barant/ServerCore
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
ServerCore/html/classcore_1_1Timer.html

224 lines
11 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>My Project: core::Timer 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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">My Project
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</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"><b>core</b></li><li class="navelem"><a class="el" href="classcore_1_1Timer.html">Timer</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="classcore_1_1Timer-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">core::Timer Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="Timer_8h_source.html">Timer.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for core::Timer:</div>
<div class="dyncontent">
<div class="center"><img src="classcore_1_1Timer__inherit__graph.png" border="0" usemap="#core_1_1Timer_inherit__map" alt="Inheritance graph"/></div>
<map name="core_1_1Timer_inherit__map" id="core_1_1Timer_inherit__map">
<area shape="rect" id="node2" href="classcore_1_1Socket.html" title="core::Socket" alt="" coords="5,80,101,107"/>
<area shape="rect" id="node3" href="classcore_1_1Object.html" title="core::Object" alt="" coords="7,5,100,32"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for core::Timer:</div>
<div class="dyncontent">
<div class="center"><img src="classcore_1_1Timer__coll__graph.png" border="0" usemap="#core_1_1Timer_coll__map" alt="Collaboration graph"/></div>
<map name="core_1_1Timer_coll__map" id="core_1_1Timer_coll__map">
<area shape="rect" id="node2" href="classcore_1_1Socket.html" title="core::Socket" alt="" coords="9,247,105,273"/>
<area shape="rect" id="node3" href="classcore_1_1Object.html" title="core::Object" alt="" coords="5,5,99,32"/>
<area shape="rect" id="node5" href="classcore_1_1Command.html" title="core::Command" alt="" coords="73,81,188,108"/>
<area shape="rect" id="node4" href="classcore_1_1EPoll.html" title="core::EPoll" alt="" coords="81,157,167,184"/>
</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 name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aa12f319bab9c7a350244c4d47fe59de9"><td class="memItemLeft" align="right" valign="top"><a id="aa12f319bab9c7a350244c4d47fe59de9"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>Timer</b> (<a class="el" href="classcore_1_1EPoll.html">EPoll</a> &amp;ePoll)</td></tr>
<tr class="separator:aa12f319bab9c7a350244c4d47fe59de9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6ba8de81f8e3b26fd132e29230646024"><td class="memItemLeft" align="right" valign="top"><a id="a6ba8de81f8e3b26fd132e29230646024"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>Timer</b> (<a class="el" href="classcore_1_1EPoll.html">EPoll</a> &amp;ePoll, double delay)</td></tr>
<tr class="separator:a6ba8de81f8e3b26fd132e29230646024"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac0a642cdcb76b7f995137162050d3d0b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1Timer.html#ac0a642cdcb76b7f995137162050d3d0b">setTimer</a> (double delay)</td></tr>
<tr class="separator:ac0a642cdcb76b7f995137162050d3d0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8e063f46e89dac04364871e909ab940a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1Timer.html#a8e063f46e89dac04364871e909ab940a">clearTimer</a> ()</td></tr>
<tr class="separator:a8e063f46e89dac04364871e909ab940a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0df7f1ffc05529b45d6e13713bbc0209"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1Timer.html#a0df7f1ffc05529b45d6e13713bbc0209">getElapsed</a> ()</td></tr>
<tr class="separator:a0df7f1ffc05529b45d6e13713bbc0209"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afee1c871ce74e6b594bd6e64ad3cb576"><td class="memItemLeft" align="right" valign="top"><a id="afee1c871ce74e6b594bd6e64ad3cb576"></a>
double&#160;</td><td class="memItemRight" valign="bottom"><b>getEpoch</b> ()</td></tr>
<tr class="separator:afee1c871ce74e6b594bd6e64ad3cb576"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:ae51704ff08d985bbc30e3ff4c9b3c6ca"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1Timer.html#ae51704ff08d985bbc30e3ff4c9b3c6ca">onTimeout</a> ()=0</td></tr>
<tr class="separator:ae51704ff08d985bbc30e3ff4c9b3c6ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classcore_1_1Timer.html">Timer</a></p>
<p>Set and trigger callback upon specified timeout.</p>
<p>The <a class="el" href="classcore_1_1Timer.html">Timer</a> is used to establish a timer using the timer socket interface. It cannot be instantiated directly but must be extended. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a8e063f46e89dac04364871e909ab940a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8e063f46e89dac04364871e909ab940a">&#9670;&nbsp;</a></span>clearTimer()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void core::Timer::clearTimer </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Use the <a class="el" href="classcore_1_1Timer.html#a8e063f46e89dac04364871e909ab940a">clearTimer()</a> to unset the timer and return the timer to an idle state. </p>
</div>
</div>
<a id="a0df7f1ffc05529b45d6e13713bbc0209"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0df7f1ffc05529b45d6e13713bbc0209">&#9670;&nbsp;</a></span>getElapsed()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double core::Timer::getElapsed </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Use the <a class="el" href="classcore_1_1Timer.html#a0df7f1ffc05529b45d6e13713bbc0209">getElapsed()</a> method to obtain the amount of time that has elapsed since the timer was set. </p>
</div>
</div>
<a id="ae51704ff08d985bbc30e3ff4c9b3c6ca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae51704ff08d985bbc30e3ff4c9b3c6ca">&#9670;&nbsp;</a></span>onTimeout()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void core::Timer::onTimeout </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This method is called when the time out occurs. </p>
</div>
</div>
<a id="ac0a642cdcb76b7f995137162050d3d0b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac0a642cdcb76b7f995137162050d3d0b">&#9670;&nbsp;</a></span>setTimer()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void core::Timer::setTimer </td>
<td>(</td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>delay</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Use the <a class="el" href="classcore_1_1Timer.html#ac0a642cdcb76b7f995137162050d3d0b">setTimer()</a> method to set the time out value for timer. Setting the timer also starts the timer countdown. The <a class="el" href="classcore_1_1Timer.html#a8e063f46e89dac04364871e909ab940a">clearTimer()</a> method can be used to reset the timer without triggering the <a class="el" href="classcore_1_1Timer.html#ae51704ff08d985bbc30e3ff4c9b3c6ca">onTimeout()</a> callback.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">delay</td><td>the amount of time in seconds to wait before trigering the onTimeout function. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="Timer_8h_source.html">Timer.h</a></li>
<li>Timer.cpp</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink