gnuk/ChibiOS_2.0.6/docs/html/classchibios__rt_1_1_event.html
2010-11-22 14:53:37 +09:00

742 lines
47 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: chibios_rt::Event Class Reference</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&nbsp;Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
<li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
</ul>
</div>
<div class="navpath">
<ul>
<li><b>chibios_rt</b> </li>
<li><a class="el" href="classchibios__rt_1_1_event.html">chibios_rt::Event</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<h1>chibios_rt::Event Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="chibios_rt::Event" -->
<p>Class encapsulating an event source.
<a href="#_details">More...</a></p>
<p><code>#include &lt;<a class="el" href="ch_8hpp_source.html">ch.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classchibios__rt_1_1_event.html#a4fad1d076cd31e2add80447f7980d8d2">Event</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><a class="el" href="classchibios__rt_1_1_event.html" title="Class encapsulating an event source.">Event</a> constructor. <a href="#a4fad1d076cd31e2add80447f7980d8d2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classchibios__rt_1_1_event.html#a871e59df8f46225845806ebdec4e832c">Register</a> (<a class="el" href="struct_event_listener.html">EventListener</a> *elp, <a class="el" href="group__types.html#gada5ed33935b8347e213aeb76582642e7">eventid_t</a> eid)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Registers a listener on the event source. <a href="#a871e59df8f46225845806ebdec4e832c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classchibios__rt_1_1_event.html#a39acaf2436f139a798973308c1929031">RegisterMask</a> (<a class="el" href="struct_event_listener.html">EventListener</a> *elp, <a class="el" href="group__types.html#gabff0c32475baf20ea8c5c710d6e8b708">eventmask_t</a> emask)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Registers an <a class="el" href="classchibios__rt_1_1_event.html" title="Class encapsulating an event source.">Event</a> Listener on an <a class="el" href="classchibios__rt_1_1_event.html" title="Class encapsulating an event source.">Event</a> Source. <a href="#a39acaf2436f139a798973308c1929031"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classchibios__rt_1_1_event.html#a177bc72df220068c9d620b8e9f42f2f5">Unregister</a> (<a class="el" href="struct_event_listener.html">EventListener</a> *elp)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Unregisters a listener. <a href="#a177bc72df220068c9d620b8e9f42f2f5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classchibios__rt_1_1_event.html#a665b23d0d212b06107a27f118021238c">Broadcast</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Broadcasts an event. <a href="#a665b23d0d212b06107a27f118021238c"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="group__types.html#gabff0c32475baf20ea8c5c710d6e8b708">eventmask_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classchibios__rt_1_1_event.html#ae3c7092d78ac9dda43c109b356826f41">Clear</a> (<a class="el" href="group__types.html#gabff0c32475baf20ea8c5c710d6e8b708">eventmask_t</a> mask)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Clears specified events from the pending events mask. <a href="#ae3c7092d78ac9dda43c109b356826f41"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="group__types.html#gabff0c32475baf20ea8c5c710d6e8b708">eventmask_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classchibios__rt_1_1_event.html#aca48258fbffb54c6e19bbb9016c4cee1">Pend</a> (<a class="el" href="group__types.html#gabff0c32475baf20ea8c5c710d6e8b708">eventmask_t</a> mask)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Makes an events mask pending in the current thread. <a href="#aca48258fbffb54c6e19bbb9016c4cee1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classchibios__rt_1_1_event.html#afde2cfb76dbd552ebb05bc6c6c8b2969">Dispatch</a> (const <a class="el" href="group__events.html#ga1a153010620569dd0cac24da8952269f">evhandler_t</a> handlers[], <a class="el" href="group__types.html#gabff0c32475baf20ea8c5c710d6e8b708">eventmask_t</a> mask)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Invokes the event handlers associated with a mask. <a href="#afde2cfb76dbd552ebb05bc6c6c8b2969"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="group__types.html#gabff0c32475baf20ea8c5c710d6e8b708">eventmask_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classchibios__rt_1_1_event.html#a5853ef97699efe31a969c7fc200e09a1">WaitOne</a> (<a class="el" href="group__types.html#gabff0c32475baf20ea8c5c710d6e8b708">eventmask_t</a> ewmask)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Waits for a single event. <a href="#a5853ef97699efe31a969c7fc200e09a1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="group__types.html#gabff0c32475baf20ea8c5c710d6e8b708">eventmask_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classchibios__rt_1_1_event.html#aeb53e2435cf8f614ea51e3c90334d5ae">WaitAny</a> (<a class="el" href="group__types.html#gabff0c32475baf20ea8c5c710d6e8b708">eventmask_t</a> ewmask)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Waits for any of the specified events. <a href="#aeb53e2435cf8f614ea51e3c90334d5ae"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="group__types.html#gabff0c32475baf20ea8c5c710d6e8b708">eventmask_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classchibios__rt_1_1_event.html#a55bd3220048e77217f5f75af7697d46f">WaitAll</a> (<a class="el" href="group__types.html#gabff0c32475baf20ea8c5c710d6e8b708">eventmask_t</a> ewmask)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Waits for all the specified event flags then clears them. <a href="#a55bd3220048e77217f5f75af7697d46f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="group__types.html#gabff0c32475baf20ea8c5c710d6e8b708">eventmask_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classchibios__rt_1_1_event.html#ab8fc502561437fec0194653052202b82">WaitOneTimeout</a> (<a class="el" href="group__types.html#gabff0c32475baf20ea8c5c710d6e8b708">eventmask_t</a> ewmask, <a class="el" href="group__types.html#gae3e32a98d431a02106616da3071832dd">systime_t</a> time)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Waits for a single event. <a href="#ab8fc502561437fec0194653052202b82"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="group__types.html#gabff0c32475baf20ea8c5c710d6e8b708">eventmask_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classchibios__rt_1_1_event.html#a4870dfce1f2ace0ab434718b0960b960">WaitAnyTimeout</a> (<a class="el" href="group__types.html#gabff0c32475baf20ea8c5c710d6e8b708">eventmask_t</a> ewmask, <a class="el" href="group__types.html#gae3e32a98d431a02106616da3071832dd">systime_t</a> time)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Waits for any of the specified events. <a href="#a4870dfce1f2ace0ab434718b0960b960"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="group__types.html#gabff0c32475baf20ea8c5c710d6e8b708">eventmask_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classchibios__rt_1_1_event.html#ab8c805f6b615e47050a75b16fd94492d">WaitAllTimeout</a> (<a class="el" href="group__types.html#gabff0c32475baf20ea8c5c710d6e8b708">eventmask_t</a> ewmask, <a class="el" href="group__types.html#gae3e32a98d431a02106616da3071832dd">systime_t</a> time)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Waits for all the specified event flags then clears them. <a href="#ab8c805f6b615e47050a75b16fd94492d"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__events.html#ga19ef0b2769d1df4d22250135a6de57b8">struct::EventSource</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classchibios__rt_1_1_event.html#a39ab1be709273f81cd1f9318abfe1508">event</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Embedded <code><a class="el" href="struct_event_source.html" title="Event Source structure.">EventSource</a></code> structure. <a href="#a39ab1be709273f81cd1f9318abfe1508"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Class encapsulating an event source. </p>
<p>Definition at line <a class="el" href="ch_8hpp_source.html#l00465">465</a> of file <a class="el" href="ch_8hpp_source.html">ch.hpp</a>.</p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a4fad1d076cd31e2add80447f7980d8d2"></a><!-- doxytag: member="chibios_rt::Event::Event" ref="a4fad1d076cd31e2add80447f7980d8d2" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">chibios_rt::Event::Event </td>
<td>(</td>
<td class="paramtype">void&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classchibios__rt_1_1_event.html" title="Class encapsulating an event source.">Event</a> constructor. </p>
<p>The embedded <code><a class="el" href="struct_event_source.html" title="Event Source structure.">EventSource</a></code> structure is initialized. </p>
<p>Definition at line <a class="el" href="ch_8cpp_source.html#l00267">267</a> of file <a class="el" href="ch_8cpp_source.html">ch.cpp</a>.</p>
<p>References <a class="el" href="group__events.html#gab8d0fdc09be629dfb438c32a0523db42">chEvtInit</a>, and <a class="el" href="classchibios__rt_1_1_event.html#a39ab1be709273f81cd1f9318abfe1508">event</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a871e59df8f46225845806ebdec4e832c"></a><!-- doxytag: member="chibios_rt::Event::Register" ref="a871e59df8f46225845806ebdec4e832c" args="(EventListener *elp, eventid_t eid)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void chibios_rt::Event::Register </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_event_listener.html">EventListener</a> *&nbsp;</td>
<td class="paramname"> <em>elp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__types.html#gada5ed33935b8347e213aeb76582642e7">eventid_t</a>&nbsp;</td>
<td class="paramname"> <em>eid</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Registers a listener on the event source. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>elp</em>&nbsp;</td><td>pointer to the <code><a class="el" href="struct_event_listener.html" title="Event Listener structure.">EventListener</a></code> structure </td></tr>
<tr><td valign="top"></td><td valign="top"><em>eid</em>&nbsp;</td><td>numeric identifier assigned to the <a class="el" href="classchibios__rt_1_1_event.html" title="Class encapsulating an event source.">Event</a> Listener </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="ch_8cpp_source.html#l00272">272</a> of file <a class="el" href="ch_8cpp_source.html">ch.cpp</a>.</p>
<p>References <a class="el" href="group__events.html#gad478062f3e09d00e1ad8ebe65a06ec0c">chEvtRegister</a>, and <a class="el" href="classchibios__rt_1_1_event.html#a39ab1be709273f81cd1f9318abfe1508">event</a>.</p>
</div>
</div>
<a class="anchor" id="a39acaf2436f139a798973308c1929031"></a><!-- doxytag: member="chibios_rt::Event::RegisterMask" ref="a39acaf2436f139a798973308c1929031" args="(EventListener *elp, eventmask_t emask)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void chibios_rt::Event::RegisterMask </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_event_listener.html">EventListener</a> *&nbsp;</td>
<td class="paramname"> <em>elp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__types.html#gabff0c32475baf20ea8c5c710d6e8b708">eventmask_t</a>&nbsp;</td>
<td class="paramname"> <em>emask</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Registers an <a class="el" href="classchibios__rt_1_1_event.html" title="Class encapsulating an event source.">Event</a> Listener on an <a class="el" href="classchibios__rt_1_1_event.html" title="Class encapsulating an event source.">Event</a> Source. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>elp</em>&nbsp;</td><td>pointer to the <code><a class="el" href="struct_event_listener.html" title="Event Listener structure.">EventListener</a></code> structure </td></tr>
<tr><td valign="top"></td><td valign="top"><em>emask</em>&nbsp;</td><td>the mask of event flags to be pended to the thread when the event source is broadcasted </td></tr>
</table>
</dd>
</dl>
<dl class="note"><dt><b>Note:</b></dt><dd>Multiple <a class="el" href="classchibios__rt_1_1_event.html" title="Class encapsulating an event source.">Event</a> Listeners can specify the same bits to be pended. </dd></dl>
<p>Definition at line <a class="el" href="ch_8cpp_source.html#l00277">277</a> of file <a class="el" href="ch_8cpp_source.html">ch.cpp</a>.</p>
<p>References <a class="el" href="group__events.html#ga4002600fe552128aaf96a6a1d3ada3ee">chEvtRegisterMask()</a>, and <a class="el" href="classchibios__rt_1_1_event.html#a39ab1be709273f81cd1f9318abfe1508">event</a>.</p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classchibios__rt_1_1_event_a39acaf2436f139a798973308c1929031_cgraph.png" border="0" usemap="#classchibios__rt_1_1_event_a39acaf2436f139a798973308c1929031_cgraph" alt=""/></div>
<map name="classchibios__rt_1_1_event_a39acaf2436f139a798973308c1929031_cgraph" id="classchibios__rt_1_1_event_a39acaf2436f139a798973308c1929031_cgraph">
<area shape="rect" id="node3" href="group__events.html#ga4002600fe552128aaf96a6a1d3ada3ee" title="Registers an Event Listener on an Event Source." alt="" coords="227,5,341,32"/>
</map>
</div>
</p>
</div>
</div>
<a class="anchor" id="a177bc72df220068c9d620b8e9f42f2f5"></a><!-- doxytag: member="chibios_rt::Event::Unregister" ref="a177bc72df220068c9d620b8e9f42f2f5" args="(EventListener *elp)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void chibios_rt::Event::Unregister </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_event_listener.html">EventListener</a> *&nbsp;</td>
<td class="paramname"> <em>elp</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Unregisters a listener. </p>
<p>The specified listeners is no more signaled by the event source.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>elp</em>&nbsp;</td><td>the listener to be unregistered </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="ch_8cpp_source.html#l00282">282</a> of file <a class="el" href="ch_8cpp_source.html">ch.cpp</a>.</p>
<p>References <a class="el" href="group__events.html#ga68d15e1c7e12e96edd40069a27981d38">chEvtUnregister()</a>, and <a class="el" href="classchibios__rt_1_1_event.html#a39ab1be709273f81cd1f9318abfe1508">event</a>.</p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classchibios__rt_1_1_event_a177bc72df220068c9d620b8e9f42f2f5_cgraph.png" border="0" usemap="#classchibios__rt_1_1_event_a177bc72df220068c9d620b8e9f42f2f5_cgraph" alt=""/></div>
<map name="classchibios__rt_1_1_event_a177bc72df220068c9d620b8e9f42f2f5_cgraph" id="classchibios__rt_1_1_event_a177bc72df220068c9d620b8e9f42f2f5_cgraph">
<area shape="rect" id="node3" href="group__events.html#ga68d15e1c7e12e96edd40069a27981d38" title="Unregisters an Event Listener from its Event Source." alt="" coords="213,5,312,32"/>
</map>
</div>
</p>
</div>
</div>
<a class="anchor" id="a665b23d0d212b06107a27f118021238c"></a><!-- doxytag: member="chibios_rt::Event::Broadcast" ref="a665b23d0d212b06107a27f118021238c" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void chibios_rt::Event::Broadcast </td>
<td>(</td>
<td class="paramtype">void&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Broadcasts an event. </p>
<p>All the listeners registered on the event source are signaled. </p>
<p>Definition at line <a class="el" href="ch_8cpp_source.html#l00287">287</a> of file <a class="el" href="ch_8cpp_source.html">ch.cpp</a>.</p>
<p>References <a class="el" href="group__events.html#ga44015af4dd20f74b0f73824ff1c1b2f4">chEvtBroadcast()</a>, and <a class="el" href="classchibios__rt_1_1_event.html#a39ab1be709273f81cd1f9318abfe1508">event</a>.</p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classchibios__rt_1_1_event_a665b23d0d212b06107a27f118021238c_cgraph.png" border="0" usemap="#classchibios__rt_1_1_event_a665b23d0d212b06107a27f118021238c_cgraph" alt=""/></div>
<map name="classchibios__rt_1_1_event_a665b23d0d212b06107a27f118021238c_cgraph" id="classchibios__rt_1_1_event_a665b23d0d212b06107a27f118021238c_cgraph">
<area shape="rect" id="node3" href="group__events.html#ga44015af4dd20f74b0f73824ff1c1b2f4" title="Signals all the Event Listeners registered on the specified Event Source." alt="" coords="213,31,312,57"/>
<area shape="rect" id="node5" href="group__events.html#gaa24d9bed5b676b577200c4a8ebe3b8a3" title="Signals all the Event Listeners registered on the specified Event Source." alt="" coords="368,5,469,32"/>
<area shape="rect" id="node7" href="group__scheduler.html#ga4e38b4bee3d2330f6a0f1cdb7660af20" title="Performs a reschedule if a higher priority thread is runnable." alt="" coords="360,56,477,83"/>
</map>
</div>
</p>
</div>
</div>
<a class="anchor" id="ae3c7092d78ac9dda43c109b356826f41"></a><!-- doxytag: member="chibios_rt::Event::Clear" ref="ae3c7092d78ac9dda43c109b356826f41" args="(eventmask_t mask)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__types.html#gabff0c32475baf20ea8c5c710d6e8b708">eventmask_t</a> chibios_rt::Event::Clear </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__types.html#gabff0c32475baf20ea8c5c710d6e8b708">eventmask_t</a>&nbsp;</td>
<td class="paramname"> <em>mask</em></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Clears specified events from the pending events mask. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>mask</em>&nbsp;</td><td>the events to be cleared </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The pending events that were cleared. </dd></dl>
<p>Definition at line <a class="el" href="ch_8cpp_source.html#l00292">292</a> of file <a class="el" href="ch_8cpp_source.html">ch.cpp</a>.</p>
<p>References <a class="el" href="group__events.html#ga76f41b9668c3f1adafc516a8f92b9cad">chEvtClear()</a>.</p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classchibios__rt_1_1_event_ae3c7092d78ac9dda43c109b356826f41_cgraph.png" border="0" usemap="#classchibios__rt_1_1_event_ae3c7092d78ac9dda43c109b356826f41_cgraph" alt=""/></div>
<map name="classchibios__rt_1_1_event_ae3c7092d78ac9dda43c109b356826f41_cgraph" id="classchibios__rt_1_1_event_ae3c7092d78ac9dda43c109b356826f41_cgraph">
<area shape="rect" id="node3" href="group__events.html#ga76f41b9668c3f1adafc516a8f92b9cad" title="Clears the pending events specified in the mask." alt="" coords="187,5,261,32"/>
</map>
</div>
</p>
</div>
</div>
<a class="anchor" id="aca48258fbffb54c6e19bbb9016c4cee1"></a><!-- doxytag: member="chibios_rt::Event::Pend" ref="aca48258fbffb54c6e19bbb9016c4cee1" args="(eventmask_t mask)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__types.html#gabff0c32475baf20ea8c5c710d6e8b708">eventmask_t</a> chibios_rt::Event::Pend </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__types.html#gabff0c32475baf20ea8c5c710d6e8b708">eventmask_t</a>&nbsp;</td>
<td class="paramname"> <em>mask</em></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Makes an events mask pending in the current thread. </p>
<p>This functon is <b>much</b> faster than using <code><a class="el" href="classchibios__rt_1_1_event.html#a665b23d0d212b06107a27f118021238c" title="Broadcasts an event.">Broadcast()</a></code>.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>mask</em>&nbsp;</td><td>the events to be pended </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The current pending events mask. </dd></dl>
<p>Definition at line <a class="el" href="ch_8cpp_source.html#l00297">297</a> of file <a class="el" href="ch_8cpp_source.html">ch.cpp</a>.</p>
<p>References <a class="el" href="group__events.html#ga94f14b6063f42b9be79a7dabde18232d">chEvtPend()</a>.</p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classchibios__rt_1_1_event_aca48258fbffb54c6e19bbb9016c4cee1_cgraph.png" border="0" usemap="#classchibios__rt_1_1_event_aca48258fbffb54c6e19bbb9016c4cee1_cgraph" alt=""/></div>
<map name="classchibios__rt_1_1_event_aca48258fbffb54c6e19bbb9016c4cee1_cgraph" id="classchibios__rt_1_1_event_aca48258fbffb54c6e19bbb9016c4cee1_cgraph">
<area shape="rect" id="node3" href="group__events.html#ga94f14b6063f42b9be79a7dabde18232d" title="Pends a set of event flags on the current thread, this is much faster than using chEvtBroadcast() or ..." alt="" coords="188,5,260,32"/>
</map>
</div>
</p>
</div>
</div>
<a class="anchor" id="afde2cfb76dbd552ebb05bc6c6c8b2969"></a><!-- doxytag: member="chibios_rt::Event::Dispatch" ref="afde2cfb76dbd552ebb05bc6c6c8b2969" args="(const evhandler_t handlers[], eventmask_t mask)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void chibios_rt::Event::Dispatch </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__events.html#ga1a153010620569dd0cac24da8952269f">evhandler_t</a>&nbsp;</td>
<td class="paramname"> <em>handlers</em>[], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__types.html#gabff0c32475baf20ea8c5c710d6e8b708">eventmask_t</a>&nbsp;</td>
<td class="paramname"> <em>mask</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Invokes the event handlers associated with a mask. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>mask</em>&nbsp;</td><td>mask of the events to be dispatched </td></tr>
<tr><td valign="top"></td><td valign="top"><em>handlers</em>&nbsp;</td><td>an array of <code>evhandler_t</code>. The array must be have indexes from zero up the higher registered event identifier. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="ch_8cpp_source.html#l00302">302</a> of file <a class="el" href="ch_8cpp_source.html">ch.cpp</a>.</p>
<p>References <a class="el" href="group__events.html#gaba2061f315848a8a722efcae258edc8c">chEvtDispatch()</a>.</p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classchibios__rt_1_1_event_afde2cfb76dbd552ebb05bc6c6c8b2969_cgraph.png" border="0" usemap="#classchibios__rt_1_1_event_afde2cfb76dbd552ebb05bc6c6c8b2969_cgraph" alt=""/></div>
<map name="classchibios__rt_1_1_event_afde2cfb76dbd552ebb05bc6c6c8b2969_cgraph" id="classchibios__rt_1_1_event_afde2cfb76dbd552ebb05bc6c6c8b2969_cgraph">
<area shape="rect" id="node3" href="group__events.html#gaba2061f315848a8a722efcae258edc8c" title="Invokes the event handlers associated to an event flags mask." alt="" coords="205,5,296,32"/>
</map>
</div>
</p>
</div>
</div>
<a class="anchor" id="a5853ef97699efe31a969c7fc200e09a1"></a><!-- doxytag: member="chibios_rt::Event::WaitOne" ref="a5853ef97699efe31a969c7fc200e09a1" args="(eventmask_t ewmask)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__types.html#gabff0c32475baf20ea8c5c710d6e8b708">eventmask_t</a> chibios_rt::Event::WaitOne </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__types.html#gabff0c32475baf20ea8c5c710d6e8b708">eventmask_t</a>&nbsp;</td>
<td class="paramname"> <em>ewmask</em></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Waits for a single event. </p>
<p>A pending event among those specified in <code>ewmask</code> is selected, cleared and its mask returned.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ewmask</em>&nbsp;</td><td>mask of the events that the function should wait for, <code>ALL_EVENTS</code> enables all the events </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The mask of the lowest id served and cleared event. </dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>One and only one event is served in the function, the one with the lowest event id. The function is meant to be invoked into a loop in order to serve all the pending events.<br/>
This means that <a class="el" href="classchibios__rt_1_1_event.html" title="Class encapsulating an event source.">Event</a> Listeners with a lower event identifier have an higher priority. </dd></dl>
<p>Definition at line <a class="el" href="ch_8cpp_source.html#l00307">307</a> of file <a class="el" href="ch_8cpp_source.html">ch.cpp</a>.</p>
<p>References <a class="el" href="group__events.html#ga77651e22578713ebe355c1213286c2e9">chEvtWaitOne()</a>.</p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classchibios__rt_1_1_event_a5853ef97699efe31a969c7fc200e09a1_cgraph.png" border="0" usemap="#classchibios__rt_1_1_event_a5853ef97699efe31a969c7fc200e09a1_cgraph" alt=""/></div>
<map name="classchibios__rt_1_1_event_a5853ef97699efe31a969c7fc200e09a1_cgraph" id="classchibios__rt_1_1_event_a5853ef97699efe31a969c7fc200e09a1_cgraph">
<area shape="rect" id="node3" href="group__events.html#ga77651e22578713ebe355c1213286c2e9" title="Waits for exactly one of the specified events." alt="" coords="203,5,293,32"/>
<area shape="rect" id="node5" href="group__scheduler.html#ga97c1c514b755a1e71caf2f19c1ccf986" title="Puts the current thread to sleep into the specified state." alt="" coords="341,5,443,32"/>
</map>
</div>
</p>
</div>
</div>
<a class="anchor" id="aeb53e2435cf8f614ea51e3c90334d5ae"></a><!-- doxytag: member="chibios_rt::Event::WaitAny" ref="aeb53e2435cf8f614ea51e3c90334d5ae" args="(eventmask_t ewmask)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__types.html#gabff0c32475baf20ea8c5c710d6e8b708">eventmask_t</a> chibios_rt::Event::WaitAny </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__types.html#gabff0c32475baf20ea8c5c710d6e8b708">eventmask_t</a>&nbsp;</td>
<td class="paramname"> <em>ewmask</em></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Waits for any of the specified events. </p>
<p>The function waits for any event among those specified in <code>ewmask</code> to become pending then the events are cleared and returned.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ewmask</em>&nbsp;</td><td>mask of the events that the function should wait for, <code>ALL_EVENTS</code> enables all the events </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The mask of the served and cleared events. </dd></dl>
<p>Definition at line <a class="el" href="ch_8cpp_source.html#l00312">312</a> of file <a class="el" href="ch_8cpp_source.html">ch.cpp</a>.</p>
<p>References <a class="el" href="group__events.html#gabd731d3ed2f037b2409e370676575f8d">chEvtWaitAny()</a>.</p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classchibios__rt_1_1_event_aeb53e2435cf8f614ea51e3c90334d5ae_cgraph.png" border="0" usemap="#classchibios__rt_1_1_event_aeb53e2435cf8f614ea51e3c90334d5ae_cgraph" alt=""/></div>
<map name="classchibios__rt_1_1_event_aeb53e2435cf8f614ea51e3c90334d5ae_cgraph" id="classchibios__rt_1_1_event_aeb53e2435cf8f614ea51e3c90334d5ae_cgraph">
<area shape="rect" id="node3" href="group__events.html#gabd731d3ed2f037b2409e370676575f8d" title="Waits for any of the specified events." alt="" coords="203,5,293,32"/>
<area shape="rect" id="node5" href="group__scheduler.html#ga97c1c514b755a1e71caf2f19c1ccf986" title="Puts the current thread to sleep into the specified state." alt="" coords="341,5,443,32"/>
</map>
</div>
</p>
</div>
</div>
<a class="anchor" id="a55bd3220048e77217f5f75af7697d46f"></a><!-- doxytag: member="chibios_rt::Event::WaitAll" ref="a55bd3220048e77217f5f75af7697d46f" args="(eventmask_t ewmask)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__types.html#gabff0c32475baf20ea8c5c710d6e8b708">eventmask_t</a> chibios_rt::Event::WaitAll </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__types.html#gabff0c32475baf20ea8c5c710d6e8b708">eventmask_t</a>&nbsp;</td>
<td class="paramname"> <em>ewmask</em></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Waits for all the specified event flags then clears them. </p>
<p>The function waits for all the events specified in <code>ewmask</code> to become pending then the events are cleared and returned.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ewmask</em>&nbsp;</td><td>mask of the event ids that the function should wait for </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The mask of the served and cleared events. </dd></dl>
<p>Definition at line <a class="el" href="ch_8cpp_source.html#l00317">317</a> of file <a class="el" href="ch_8cpp_source.html">ch.cpp</a>.</p>
<p>References <a class="el" href="group__events.html#ga8c5c6bf310a08cdc836d23f98a87dbf5">chEvtWaitAll()</a>.</p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classchibios__rt_1_1_event_a55bd3220048e77217f5f75af7697d46f_cgraph.png" border="0" usemap="#classchibios__rt_1_1_event_a55bd3220048e77217f5f75af7697d46f_cgraph" alt=""/></div>
<map name="classchibios__rt_1_1_event_a55bd3220048e77217f5f75af7697d46f_cgraph" id="classchibios__rt_1_1_event_a55bd3220048e77217f5f75af7697d46f_cgraph">
<area shape="rect" id="node3" href="group__events.html#ga8c5c6bf310a08cdc836d23f98a87dbf5" title="Waits for all the specified events." alt="" coords="195,5,277,32"/>
<area shape="rect" id="node5" href="group__scheduler.html#ga97c1c514b755a1e71caf2f19c1ccf986" title="Puts the current thread to sleep into the specified state." alt="" coords="325,5,427,32"/>
</map>
</div>
</p>
</div>
</div>
<a class="anchor" id="ab8fc502561437fec0194653052202b82"></a><!-- doxytag: member="chibios_rt::Event::WaitOneTimeout" ref="ab8fc502561437fec0194653052202b82" args="(eventmask_t ewmask, systime_t time)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__types.html#gabff0c32475baf20ea8c5c710d6e8b708">eventmask_t</a> chibios_rt::Event::WaitOneTimeout </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__types.html#gabff0c32475baf20ea8c5c710d6e8b708">eventmask_t</a>&nbsp;</td>
<td class="paramname"> <em>ewmask</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__types.html#gae3e32a98d431a02106616da3071832dd">systime_t</a>&nbsp;</td>
<td class="paramname"> <em>time</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Waits for a single event. </p>
<p>A pending event among those specified in <code>ewmask</code> is selected, cleared and its mask returned. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ewmask</em>&nbsp;</td><td>mask of the events that the function should wait for, <code>ALL_EVENTS</code> enables all the events </td></tr>
<tr><td valign="top"></td><td valign="top"><em>time</em>&nbsp;</td><td>the number of ticks before the operation timouts </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The mask of the lowest id served and cleared event. </dd></dl>
<dl><dt><b>Return values:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>0</em>&nbsp;</td><td>if the specified timeout expired. </td></tr>
</table>
</dd>
</dl>
<dl class="note"><dt><b>Note:</b></dt><dd>One and only one event is served in the function, the one with the lowest event id. The function is meant to be invoked into a loop in order to serve all the pending events.<br/>
This means that <a class="el" href="classchibios__rt_1_1_event.html" title="Class encapsulating an event source.">Event</a> Listeners with a lower event identifier have an higher priority. </dd></dl>
<p>Definition at line <a class="el" href="ch_8cpp_source.html#l00323">323</a> of file <a class="el" href="ch_8cpp_source.html">ch.cpp</a>.</p>
<p>References <a class="el" href="group__events.html#ga2944a7fc82e7cc15537f5a7c04f457d3">chEvtWaitOneTimeout()</a>.</p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classchibios__rt_1_1_event_ab8fc502561437fec0194653052202b82_cgraph.png" border="0" usemap="#classchibios__rt_1_1_event_ab8fc502561437fec0194653052202b82_cgraph" alt=""/></div>
<map name="classchibios__rt_1_1_event_ab8fc502561437fec0194653052202b82_cgraph" id="classchibios__rt_1_1_event_ab8fc502561437fec0194653052202b82_cgraph">
<area shape="rect" id="node3" href="group__events.html#ga2944a7fc82e7cc15537f5a7c04f457d3" title="Waits for exactly one of the specified events." alt="" coords="241,5,367,32"/>
<area shape="rect" id="node5" href="group__scheduler.html#ga306e564f678c1a39139639490c77e78b" title="Puts the current thread to sleep into the specified state with timeout specification." alt="" coords="416,5,555,32"/>
</map>
</div>
</p>
</div>
</div>
<a class="anchor" id="a4870dfce1f2ace0ab434718b0960b960"></a><!-- doxytag: member="chibios_rt::Event::WaitAnyTimeout" ref="a4870dfce1f2ace0ab434718b0960b960" args="(eventmask_t ewmask, systime_t time)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__types.html#gabff0c32475baf20ea8c5c710d6e8b708">eventmask_t</a> chibios_rt::Event::WaitAnyTimeout </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__types.html#gabff0c32475baf20ea8c5c710d6e8b708">eventmask_t</a>&nbsp;</td>
<td class="paramname"> <em>ewmask</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__types.html#gae3e32a98d431a02106616da3071832dd">systime_t</a>&nbsp;</td>
<td class="paramname"> <em>time</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Waits for any of the specified events. </p>
<p>The function waits for any event among those specified in <code>ewmask</code> to become pending then the events are cleared and returned.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ewmask</em>&nbsp;</td><td>mask of the events that the function should wait for, <code>ALL_EVENTS</code> enables all the events </td></tr>
<tr><td valign="top"></td><td valign="top"><em>time</em>&nbsp;</td><td>the number of ticks before the operation timouts </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The mask of the served and cleared events. </dd></dl>
<dl><dt><b>Return values:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>0</em>&nbsp;</td><td>if the specified timeout expired. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="ch_8cpp_source.html#l00328">328</a> of file <a class="el" href="ch_8cpp_source.html">ch.cpp</a>.</p>
<p>References <a class="el" href="group__events.html#gaf690406ccc833e2c9235e7e2041a6715">chEvtWaitAnyTimeout()</a>.</p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classchibios__rt_1_1_event_a4870dfce1f2ace0ab434718b0960b960_cgraph.png" border="0" usemap="#classchibios__rt_1_1_event_a4870dfce1f2ace0ab434718b0960b960_cgraph" alt=""/></div>
<map name="classchibios__rt_1_1_event_a4870dfce1f2ace0ab434718b0960b960_cgraph" id="classchibios__rt_1_1_event_a4870dfce1f2ace0ab434718b0960b960_cgraph">
<area shape="rect" id="node3" href="group__events.html#gaf690406ccc833e2c9235e7e2041a6715" title="Waits for any of the specified events." alt="" coords="241,5,367,32"/>
<area shape="rect" id="node5" href="group__scheduler.html#ga306e564f678c1a39139639490c77e78b" title="Puts the current thread to sleep into the specified state with timeout specification." alt="" coords="416,5,555,32"/>
</map>
</div>
</p>
</div>
</div>
<a class="anchor" id="ab8c805f6b615e47050a75b16fd94492d"></a><!-- doxytag: member="chibios_rt::Event::WaitAllTimeout" ref="ab8c805f6b615e47050a75b16fd94492d" args="(eventmask_t ewmask, systime_t time)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__types.html#gabff0c32475baf20ea8c5c710d6e8b708">eventmask_t</a> chibios_rt::Event::WaitAllTimeout </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__types.html#gabff0c32475baf20ea8c5c710d6e8b708">eventmask_t</a>&nbsp;</td>
<td class="paramname"> <em>ewmask</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__types.html#gae3e32a98d431a02106616da3071832dd">systime_t</a>&nbsp;</td>
<td class="paramname"> <em>time</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Waits for all the specified event flags then clears them. </p>
<p>The function waits for all the events specified in <code>ewmask</code> to become pending then the events are cleared and returned.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ewmask</em>&nbsp;</td><td>mask of the event ids that the function should wait for </td></tr>
<tr><td valign="top"></td><td valign="top"><em>time</em>&nbsp;</td><td>the number of ticks before the operation timouts </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The mask of the served and cleared events. </dd></dl>
<dl><dt><b>Return values:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>0</em>&nbsp;</td><td>if the specified timeout expired. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="ch_8cpp_source.html#l00333">333</a> of file <a class="el" href="ch_8cpp_source.html">ch.cpp</a>.</p>
<p>References <a class="el" href="group__events.html#ga90d702300eecee3d05f83e95b155c3ee">chEvtWaitAllTimeout()</a>.</p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classchibios__rt_1_1_event_ab8c805f6b615e47050a75b16fd94492d_cgraph.png" border="0" usemap="#classchibios__rt_1_1_event_ab8c805f6b615e47050a75b16fd94492d_cgraph" alt=""/></div>
<map name="classchibios__rt_1_1_event_ab8c805f6b615e47050a75b16fd94492d_cgraph" id="classchibios__rt_1_1_event_ab8c805f6b615e47050a75b16fd94492d_cgraph">
<area shape="rect" id="node3" href="group__events.html#ga90d702300eecee3d05f83e95b155c3ee" title="Waits for all the specified events." alt="" coords="233,5,351,32"/>
<area shape="rect" id="node5" href="group__scheduler.html#ga306e564f678c1a39139639490c77e78b" title="Puts the current thread to sleep into the specified state with timeout specification." alt="" coords="400,5,539,32"/>
</map>
</div>
</p>
</div>
</div>
<hr/><h2>Field Documentation</h2>
<a class="anchor" id="a39ab1be709273f81cd1f9318abfe1508"></a><!-- doxytag: member="chibios_rt::Event::event" ref="a39ab1be709273f81cd1f9318abfe1508" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct ::<a class="el" href="struct_event_source.html">EventSource</a> <a class="el" href="classchibios__rt_1_1_event.html#a39ab1be709273f81cd1f9318abfe1508">chibios_rt::Event::event</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Embedded <code><a class="el" href="struct_event_source.html" title="Event Source structure.">EventSource</a></code> structure. </p>
<p>Definition at line <a class="el" href="ch_8hpp_source.html#l00470">470</a> of file <a class="el" href="ch_8hpp_source.html">ch.hpp</a>.</p>
<p>Referenced by <a class="el" href="classchibios__rt_1_1_event.html#a665b23d0d212b06107a27f118021238c">Broadcast()</a>, <a class="el" href="classchibios__rt_1_1_event.html#a4fad1d076cd31e2add80447f7980d8d2">Event()</a>, <a class="el" href="classchibios__rt_1_1_event.html#a871e59df8f46225845806ebdec4e832c">Register()</a>, <a class="el" href="classchibios__rt_1_1_event.html#a39acaf2436f139a798973308c1929031">RegisterMask()</a>, and <a class="el" href="classchibios__rt_1_1_event.html#a177bc72df220068c9d620b8e9f42f2f5">Unregister()</a>.</p>
</div>
</div>
</div>
<hr size="1"><address style="text-align: right;"><small>
Generated on Sun Oct 24 2010 09:40:49 for ChibiOS/RT by&nbsp;<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>