The-Homebrew-Cloud/wut
2
0
Fork 0
mirror of https://github.com/wiiu-env/wut.git synced 2025-01-09 17:59:25 +01:00
Code Issues Packages Projects Releases Wiki Activity
wut/struct_o_s_alarm.html
James Benton 36432c2694 Update gh-pages
2016-01-11 01:17:32 +00:00

362 lines
20 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.10"/>
<title>WUT: OSAlarm Struct 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>
<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
&#160;<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&#160;Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="annotated.html"><span>Data&#160;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 id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
<li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
<li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
</ul>
</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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">OSAlarm Struct Reference<div class="ingroups"><a class="el" href="group__coreinit.html">coreinit</a> &raquo; <a class="el" href="group__coreinit__alarms.html">Alarms</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="alarm_8h_source.html">alarm.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a1c50fcd1195659821729f52af8f3bb7d"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_o_s_alarm.html#a1c50fcd1195659821729f52af8f3bb7d">tag</a></td></tr>
<tr class="memdesc:a1c50fcd1195659821729f52af8f3bb7d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Should always be set to the value OS_ALARM_TAG. <a href="#a1c50fcd1195659821729f52af8f3bb7d">More...</a><br /></td></tr>
<tr class="separator:a1c50fcd1195659821729f52af8f3bb7d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8f8f80d37794cde9472343e4487ba3eb"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_o_s_alarm.html#a8f8f80d37794cde9472343e4487ba3eb">name</a></td></tr>
<tr class="memdesc:a8f8f80d37794cde9472343e4487ba3eb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Name set from OSCreateAlarmEx. <a href="#a8f8f80d37794cde9472343e4487ba3eb">More...</a><br /></td></tr>
<tr class="separator:a8f8f80d37794cde9472343e4487ba3eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7501d0e87468f1eeb436de26e5924e99"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__coreinit__alarms.html#gae3b9b1db3508671a41015800fae35b8c">OSAlarmCallback</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_o_s_alarm.html#a7501d0e87468f1eeb436de26e5924e99">callback</a></td></tr>
<tr class="memdesc:a7501d0e87468f1eeb436de26e5924e99"><td class="mdescLeft">&#160;</td><td class="mdescRight">The callback to execute once the alarm is triggered. <a href="#a7501d0e87468f1eeb436de26e5924e99">More...</a><br /></td></tr>
<tr class="separator:a7501d0e87468f1eeb436de26e5924e99"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0d20c78ce80e301ed514bd4b4dec9ec0"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_o_s_alarm.html#a0d20c78ce80e301ed514bd4b4dec9ec0">group</a></td></tr>
<tr class="memdesc:a0d20c78ce80e301ed514bd4b4dec9ec0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Used with OSCancelAlarms for bulk cancellation of alarms. <a href="#a0d20c78ce80e301ed514bd4b4dec9ec0">More...</a><br /></td></tr>
<tr class="separator:a0d20c78ce80e301ed514bd4b4dec9ec0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a190eeb5b754b49ac842c452668043052"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__coreinit__time.html#ga4d4f771188f6c29e758ed6b3b8347b4d">OSTime</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_o_s_alarm.html#a190eeb5b754b49ac842c452668043052">nextFire</a></td></tr>
<tr class="memdesc:a190eeb5b754b49ac842c452668043052"><td class="mdescLeft">&#160;</td><td class="mdescRight">The time when the alarm will next be triggered. <a href="#a190eeb5b754b49ac842c452668043052">More...</a><br /></td></tr>
<tr class="separator:a190eeb5b754b49ac842c452668043052"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a394e95a3ba6feaf90390cf136d69a6a1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_o_s_alarm_link.html">OSAlarmLink</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_o_s_alarm.html#a394e95a3ba6feaf90390cf136d69a6a1">link</a></td></tr>
<tr class="memdesc:a394e95a3ba6feaf90390cf136d69a6a1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Link used for when this <a class="el" href="struct_o_s_alarm.html">OSAlarm</a> object is inside an <a class="el" href="struct_o_s_alarm_queue.html">OSAlarmQueue</a>. <a href="#a394e95a3ba6feaf90390cf136d69a6a1">More...</a><br /></td></tr>
<tr class="separator:a394e95a3ba6feaf90390cf136d69a6a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a52c650ff8028e52e5e24e5e265fb854d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__coreinit__time.html#ga4d4f771188f6c29e758ed6b3b8347b4d">OSTime</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_o_s_alarm.html#a52c650ff8028e52e5e24e5e265fb854d">period</a></td></tr>
<tr class="memdesc:a52c650ff8028e52e5e24e5e265fb854d"><td class="mdescLeft">&#160;</td><td class="mdescRight">The period between alarm triggers, this is only set for periodic alarms. <a href="#a52c650ff8028e52e5e24e5e265fb854d">More...</a><br /></td></tr>
<tr class="separator:a52c650ff8028e52e5e24e5e265fb854d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a206af50e853c293ba5cc104765aea702"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__coreinit__time.html#ga4d4f771188f6c29e758ed6b3b8347b4d">OSTime</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_o_s_alarm.html#a206af50e853c293ba5cc104765aea702">start</a></td></tr>
<tr class="memdesc:a206af50e853c293ba5cc104765aea702"><td class="mdescLeft">&#160;</td><td class="mdescRight">The time the alarm was started. <a href="#a206af50e853c293ba5cc104765aea702">More...</a><br /></td></tr>
<tr class="separator:a206af50e853c293ba5cc104765aea702"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2e294dd14122c554baa0665072b4ca7a"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_o_s_alarm.html#a2e294dd14122c554baa0665072b4ca7a">userData</a></td></tr>
<tr class="memdesc:a2e294dd14122c554baa0665072b4ca7a"><td class="mdescLeft">&#160;</td><td class="mdescRight">User data set with OSSetAlarmUserData and retrieved with OSGetAlarmUserData. <a href="#a2e294dd14122c554baa0665072b4ca7a">More...</a><br /></td></tr>
<tr class="separator:a2e294dd14122c554baa0665072b4ca7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1b0c7bd4d79798ef4e0ce23894c9aeb2"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_o_s_alarm.html#a1b0c7bd4d79798ef4e0ce23894c9aeb2">state</a></td></tr>
<tr class="memdesc:a1b0c7bd4d79798ef4e0ce23894c9aeb2"><td class="mdescLeft">&#160;</td><td class="mdescRight">The current state of the alarm, internal values. <a href="#a1b0c7bd4d79798ef4e0ce23894c9aeb2">More...</a><br /></td></tr>
<tr class="separator:a1b0c7bd4d79798ef4e0ce23894c9aeb2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a419c428ab51c6fbee4323287d2d9b3a8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_o_s_thread_queue.html">OSThreadQueue</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_o_s_alarm.html#a419c428ab51c6fbee4323287d2d9b3a8">threadQueue</a></td></tr>
<tr class="memdesc:a419c428ab51c6fbee4323287d2d9b3a8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Queue of threads currently waiting for the alarm to trigger with OSWaitAlarm. <a href="#a419c428ab51c6fbee4323287d2d9b3a8">More...</a><br /></td></tr>
<tr class="separator:a419c428ab51c6fbee4323287d2d9b3a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9791c7d04c2ff00663a6f3d77dc33142"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_o_s_alarm_queue.html">OSAlarmQueue</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_o_s_alarm.html#a9791c7d04c2ff00663a6f3d77dc33142">alarmQueue</a></td></tr>
<tr class="memdesc:a9791c7d04c2ff00663a6f3d77dc33142"><td class="mdescLeft">&#160;</td><td class="mdescRight">The queue that this alarm is currently in. <a href="#a9791c7d04c2ff00663a6f3d77dc33142">More...</a><br /></td></tr>
<tr class="separator:a9791c7d04c2ff00663a6f3d77dc33142"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a609d437ccc99bf081949d875f543cba1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_o_s_context.html">OSContext</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_o_s_alarm.html#a609d437ccc99bf081949d875f543cba1">context</a></td></tr>
<tr class="memdesc:a609d437ccc99bf081949d875f543cba1"><td class="mdescLeft">&#160;</td><td class="mdescRight">The context the alarm was triggered on. <a href="#a609d437ccc99bf081949d875f543cba1">More...</a><br /></td></tr>
<tr class="separator:a609d437ccc99bf081949d875f543cba1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p>Definition at line <a class="el" href="alarm_8h_source.html#l00062">62</a> of file <a class="el" href="alarm_8h_source.html">alarm.h</a>.</p>
</div><h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="a1c50fcd1195659821729f52af8f3bb7d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t tag</td>
</tr>
</table>
</div><div class="memdoc">
<p>Should always be set to the value OS_ALARM_TAG. </p>
<p>Definition at line <a class="el" href="alarm_8h_source.html#l00065">65</a> of file <a class="el" href="alarm_8h_source.html">alarm.h</a>.</p>
</div>
</div>
<a class="anchor" id="a8f8f80d37794cde9472343e4487ba3eb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* name</td>
</tr>
</table>
</div><div class="memdoc">
<p>Name set from OSCreateAlarmEx. </p>
<p>Definition at line <a class="el" href="alarm_8h_source.html#l00068">68</a> of file <a class="el" href="alarm_8h_source.html">alarm.h</a>.</p>
</div>
</div>
<a class="anchor" id="a7501d0e87468f1eeb436de26e5924e99"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__coreinit__alarms.html#gae3b9b1db3508671a41015800fae35b8c">OSAlarmCallback</a> callback</td>
</tr>
</table>
</div><div class="memdoc">
<p>The callback to execute once the alarm is triggered. </p>
<p>Definition at line <a class="el" href="alarm_8h_source.html#l00073">73</a> of file <a class="el" href="alarm_8h_source.html">alarm.h</a>.</p>
</div>
</div>
<a class="anchor" id="a0d20c78ce80e301ed514bd4b4dec9ec0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t group</td>
</tr>
</table>
</div><div class="memdoc">
<p>Used with OSCancelAlarms for bulk cancellation of alarms. </p>
<p>Definition at line <a class="el" href="alarm_8h_source.html#l00076">76</a> of file <a class="el" href="alarm_8h_source.html">alarm.h</a>.</p>
</div>
</div>
<a class="anchor" id="a190eeb5b754b49ac842c452668043052"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__coreinit__time.html#ga4d4f771188f6c29e758ed6b3b8347b4d">OSTime</a> nextFire</td>
</tr>
</table>
</div><div class="memdoc">
<p>The time when the alarm will next be triggered. </p>
<p>Definition at line <a class="el" href="alarm_8h_source.html#l00081">81</a> of file <a class="el" href="alarm_8h_source.html">alarm.h</a>.</p>
</div>
</div>
<a class="anchor" id="a394e95a3ba6feaf90390cf136d69a6a1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_o_s_alarm_link.html">OSAlarmLink</a> link</td>
</tr>
</table>
</div><div class="memdoc">
<p>Link used for when this <a class="el" href="struct_o_s_alarm.html">OSAlarm</a> object is inside an <a class="el" href="struct_o_s_alarm_queue.html">OSAlarmQueue</a>. </p>
<p>Definition at line <a class="el" href="alarm_8h_source.html#l00084">84</a> of file <a class="el" href="alarm_8h_source.html">alarm.h</a>.</p>
</div>
</div>
<a class="anchor" id="a52c650ff8028e52e5e24e5e265fb854d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__coreinit__time.html#ga4d4f771188f6c29e758ed6b3b8347b4d">OSTime</a> period</td>
</tr>
</table>
</div><div class="memdoc">
<p>The period between alarm triggers, this is only set for periodic alarms. </p>
<p>Definition at line <a class="el" href="alarm_8h_source.html#l00087">87</a> of file <a class="el" href="alarm_8h_source.html">alarm.h</a>.</p>
</div>
</div>
<a class="anchor" id="a206af50e853c293ba5cc104765aea702"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__coreinit__time.html#ga4d4f771188f6c29e758ed6b3b8347b4d">OSTime</a> start</td>
</tr>
</table>
</div><div class="memdoc">
<p>The time the alarm was started. </p>
<p>Definition at line <a class="el" href="alarm_8h_source.html#l00090">90</a> of file <a class="el" href="alarm_8h_source.html">alarm.h</a>.</p>
</div>
</div>
<a class="anchor" id="a2e294dd14122c554baa0665072b4ca7a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* userData</td>
</tr>
</table>
</div><div class="memdoc">
<p>User data set with OSSetAlarmUserData and retrieved with OSGetAlarmUserData. </p>
<p>Definition at line <a class="el" href="alarm_8h_source.html#l00093">93</a> of file <a class="el" href="alarm_8h_source.html">alarm.h</a>.</p>
</div>
</div>
<a class="anchor" id="a1b0c7bd4d79798ef4e0ce23894c9aeb2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t state</td>
</tr>
</table>
</div><div class="memdoc">
<p>The current state of the alarm, internal values. </p>
<p>Definition at line <a class="el" href="alarm_8h_source.html#l00096">96</a> of file <a class="el" href="alarm_8h_source.html">alarm.h</a>.</p>
</div>
</div>
<a class="anchor" id="a419c428ab51c6fbee4323287d2d9b3a8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_o_s_thread_queue.html">OSThreadQueue</a> threadQueue</td>
</tr>
</table>
</div><div class="memdoc">
<p>Queue of threads currently waiting for the alarm to trigger with OSWaitAlarm. </p>
<p>Definition at line <a class="el" href="alarm_8h_source.html#l00099">99</a> of file <a class="el" href="alarm_8h_source.html">alarm.h</a>.</p>
</div>
</div>
<a class="anchor" id="a9791c7d04c2ff00663a6f3d77dc33142"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_o_s_alarm_queue.html">OSAlarmQueue</a>* alarmQueue</td>
</tr>
</table>
</div><div class="memdoc">
<p>The queue that this alarm is currently in. </p>
<p>Definition at line <a class="el" href="alarm_8h_source.html#l00102">102</a> of file <a class="el" href="alarm_8h_source.html">alarm.h</a>.</p>
</div>
</div>
<a class="anchor" id="a609d437ccc99bf081949d875f543cba1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_o_s_context.html">OSContext</a>* context</td>
</tr>
</table>
</div><div class="memdoc">
<p>The context the alarm was triggered on. </p>
<p>Definition at line <a class="el" href="alarm_8h_source.html#l00105">105</a> of file <a class="el" href="alarm_8h_source.html">alarm.h</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>D:/Programming/Projects/wut/include/coreinit/<a class="el" href="alarm_8h_source.html">alarm.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.10
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink