mirror of
https://salsa.debian.org/gnuk-team/gnuk/gnuk.git
synced 2024-09-21 11:20:08 +00:00
177 lines
8.4 KiB
HTML
177 lines
8.4 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
|
|
<title>ChibiOS/RT: Periodic Events Timer</title>
|
|
<link href="custom.css" rel="stylesheet" type="text/css">
|
|
<link href="tabs.css" rel="stylesheet" type="text/css">
|
|
</head><body>
|
|
<table style="text-align: center; width: 100%;" border="0"
|
|
cellpadding="2" cellspacing="2">
|
|
<tbody>
|
|
<tr>
|
|
<td style="width: 80px;"><img alt="ChibiOS/RT Logo" src="logo_small.png"></td>
|
|
<td><big><big>ChibiOS/RT</big></big><br><br>Architecture - Reference Manual - Guides</td>
|
|
<td style="width: 80px;"></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<hr size="1">
|
|
<!-- Generated by Doxygen 1.7.1 -->
|
|
<div class="navigation" id="top">
|
|
<div class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="main.html"><span>Main Page</span></a></li>
|
|
<li><a href="modules.html"><span>Modules</span></a></li>
|
|
<li><a href="annotated.html"><span>Data Structures</span></a></li>
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#nested-classes">Data Structures</a> |
|
|
<a href="#define-members">Defines</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<h1>Periodic Events Timer<br/>
|
|
<small>
|
|
[<a class="el" href="group__various.html">Various</a>]</small>
|
|
</h1> </div>
|
|
</div>
|
|
<div class="contents">
|
|
|
|
<p>Periodic Event Timer.
|
|
<a href="#_details">More...</a></p>
|
|
|
|
<p><div class="dynheader">
|
|
Collaboration diagram for Periodic Events Timer:</div>
|
|
<div class="dyncontent">
|
|
<center><table><tr><td><img src="group__event__timer.png" border="0" alt="" usemap="#group____event____timer"/>
|
|
<map name="group____event____timer" id="group____event____timer">
|
|
<area shape="rect" id="node2" href="group__various.html" title="Utilities Library." alt="" coords="7,5,65,32"/>
|
|
</map>
|
|
</td></tr></table></center>
|
|
</div>
|
|
</p>
|
|
<hr/><a name="_details"></a><h2>Description</h2>
|
|
<p>Periodic Event Timer. </p>
|
|
<p>This timer generates an event at regular intervals. The listening threads can use the event to perform time related activities. Multiple threads can listen to the same timer. </p>
|
|
<table class="memberdecls">
|
|
<tr><td colspan="2"><h2><a name="nested-classes"></a>
|
|
Data Structures</h2></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_ev_timer.html">EvTimer</a></td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Event timer structure. <a href="struct_ev_timer.html#_details">More...</a><br/></td></tr>
|
|
<tr><td colspan="2"><h2><a name="define-members"></a>
|
|
Defines</h2></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__event__timer.html#ga610eb103e3c967651e3212dc8c3f126b">evtInit</a>(etp, time)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initializes an <code><a class="el" href="struct_ev_timer.html" title="Event timer structure.">EvTimer</a></code> structure. <a href="#ga610eb103e3c967651e3212dc8c3f126b"></a><br/></td></tr>
|
|
<tr><td colspan="2"><h2><a name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__event__timer.html#gaa58fe826b42e0d64f32b6a40f54bb430">evtStart</a> (<a class="el" href="struct_ev_timer.html">EvTimer</a> *etp)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Starts the timer. <a href="#gaa58fe826b42e0d64f32b6a40f54bb430"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__event__timer.html#ga667900146fd2bc35721e072ae5b0e433">evtStop</a> (<a class="el" href="struct_ev_timer.html">EvTimer</a> *etp)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Stops the timer. <a href="#ga667900146fd2bc35721e072ae5b0e433"></a><br/></td></tr>
|
|
</table>
|
|
<hr/><h2>Define Documentation</h2>
|
|
<a class="anchor" id="ga610eb103e3c967651e3212dc8c3f126b"></a><!-- doxytag: member="evtimer.h::evtInit" ref="ga610eb103e3c967651e3212dc8c3f126b" args="(etp, time)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define evtInit</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">etp, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">time</td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">{ \
|
|
<a class="code" href="group__events.html#gab8d0fdc09be629dfb438c32a0523db42" title="Initializes an Event Source.">chEvtInit</a>(&(etp)->et_es); \
|
|
(etp)->et_vt.vt_func = NULL; \
|
|
(etp)->et_interval = (time); \
|
|
}
|
|
</pre></div>
|
|
<p>Initializes an <code><a class="el" href="struct_ev_timer.html" title="Event timer structure.">EvTimer</a></code> structure. </p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>etp</em> </td><td>the <a class="el" href="struct_ev_timer.html" title="Event timer structure.">EvTimer</a> structure to be initialized </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>time</em> </td><td>the interval in system ticks </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Definition at line <a class="el" href="evtimer_8h_source.html#l00061">61</a> of file <a class="el" href="evtimer_8h_source.html">evtimer.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/><h2>Function Documentation</h2>
|
|
<a class="anchor" id="gaa58fe826b42e0d64f32b6a40f54bb430"></a><!-- doxytag: member="evtimer.c::evtStart" ref="gaa58fe826b42e0d64f32b6a40f54bb430" args="(EvTimer *etp)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void evtStart </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_ev_timer.html">EvTimer</a> * </td>
|
|
<td class="paramname"> <em>etp</em></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Starts the timer. </p>
|
|
<p>If the timer was already running then the function has no effect.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>etp</em> </td><td>pointer to an initialized <code><a class="el" href="struct_ev_timer.html" title="Event timer structure.">EvTimer</a></code> structure. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga667900146fd2bc35721e072ae5b0e433"></a><!-- doxytag: member="evtimer.c::evtStop" ref="ga667900146fd2bc35721e072ae5b0e433" args="(EvTimer *etp)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void evtStop </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_ev_timer.html">EvTimer</a> * </td>
|
|
<td class="paramname"> <em>etp</em></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Stops the timer. </p>
|
|
<p>If the timer was already stopped then the function has no effect.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>etp</em> </td><td>pointer to an initialized <code><a class="el" href="struct_ev_timer.html" title="Event timer structure.">EvTimer</a></code> structure. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<hr size="1"><address style="text-align: right;"><small>
|
|
Generated on Sun Nov 28 2010 14:09:59 for ChibiOS/RT by <a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.7.1</small></address>
|
|
</body>
|
|
</html>
|