<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>wut: /home/ash/Code/wut2/include/coreinit/alarm.h File 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">wut
 <span id="projectnumber">1.0.0-beta9</span>
</div>
<div id="projectbrief">Wii U Toolchain</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_5050f3de292bd66075be80c4b119f1df.html">coreinit</a></li> </ul>
</div>
</div><!-- top -->
<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">alarm.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include <<a class="el" href="wut_8h_source.html">wut.h</a>></code><br />
<code>#include "<a class="el" href="thread_8h_source.html">thread.h</a>"</code><br />
<code>#include "<a class="el" href="threadqueue_8h_source.html">threadqueue.h</a>"</code><br />
<code>#include "<a class="el" href="time_8h_source.html">time.h</a>"</code><br />
</div>
<p><a href="alarm_8h_source.html">Go to the source code of this file.</a></p>
<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:structOSAlarmQueue"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__alarms.html#structOSAlarmQueue">OSAlarmQueue</a></td></tr>
<tr class="separator:structOSAlarmQueue"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:structOSAlarmLink"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__alarms.html#structOSAlarmLink">OSAlarmLink</a></td></tr>
<tr class="separator:structOSAlarmLink"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:structOSAlarm"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__alarms.html#structOSAlarm">OSAlarm</a></td></tr>
<tr class="separator:structOSAlarm"><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__coreinit__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__coreinit__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="group__coreinit__alarms.html#structOSAlarm">OSAlarm</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__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="group__coreinit__alarms.html#structOSAlarmLink">OSAlarmLink</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__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="group__coreinit__alarms.html#structOSAlarmQueue">OSAlarmQueue</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__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__coreinit__alarms.html#gae3b9b1db3508671a41015800fae35b8c">OSAlarmCallback</a>) (<a class="el" href="group__coreinit__alarms.html#structOSAlarm">OSAlarm</a> *, <a class="el" href="group__coreinit__context.html#ga924296baf430a531adb5135a5cd54207">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#a975dbe9e4396bf9e0064ce01827fa372">BOOL</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__alarms.html#gaf2d82c5e86eefb3acf43c20cee0c2818">OSCancelAlarm</a> (<a class="el" href="group__coreinit__alarms.html#structOSAlarm">OSAlarm</a> *alarm)</td></tr>
<tr class="memdesc:gaf2d82c5e86eefb3acf43c20cee0c2818"><td class="mdescLeft"> </td><td class="mdescRight">Cancel an alarm. <a href="group__coreinit__alarms.html#gaf2d82c5e86eefb3acf43c20cee0c2818">More...</a><br /></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__coreinit__alarms.html#ga5720fedb272532af0980a8d5c3caea40">OSCancelAlarms</a> (uint32_t group)</td></tr>
<tr class="memdesc:ga5720fedb272532af0980a8d5c3caea40"><td class="mdescLeft"> </td><td class="mdescRight">Cancel all alarms which have a matching tag set by OSSetAlarmTag. <a href="group__coreinit__alarms.html#ga5720fedb272532af0980a8d5c3caea40">More...</a><br /></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__coreinit__alarms.html#ga5a664886e2a2735e954d8d82f5dfdcc8">OSCreateAlarm</a> (<a class="el" href="group__coreinit__alarms.html#structOSAlarm">OSAlarm</a> *alarm)</td></tr>
<tr class="memdesc:ga5a664886e2a2735e954d8d82f5dfdcc8"><td class="mdescLeft"> </td><td class="mdescRight">Initialise an alarm structure. <a href="group__coreinit__alarms.html#ga5a664886e2a2735e954d8d82f5dfdcc8">More...</a><br /></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__coreinit__alarms.html#ga3a30762bb4654675399f0ac3de1144e7">OSCreateAlarmEx</a> (<a class="el" href="group__coreinit__alarms.html#structOSAlarm">OSAlarm</a> *alarm, const char *name)</td></tr>
<tr class="memdesc:ga3a30762bb4654675399f0ac3de1144e7"><td class="mdescLeft"> </td><td class="mdescRight">Initialise an alarm structure with a name. <a href="group__coreinit__alarms.html#ga3a30762bb4654675399f0ac3de1144e7">More...</a><br /></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__coreinit__alarms.html#ga7ef9512e147f3636433f81312b516180">OSGetAlarmUserData</a> (<a class="el" href="group__coreinit__alarms.html#structOSAlarm">OSAlarm</a> *alarm)</td></tr>
<tr class="memdesc:ga7ef9512e147f3636433f81312b516180"><td class="mdescLeft"> </td><td class="mdescRight">Return user data set by OSSetAlarmUserData. <a href="group__coreinit__alarms.html#ga7ef9512e147f3636433f81312b516180">More...</a><br /></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__coreinit__alarms.html#gac10998d540b1f79f2a00e08e029e3a22">OSInitAlarmQueue</a> (<a class="el" href="group__coreinit__alarms.html#structOSAlarmQueue">OSAlarmQueue</a> *queue)</td></tr>
<tr class="memdesc:gac10998d540b1f79f2a00e08e029e3a22"><td class="mdescLeft"> </td><td class="mdescRight">Initialise an alarm queue structure. <a href="group__coreinit__alarms.html#gac10998d540b1f79f2a00e08e029e3a22">More...</a><br /></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__coreinit__alarms.html#ga3697277777b6cb3e3037cf420ebc3870">OSInitAlarmQueueEx</a> (<a class="el" href="group__coreinit__alarms.html#structOSAlarmQueue">OSAlarmQueue</a> *queue, const char *name)</td></tr>
<tr class="memdesc:ga3697277777b6cb3e3037cf420ebc3870"><td class="mdescLeft"> </td><td class="mdescRight">Initialise an alarm queue structure with a name. <a href="group__coreinit__alarms.html#ga3697277777b6cb3e3037cf420ebc3870">More...</a><br /></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#a975dbe9e4396bf9e0064ce01827fa372">BOOL</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__alarms.html#ga4145b4d9637ede72450ee18cf98cd8a4">OSSetAlarm</a> (<a class="el" href="group__coreinit__alarms.html#structOSAlarm">OSAlarm</a> *alarm, <a class="el" href="group__coreinit__time.html#ga4d4f771188f6c29e758ed6b3b8347b4d">OSTime</a> time, <a class="el" href="group__coreinit__alarms.html#gae3b9b1db3508671a41015800fae35b8c">OSAlarmCallback</a> callback)</td></tr>
<tr class="memdesc:ga4145b4d9637ede72450ee18cf98cd8a4"><td class="mdescLeft"> </td><td class="mdescRight">Set a one shot alarm to perform a callback after a set amount of time. <a href="group__coreinit__alarms.html#ga4145b4d9637ede72450ee18cf98cd8a4">More...</a><br /></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#a975dbe9e4396bf9e0064ce01827fa372">BOOL</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__alarms.html#ga185b2ba5f2148dd78cac83c459d3568f">OSSetPeriodicAlarm</a> (<a class="el" href="group__coreinit__alarms.html#structOSAlarm">OSAlarm</a> *alarm, <a class="el" href="group__coreinit__time.html#ga4d4f771188f6c29e758ed6b3b8347b4d">OSTime</a> start, <a class="el" href="group__coreinit__time.html#ga4d4f771188f6c29e758ed6b3b8347b4d">OSTime</a> interval, <a class="el" href="group__coreinit__alarms.html#gae3b9b1db3508671a41015800fae35b8c">OSAlarmCallback</a> callback)</td></tr>
<tr class="memdesc:ga185b2ba5f2148dd78cac83c459d3568f"><td class="mdescLeft"> </td><td class="mdescRight">Set a repeated alarm to execute a callback every interval from start. <a href="group__coreinit__alarms.html#ga185b2ba5f2148dd78cac83c459d3568f">More...</a><br /></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__coreinit__alarms.html#ga411a482a63988aca30bf4a0cb354e350">OSSetAlarmTag</a> (<a class="el" href="group__coreinit__alarms.html#structOSAlarm">OSAlarm</a> *alarm, uint32_t group)</td></tr>
<tr class="memdesc:ga411a482a63988aca30bf4a0cb354e350"><td class="mdescLeft"> </td><td class="mdescRight">Set an alarm tag which is used in OSCancelAlarms for bulk cancellation. <a href="group__coreinit__alarms.html#ga411a482a63988aca30bf4a0cb354e350">More...</a><br /></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__coreinit__alarms.html#gaaf24ef65a362b6ff62b9cc96f3bbe458">OSSetAlarmUserData</a> (<a class="el" href="group__coreinit__alarms.html#structOSAlarm">OSAlarm</a> *alarm, void *data)</td></tr>
<tr class="memdesc:gaaf24ef65a362b6ff62b9cc96f3bbe458"><td class="mdescLeft"> </td><td class="mdescRight">Set alarm user data which is returned by OSGetAlarmUserData. <a href="group__coreinit__alarms.html#gaaf24ef65a362b6ff62b9cc96f3bbe458">More...</a><br /></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#a975dbe9e4396bf9e0064ce01827fa372">BOOL</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__alarms.html#gad84aa4992e422bf52deb596c1e77c6b8">OSWaitAlarm</a> (<a class="el" href="group__coreinit__alarms.html#structOSAlarm">OSAlarm</a> *alarm)</td></tr>
<tr class="memdesc:gad84aa4992e422bf52deb596c1e77c6b8"><td class="mdescLeft"> </td><td class="mdescRight">Sleep the current thread until the alarm has been triggered or cancelled. <a href="group__coreinit__alarms.html#gad84aa4992e422bf52deb596c1e77c6b8">More...</a><br /></td></tr>
<tr class="separator:gad84aa4992e422bf52deb596c1e77c6b8"><td class="memSeparator" colspan="2"> </td></tr>
</table>
</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.17
</small></address>
</body>
</html>