mirror of
https://github.com/wiiu-env/wut.git
synced 2025-01-09 18:19:24 +01:00
548 lines
27 KiB
HTML
548 lines
27 KiB
HTML
<!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.10"/>
|
|
<title>WUT: Alarms</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>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { init_search(); });
|
|
</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">WUT
|
|
 <span id="projectnumber">0.1</span>
|
|
</div>
|
|
<div id="projectbrief">Wii U Toolchain</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.10 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.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>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<!-- 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 class="header">
|
|
<div class="summary">
|
|
<a href="#nested-classes">Data Structures</a> |
|
|
<a href="#define-members">Macros</a> |
|
|
<a href="#typedef-members">Typedefs</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">Alarms<div class="ingroups"><a class="el" href="group__coreinit.html">coreinit</a></div></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
|
|
Data Structures</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_o_s_alarm_queue.html">OSAlarmQueue</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_o_s_alarm_link.html">OSAlarmLink</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_o_s_alarm.html">OSAlarm</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
|
|
Macros</h2></td></tr>
|
|
<tr class="memitem:ga3e72b0eb6fc59257bebc8d017d162e7c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__alarms.html#ga3e72b0eb6fc59257bebc8d017d162e7c">OS_ALARM_QUEUE_TAG</a>   0x614C6D51u</td></tr>
|
|
<tr class="separator:ga3e72b0eb6fc59257bebc8d017d162e7c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga1510961a9ef9784d00043a8787750020"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__alarms.html#ga1510961a9ef9784d00043a8787750020">OS_ALARM_TAG</a>   0x614C724Du</td></tr>
|
|
<tr class="separator:ga1510961a9ef9784d00043a8787750020"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
|
|
Typedefs</h2></td></tr>
|
|
<tr class="memitem:gabe3fe2259612e01057e5c7b71ac1b51b"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="struct_o_s_alarm.html">OSAlarm</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__alarms.html#gabe3fe2259612e01057e5c7b71ac1b51b">OSAlarm</a></td></tr>
|
|
<tr class="separator:gabe3fe2259612e01057e5c7b71ac1b51b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga8d028dafb8787ca81f686458aa35a4b6"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="struct_o_s_alarm_link.html">OSAlarmLink</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__alarms.html#ga8d028dafb8787ca81f686458aa35a4b6">OSAlarmLink</a></td></tr>
|
|
<tr class="separator:ga8d028dafb8787ca81f686458aa35a4b6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga2fda9bac83e5e790e234d877e9a7e5aa"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="struct_o_s_alarm_queue.html">OSAlarmQueue</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__alarms.html#ga2fda9bac83e5e790e234d877e9a7e5aa">OSAlarmQueue</a></td></tr>
|
|
<tr class="separator:ga2fda9bac83e5e790e234d877e9a7e5aa"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gae3b9b1db3508671a41015800fae35b8c"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__alarms.html#gae3b9b1db3508671a41015800fae35b8c">OSAlarmCallback</a>) (<a class="el" href="struct_o_s_alarm.html">OSAlarm</a> *, <a class="el" href="struct_o_s_context.html">OSContext</a> *)</td></tr>
|
|
<tr class="separator:gae3b9b1db3508671a41015800fae35b8c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:gaf2d82c5e86eefb3acf43c20cee0c2818"><td class="memItemLeft" align="right" valign="top"><a class="el" href="wut__types_8h.html#a050c65e107f0c828f856a231f4b4e788">BOOL</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__alarms.html#gaf2d82c5e86eefb3acf43c20cee0c2818">OSCancelAlarm</a> (<a class="el" href="struct_o_s_alarm.html">OSAlarm</a> *alarm)</td></tr>
|
|
<tr class="separator:gaf2d82c5e86eefb3acf43c20cee0c2818"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga5720fedb272532af0980a8d5c3caea40"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__alarms.html#ga5720fedb272532af0980a8d5c3caea40">OSCancelAlarms</a> (uint32_t group)</td></tr>
|
|
<tr class="separator:ga5720fedb272532af0980a8d5c3caea40"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga5a664886e2a2735e954d8d82f5dfdcc8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__alarms.html#ga5a664886e2a2735e954d8d82f5dfdcc8">OSCreateAlarm</a> (<a class="el" href="struct_o_s_alarm.html">OSAlarm</a> *alarm)</td></tr>
|
|
<tr class="separator:ga5a664886e2a2735e954d8d82f5dfdcc8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga3a30762bb4654675399f0ac3de1144e7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__alarms.html#ga3a30762bb4654675399f0ac3de1144e7">OSCreateAlarmEx</a> (<a class="el" href="struct_o_s_alarm.html">OSAlarm</a> *alarm, const char *name)</td></tr>
|
|
<tr class="separator:ga3a30762bb4654675399f0ac3de1144e7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga7ef9512e147f3636433f81312b516180"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__alarms.html#ga7ef9512e147f3636433f81312b516180">OSGetAlarmUserData</a> (<a class="el" href="struct_o_s_alarm.html">OSAlarm</a> *alarm)</td></tr>
|
|
<tr class="separator:ga7ef9512e147f3636433f81312b516180"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gac10998d540b1f79f2a00e08e029e3a22"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__alarms.html#gac10998d540b1f79f2a00e08e029e3a22">OSInitAlarmQueue</a> (<a class="el" href="struct_o_s_alarm_queue.html">OSAlarmQueue</a> *queue)</td></tr>
|
|
<tr class="separator:gac10998d540b1f79f2a00e08e029e3a22"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga3697277777b6cb3e3037cf420ebc3870"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__alarms.html#ga3697277777b6cb3e3037cf420ebc3870">OSInitAlarmQueueEx</a> (<a class="el" href="struct_o_s_alarm_queue.html">OSAlarmQueue</a> *queue, const char *name)</td></tr>
|
|
<tr class="separator:ga3697277777b6cb3e3037cf420ebc3870"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga4145b4d9637ede72450ee18cf98cd8a4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="wut__types_8h.html#a050c65e107f0c828f856a231f4b4e788">BOOL</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__alarms.html#ga4145b4d9637ede72450ee18cf98cd8a4">OSSetAlarm</a> (<a class="el" href="struct_o_s_alarm.html">OSAlarm</a> *alarm, <a class="el" href="time_8h.html#a4d4f771188f6c29e758ed6b3b8347b4d">OSTime</a> time, <a class="el" href="group__alarms.html#gae3b9b1db3508671a41015800fae35b8c">OSAlarmCallback</a> callback)</td></tr>
|
|
<tr class="separator:ga4145b4d9637ede72450ee18cf98cd8a4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga185b2ba5f2148dd78cac83c459d3568f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="wut__types_8h.html#a050c65e107f0c828f856a231f4b4e788">BOOL</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__alarms.html#ga185b2ba5f2148dd78cac83c459d3568f">OSSetPeriodicAlarm</a> (<a class="el" href="struct_o_s_alarm.html">OSAlarm</a> *alarm, <a class="el" href="time_8h.html#a4d4f771188f6c29e758ed6b3b8347b4d">OSTime</a> start, <a class="el" href="time_8h.html#a4d4f771188f6c29e758ed6b3b8347b4d">OSTime</a> interval, <a class="el" href="group__alarms.html#gae3b9b1db3508671a41015800fae35b8c">OSAlarmCallback</a> callback)</td></tr>
|
|
<tr class="separator:ga185b2ba5f2148dd78cac83c459d3568f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga411a482a63988aca30bf4a0cb354e350"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__alarms.html#ga411a482a63988aca30bf4a0cb354e350">OSSetAlarmTag</a> (<a class="el" href="struct_o_s_alarm.html">OSAlarm</a> *alarm, uint32_t group)</td></tr>
|
|
<tr class="separator:ga411a482a63988aca30bf4a0cb354e350"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaaf24ef65a362b6ff62b9cc96f3bbe458"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__alarms.html#gaaf24ef65a362b6ff62b9cc96f3bbe458">OSSetAlarmUserData</a> (<a class="el" href="struct_o_s_alarm.html">OSAlarm</a> *alarm, void *data)</td></tr>
|
|
<tr class="separator:gaaf24ef65a362b6ff62b9cc96f3bbe458"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gad84aa4992e422bf52deb596c1e77c6b8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="wut__types_8h.html#a050c65e107f0c828f856a231f4b4e788">BOOL</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__alarms.html#gad84aa4992e422bf52deb596c1e77c6b8">OSWaitAlarm</a> (<a class="el" href="struct_o_s_alarm.html">OSAlarm</a> *alarm)</td></tr>
|
|
<tr class="separator:gad84aa4992e422bf52deb596c1e77c6b8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<p>The alarm family of functions are used for creating alarms which call a callback or wake up waiting threads after a period of time.</p>
|
|
<p>Alarms can be one shot alarms which trigger once after a period of time, or periodic which trigger at regular intervals until they are cancelled. </p>
|
|
<h2 class="groupheader">Macro Definition Documentation</h2>
|
|
<a class="anchor" id="ga3e72b0eb6fc59257bebc8d017d162e7c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define OS_ALARM_QUEUE_TAG   0x614C6D51u</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="alarm_8h_source.html#l00030">30</a> of file <a class="el" href="alarm_8h_source.html">alarm.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga1510961a9ef9784d00043a8787750020"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define OS_ALARM_TAG   0x614C724Du</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="alarm_8h_source.html#l00061">61</a> of file <a class="el" href="alarm_8h_source.html">alarm.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Typedef Documentation</h2>
|
|
<a class="anchor" id="gabe3fe2259612e01057e5c7b71ac1b51b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef struct <a class="el" href="struct_o_s_alarm.html">OSAlarm</a> <a class="el" href="struct_o_s_alarm.html">OSAlarm</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="alarm_8h_source.html#l00024">24</a> of file <a class="el" href="alarm_8h_source.html">alarm.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gae3b9b1db3508671a41015800fae35b8c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef void(* OSAlarmCallback) (<a class="el" href="struct_o_s_alarm.html">OSAlarm</a> *, <a class="el" href="struct_o_s_context.html">OSContext</a> *)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="alarm_8h_source.html#l00028">28</a> of file <a class="el" href="alarm_8h_source.html">alarm.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga8d028dafb8787ca81f686458aa35a4b6"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef struct <a class="el" href="struct_o_s_alarm_link.html">OSAlarmLink</a> <a class="el" href="struct_o_s_alarm_link.html">OSAlarmLink</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="alarm_8h_source.html#l00025">25</a> of file <a class="el" href="alarm_8h_source.html">alarm.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga2fda9bac83e5e790e234d877e9a7e5aa"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef struct <a class="el" href="struct_o_s_alarm_queue.html">OSAlarmQueue</a> <a class="el" href="struct_o_s_alarm_queue.html">OSAlarmQueue</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="alarm_8h_source.html#l00026">26</a> of file <a class="el" href="alarm_8h_source.html">alarm.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a class="anchor" id="gaf2d82c5e86eefb3acf43c20cee0c2818"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="wut__types_8h.html#a050c65e107f0c828f856a231f4b4e788">BOOL</a> OSCancelAlarm </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_o_s_alarm.html">OSAlarm</a> * </td>
|
|
<td class="paramname"><em>alarm</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Cancel an alarm. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga5720fedb272532af0980a8d5c3caea40"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void OSCancelAlarms </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>group</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Cancel all alarms which have a matching tag set by OSSetAlarmTag.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">group</td><td>The alarm tag to cancel. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga5a664886e2a2735e954d8d82f5dfdcc8"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void OSCreateAlarm </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_o_s_alarm.html">OSAlarm</a> * </td>
|
|
<td class="paramname"><em>alarm</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Initialise an alarm structure. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga3a30762bb4654675399f0ac3de1144e7"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void OSCreateAlarmEx </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_o_s_alarm.html">OSAlarm</a> * </td>
|
|
<td class="paramname"><em>alarm</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>name</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Initialise an alarm structure with a name. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga7ef9512e147f3636433f81312b516180"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void* OSGetAlarmUserData </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_o_s_alarm.html">OSAlarm</a> * </td>
|
|
<td class="paramname"><em>alarm</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Return user data set by OSSetAlarmUserData. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gac10998d540b1f79f2a00e08e029e3a22"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void OSInitAlarmQueue </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_o_s_alarm_queue.html">OSAlarmQueue</a> * </td>
|
|
<td class="paramname"><em>queue</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Initialise an alarm queue structure. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga3697277777b6cb3e3037cf420ebc3870"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void OSInitAlarmQueueEx </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_o_s_alarm_queue.html">OSAlarmQueue</a> * </td>
|
|
<td class="paramname"><em>queue</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>name</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Initialise an alarm queue structure with a name. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga4145b4d9637ede72450ee18cf98cd8a4"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="wut__types_8h.html#a050c65e107f0c828f856a231f4b4e788">BOOL</a> OSSetAlarm </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_o_s_alarm.html">OSAlarm</a> * </td>
|
|
<td class="paramname"><em>alarm</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="time_8h.html#a4d4f771188f6c29e758ed6b3b8347b4d">OSTime</a> </td>
|
|
<td class="paramname"><em>time</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__alarms.html#gae3b9b1db3508671a41015800fae35b8c">OSAlarmCallback</a> </td>
|
|
<td class="paramname"><em>callback</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Set a one shot alarm to perform a callback after a set amount of time.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">alarm</td><td>The alarm to set. </td></tr>
|
|
<tr><td class="paramname">time</td><td>The duration until the alarm should be triggered. </td></tr>
|
|
<tr><td class="paramname">callback</td><td>The alarm callback to call when the alarm is triggered. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga411a482a63988aca30bf4a0cb354e350"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void OSSetAlarmTag </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_o_s_alarm.html">OSAlarm</a> * </td>
|
|
<td class="paramname"><em>alarm</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>group</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Set an alarm tag which is used in OSCancelAlarms for bulk cancellation. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaaf24ef65a362b6ff62b9cc96f3bbe458"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void OSSetAlarmUserData </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_o_s_alarm.html">OSAlarm</a> * </td>
|
|
<td class="paramname"><em>alarm</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>data</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Set alarm user data which is returned by OSGetAlarmUserData. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga185b2ba5f2148dd78cac83c459d3568f"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="wut__types_8h.html#a050c65e107f0c828f856a231f4b4e788">BOOL</a> OSSetPeriodicAlarm </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_o_s_alarm.html">OSAlarm</a> * </td>
|
|
<td class="paramname"><em>alarm</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="time_8h.html#a4d4f771188f6c29e758ed6b3b8347b4d">OSTime</a> </td>
|
|
<td class="paramname"><em>start</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="time_8h.html#a4d4f771188f6c29e758ed6b3b8347b4d">OSTime</a> </td>
|
|
<td class="paramname"><em>interval</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__alarms.html#gae3b9b1db3508671a41015800fae35b8c">OSAlarmCallback</a> </td>
|
|
<td class="paramname"><em>callback</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Set a repeated alarm to execute a callback every interval from start.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">alarm</td><td>The alarm to set. </td></tr>
|
|
<tr><td class="paramname">start</td><td>The duration until the alarm should first be triggered. </td></tr>
|
|
<tr><td class="paramname">interval</td><td>The interval between triggers after the first trigger. </td></tr>
|
|
<tr><td class="paramname">callback</td><td>The alarm callback to call when the alarm is triggered. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gad84aa4992e422bf52deb596c1e77c6b8"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="wut__types_8h.html#a050c65e107f0c828f856a231f4b4e788">BOOL</a> OSWaitAlarm </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_o_s_alarm.html">OSAlarm</a> * </td>
|
|
<td class="paramname"><em>alarm</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Sleep the current thread until the alarm has been triggered or cancelled. </p>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.10
|
|
</small></address>
|
|
</body>
|
|
</html>
|