The-Homebrew-Cloud/wut
2
0
Fork 0
mirror of https://github.com/wiiu-env/wut.git synced 2024-12-05 03:24:17 +01:00
Code Issues Packages Projects Releases Wiki Activity
gh-pages
wut/group__coreinit__event.html
Ash Logan b225d3cb49 doxygen: rebuild against 1.0.0-beta9
2020-03-26 16:49:18 +11:00

462 lines
25 KiB
HTML
Raw Permalink Blame History

<!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: Event Object</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
&#160;<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&amp;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&amp;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>
</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> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Event Object<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:structOSEvent"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__event.html#structOSEvent">OSEvent</a></td></tr>
<tr class="separator:structOSEvent"><td class="memSeparator" colspan="2">&#160;</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:ga2a99a920404e118e9b530e940ebf1b93"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__event.html#ga2a99a920404e118e9b530e940ebf1b93">OS_EVENT_TAG</a>&#160;&#160;&#160;0x65566E54u</td></tr>
<tr class="separator:ga2a99a920404e118e9b530e940ebf1b93"><td class="memSeparator" colspan="2">&#160;</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:ga6dff053541cf60f3a34ab013e503382b"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="group__coreinit__event.html#structOSEvent">OSEvent</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__event.html#ga6dff053541cf60f3a34ab013e503382b">OSEvent</a></td></tr>
<tr class="separator:ga6dff053541cf60f3a34ab013e503382b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1b9527278411aee1783c889d5494b53c"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="group__coreinit__event.html#ga2d1b8c1aaa6e238daac84212cd597d02">OSEventMode</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__event.html#ga1b9527278411aee1783c889d5494b53c">OSEventMode</a></td></tr>
<tr class="separator:ga1b9527278411aee1783c889d5494b53c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga2d1b8c1aaa6e238daac84212cd597d02"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__event.html#ga2d1b8c1aaa6e238daac84212cd597d02">OSEventMode</a> { <br />
&#160;&#160;<a class="el" href="group__coreinit__event.html#gga2d1b8c1aaa6e238daac84212cd597d02a15b47b989cf26fdc0bfc7739dd62cbca">OS_EVENT_MODE_MANUAL</a> = 0,
<br />
&#160;&#160;<a class="el" href="group__coreinit__event.html#gga2d1b8c1aaa6e238daac84212cd597d02a58aa26fa59ff73667a320f9eca1c6fd6">OS_EVENT_MODE_AUTO</a> = 1
<br />
}</td></tr>
<tr class="separator:ga2d1b8c1aaa6e238daac84212cd597d02"><td class="memSeparator" colspan="2">&#160;</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:ga8acaa46f677e69f110a19a2e956ddcd6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__event.html#ga8acaa46f677e69f110a19a2e956ddcd6">OSInitEvent</a> (<a class="el" href="group__coreinit__event.html#structOSEvent">OSEvent</a> *event, <a class="el" href="wut__types_8h.html#a975dbe9e4396bf9e0064ce01827fa372">BOOL</a> value, <a class="el" href="group__coreinit__event.html#ga2d1b8c1aaa6e238daac84212cd597d02">OSEventMode</a> mode)</td></tr>
<tr class="memdesc:ga8acaa46f677e69f110a19a2e956ddcd6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialise an event object with value and mode. <a href="group__coreinit__event.html#ga8acaa46f677e69f110a19a2e956ddcd6">More...</a><br /></td></tr>
<tr class="separator:ga8acaa46f677e69f110a19a2e956ddcd6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga152505eccadef17efdd8b6cca2f8ce2f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__event.html#ga152505eccadef17efdd8b6cca2f8ce2f">OSInitEventEx</a> (<a class="el" href="group__coreinit__event.html#structOSEvent">OSEvent</a> *event, <a class="el" href="wut__types_8h.html#a975dbe9e4396bf9e0064ce01827fa372">BOOL</a> value, <a class="el" href="group__coreinit__event.html#ga2d1b8c1aaa6e238daac84212cd597d02">OSEventMode</a> mode, char *name)</td></tr>
<tr class="memdesc:ga152505eccadef17efdd8b6cca2f8ce2f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialise an event object with value, mode and name. <a href="group__coreinit__event.html#ga152505eccadef17efdd8b6cca2f8ce2f">More...</a><br /></td></tr>
<tr class="separator:ga152505eccadef17efdd8b6cca2f8ce2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga18f11bbc98f004476e1b7ef5b72b20b4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__event.html#ga18f11bbc98f004476e1b7ef5b72b20b4">OSSignalEvent</a> (<a class="el" href="group__coreinit__event.html#structOSEvent">OSEvent</a> *event)</td></tr>
<tr class="memdesc:ga18f11bbc98f004476e1b7ef5b72b20b4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Signals the event. <a href="group__coreinit__event.html#ga18f11bbc98f004476e1b7ef5b72b20b4">More...</a><br /></td></tr>
<tr class="separator:ga18f11bbc98f004476e1b7ef5b72b20b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8e66a2b0c064dd3b280fbb474dd4d083"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__event.html#ga8e66a2b0c064dd3b280fbb474dd4d083">OSSignalEventAll</a> (<a class="el" href="group__coreinit__event.html#structOSEvent">OSEvent</a> *event)</td></tr>
<tr class="memdesc:ga8e66a2b0c064dd3b280fbb474dd4d083"><td class="mdescLeft">&#160;</td><td class="mdescRight">Signals all threads waiting on an event. <a href="group__coreinit__event.html#ga8e66a2b0c064dd3b280fbb474dd4d083">More...</a><br /></td></tr>
<tr class="separator:ga8e66a2b0c064dd3b280fbb474dd4d083"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3c1778dbfa0b9ae29248d4b8fe481c11"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__event.html#ga3c1778dbfa0b9ae29248d4b8fe481c11">OSWaitEvent</a> (<a class="el" href="group__coreinit__event.html#structOSEvent">OSEvent</a> *event)</td></tr>
<tr class="memdesc:ga3c1778dbfa0b9ae29248d4b8fe481c11"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wait until an event is signalled. <a href="group__coreinit__event.html#ga3c1778dbfa0b9ae29248d4b8fe481c11">More...</a><br /></td></tr>
<tr class="separator:ga3c1778dbfa0b9ae29248d4b8fe481c11"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga27699986af3f6eee35c6cda0033d071c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__event.html#ga27699986af3f6eee35c6cda0033d071c">OSResetEvent</a> (<a class="el" href="group__coreinit__event.html#structOSEvent">OSEvent</a> *event)</td></tr>
<tr class="memdesc:ga27699986af3f6eee35c6cda0033d071c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Resets the event object. <a href="group__coreinit__event.html#ga27699986af3f6eee35c6cda0033d071c">More...</a><br /></td></tr>
<tr class="separator:ga27699986af3f6eee35c6cda0033d071c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf35db0845e7b82bff1376df3564174b4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="wut__types_8h.html#a975dbe9e4396bf9e0064ce01827fa372">BOOL</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__event.html#gaf35db0845e7b82bff1376df3564174b4">OSWaitEventWithTimeout</a> (<a class="el" href="group__coreinit__event.html#structOSEvent">OSEvent</a> *event, <a class="el" href="group__coreinit__time.html#ga4d4f771188f6c29e758ed6b3b8347b4d">OSTime</a> timeout)</td></tr>
<tr class="memdesc:gaf35db0845e7b82bff1376df3564174b4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wait until an event is signalled or a timeout has occurred. <a href="group__coreinit__event.html#gaf35db0845e7b82bff1376df3564174b4">More...</a><br /></td></tr>
<tr class="separator:gaf35db0845e7b82bff1376df3564174b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Standard event object implementation. There are two supported event object modes, check OSEventMode.</p>
<p>Similar to Windows <a href="https://msdn.microsoft.com/en-us/library/windows/desktop/ms682655(v=vs.85).aspx">Event Objects</a>. </p>
<hr/><h2 class="groupheader">Data Structure Documentation</h2>
<a name="structOSEvent" id="structOSEvent"></a>
<h2 class="memtitle"><span class="permalink"><a href="#structOSEvent">&#9670;&nbsp;</a></span>OSEvent</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct OSEvent</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock">
<p class="definition">Definition at line <a class="el" href="coreinit_2event_8h_source.html#l00033">33</a> of file <a class="el" href="coreinit_2event_8h_source.html">event.h</a>.</p>
</div><table class="fieldtable">
<tr><th colspan="3">Data Fields</th></tr>
<tr><td class="fieldtype">
<a id="a1c50fcd1195659821729f52af8f3bb7d"></a>uint32_t</td>
<td class="fieldname">
tag</td>
<td class="fielddoc">
Should always be set to the value OS_EVENT_TAG. </td></tr>
<tr><td class="fieldtype">
<a id="a8f8f80d37794cde9472343e4487ba3eb"></a>const char *</td>
<td class="fieldname">
name</td>
<td class="fielddoc">
Name set by OSInitEventEx. </td></tr>
<tr><td class="fieldtype">
<a id="a3502e4ff0e7d6136b4908bf15ccb6d42"></a><a class="el" href="wut__types_8h.html#a975dbe9e4396bf9e0064ce01827fa372">BOOL</a></td>
<td class="fieldname">
value</td>
<td class="fielddoc">
The current value of the event object. </td></tr>
<tr><td class="fieldtype">
<a id="a4c72ffd2d6a41665aa8203649acbb46d"></a><a class="el" href="group__coreinit__threadq.html#structOSThreadQueue">OSThreadQueue</a></td>
<td class="fieldname">
queue</td>
<td class="fielddoc">
The threads currently waiting on this event object with OSWaitEvent. </td></tr>
<tr><td class="fieldtype">
<a id="a12258f18f1ea9dac6cf1682225351f1b"></a><a class="el" href="group__coreinit__event.html#ga2d1b8c1aaa6e238daac84212cd597d02">OSEventMode</a></td>
<td class="fieldname">
mode</td>
<td class="fielddoc">
The mode of the event object, set by OSInitEvent. </td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="ga2a99a920404e118e9b530e940ebf1b93"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2a99a920404e118e9b530e940ebf1b93">&#9670;&nbsp;</a></span>OS_EVENT_TAG</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define OS_EVENT_TAG&#160;&#160;&#160;0x65566E54u</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="coreinit_2event_8h_source.html#l00031">31</a> of file <a class="el" href="coreinit_2event_8h_source.html">event.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="ga6dff053541cf60f3a34ab013e503382b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6dff053541cf60f3a34ab013e503382b">&#9670;&nbsp;</a></span>OSEvent</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="group__coreinit__event.html#structOSEvent">OSEvent</a> <a class="el" href="group__coreinit__event.html#structOSEvent">OSEvent</a></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="coreinit_2event_8h_source.html#l00020">20</a> of file <a class="el" href="coreinit_2event_8h_source.html">event.h</a>.</p>
</div>
</div>
<a id="ga1b9527278411aee1783c889d5494b53c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1b9527278411aee1783c889d5494b53c">&#9670;&nbsp;</a></span>OSEventMode</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef enum <a class="el" href="group__coreinit__event.html#ga2d1b8c1aaa6e238daac84212cd597d02">OSEventMode</a> <a class="el" href="group__coreinit__event.html#ga2d1b8c1aaa6e238daac84212cd597d02">OSEventMode</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="ga2d1b8c1aaa6e238daac84212cd597d02"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2d1b8c1aaa6e238daac84212cd597d02">&#9670;&nbsp;</a></span>OSEventMode</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__coreinit__event.html#ga2d1b8c1aaa6e238daac84212cd597d02">OSEventMode</a></td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga2d1b8c1aaa6e238daac84212cd597d02a15b47b989cf26fdc0bfc7739dd62cbca"></a>OS_EVENT_MODE_MANUAL&#160;</td><td class="fielddoc"><p>A manual event will only reset when OSResetEvent is called. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga2d1b8c1aaa6e238daac84212cd597d02a58aa26fa59ff73667a320f9eca1c6fd6"></a>OS_EVENT_MODE_AUTO&#160;</td><td class="fielddoc"><p>An auto event will reset everytime a thread is woken. </p>
</td></tr>
</table>
<p class="definition">Definition at line <a class="el" href="coreinit_2event_8h_source.html#l00022">22</a> of file <a class="el" href="coreinit_2event_8h_source.html">event.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga8acaa46f677e69f110a19a2e956ddcd6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8acaa46f677e69f110a19a2e956ddcd6">&#9670;&nbsp;</a></span>OSInitEvent()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void OSInitEvent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__coreinit__event.html#structOSEvent">OSEvent</a> *&#160;</td>
<td class="paramname"><em>event</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="wut__types_8h.html#a975dbe9e4396bf9e0064ce01827fa372">BOOL</a>&#160;</td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__coreinit__event.html#ga2d1b8c1aaa6e238daac84212cd597d02">OSEventMode</a>&#160;</td>
<td class="paramname"><em>mode</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialise an event object with value and mode. </p>
</div>
</div>
<a id="ga152505eccadef17efdd8b6cca2f8ce2f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga152505eccadef17efdd8b6cca2f8ce2f">&#9670;&nbsp;</a></span>OSInitEventEx()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void OSInitEventEx </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__coreinit__event.html#structOSEvent">OSEvent</a> *&#160;</td>
<td class="paramname"><em>event</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="wut__types_8h.html#a975dbe9e4396bf9e0064ce01827fa372">BOOL</a>&#160;</td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__coreinit__event.html#ga2d1b8c1aaa6e238daac84212cd597d02">OSEventMode</a>&#160;</td>
<td class="paramname"><em>mode</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *&#160;</td>
<td class="paramname"><em>name</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialise an event object with value, mode and name. </p>
</div>
</div>
<a id="ga18f11bbc98f004476e1b7ef5b72b20b4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga18f11bbc98f004476e1b7ef5b72b20b4">&#9670;&nbsp;</a></span>OSSignalEvent()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void OSSignalEvent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__coreinit__event.html#structOSEvent">OSEvent</a> *&#160;</td>
<td class="paramname"><em>event</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Signals the event. </p>
<p>If no threads are waiting the event value is set.</p>
<p>If the event mode is OS_EVENT_MODE_MANUAL this will wake all waiting threads and the event will remain set until OSResetEvent is called.</p>
<p>If the event mode is OS_EVENT_MODE_AUTO this will wake only one thread and the event will be reset immediately.</p>
<p>Similar to <a href="https://msdn.microsoft.com/en-us/library/windows/desktop/ms686211(v=vs.85).aspx">SetEvent</a>. </p>
</div>
</div>
<a id="ga8e66a2b0c064dd3b280fbb474dd4d083"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8e66a2b0c064dd3b280fbb474dd4d083">&#9670;&nbsp;</a></span>OSSignalEventAll()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void OSSignalEventAll </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__coreinit__event.html#structOSEvent">OSEvent</a> *&#160;</td>
<td class="paramname"><em>event</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Signals all threads waiting on an event. </p>
<p>If no threads are waiting the event value is set.</p>
<p>If the event mode is OS_EVENT_MODE_MANUAL this will wake all waiting threads and the event will remain set until OSResetEvent is called.</p>
<p>If the event mode is OS_EVENT_MODE_AUTO this will wake all waiting threads and the event will be reset. </p>
</div>
</div>
<a id="ga3c1778dbfa0b9ae29248d4b8fe481c11"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3c1778dbfa0b9ae29248d4b8fe481c11">&#9670;&nbsp;</a></span>OSWaitEvent()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void OSWaitEvent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__coreinit__event.html#structOSEvent">OSEvent</a> *&#160;</td>
<td class="paramname"><em>event</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Wait until an event is signalled. </p>
<p>If the event is already set, this returns immediately.</p>
<p>If the event mode is OS_EVENT_MODE_AUTO the event will be reset before returning from this method.</p>
<p>Similar to <a href="https://msdn.microsoft.com/en-us/library/windows/desktop/ms687032(v=vs.85).aspx">WaitForSingleObject</a>. </p>
</div>
</div>
<a id="ga27699986af3f6eee35c6cda0033d071c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga27699986af3f6eee35c6cda0033d071c">&#9670;&nbsp;</a></span>OSResetEvent()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void OSResetEvent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__coreinit__event.html#structOSEvent">OSEvent</a> *&#160;</td>
<td class="paramname"><em>event</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Resets the event object. </p>
<p>Similar to <a href="https://msdn.microsoft.com/en-us/library/windows/desktop/ms685081(v=vs.85).aspx">ResetEvent</a>. </p>
</div>
</div>
<a id="gaf35db0845e7b82bff1376df3564174b4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf35db0845e7b82bff1376df3564174b4">&#9670;&nbsp;</a></span>OSWaitEventWithTimeout()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="wut__types_8h.html#a975dbe9e4396bf9e0064ce01827fa372">BOOL</a> OSWaitEventWithTimeout </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__coreinit__event.html#structOSEvent">OSEvent</a> *&#160;</td>
<td class="paramname"><em>event</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__coreinit__time.html#ga4d4f771188f6c29e758ed6b3b8347b4d">OSTime</a>&#160;</td>
<td class="paramname"><em>timeout</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Wait until an event is signalled or a timeout has occurred. </p>
<p>Similar to <a href="https://msdn.microsoft.com/en-us/library/windows/desktop/ms687032(v=vs.85).aspx">WaitForSingleObject</a>. </p>
</div>
</div>
</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.17
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink