libnx/uevent_8h.html
2025-05-08 06:59:12 +00:00

215 lines
11 KiB
HTML

<!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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libnx: include/switch/kernel/uevent.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 id="projectrow">
<td id="projectalign">
<div id="projectname">libnx<span id="projectnumber">&#160;v4.9.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</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_42bea3d40f1f1694e41a8f3166c98108.html">switch</a></li><li class="navelem"><a class="el" href="dir_36b4ff30955378a33ed199d75bfba1a9.html">kernel</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">uevent.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>User-mode event synchronization primitive.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="wait_8h_source.html">wait.h</a>&quot;</code><br />
</div>
<p><a href="uevent_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 id="nested-classes" name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structUEvent.html">UEvent</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">User-mode event object. <a href="structUEvent.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ab75b2622b68fa65ebbf16e4d1bac400d" id="r_ab75b2622b68fa65ebbf16e4d1bac400d"><td class="memItemLeft" align="right" valign="top"><a id="ab75b2622b68fa65ebbf16e4d1bac400d" name="ab75b2622b68fa65ebbf16e4d1bac400d"></a>
static <a class="el" href="structWaiter.html">Waiter</a>&#160;</td><td class="memItemRight" valign="bottom"><b>waiterForUEvent</b> (<a class="el" href="structUEvent.html">UEvent</a> *e)</td></tr>
<tr class="memdesc:ab75b2622b68fa65ebbf16e4d1bac400d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a waiter for a user-mode event. <br /></td></tr>
<tr class="separator:ab75b2622b68fa65ebbf16e4d1bac400d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae90845ef66c2359cbc1b4969ed570ab1" id="r_ae90845ef66c2359cbc1b4969ed570ab1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="uevent_8h.html#ae90845ef66c2359cbc1b4969ed570ab1">ueventCreate</a> (<a class="el" href="structUEvent.html">UEvent</a> *e, bool auto_clear)</td></tr>
<tr class="memdesc:ae90845ef66c2359cbc1b4969ed570ab1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a user-mode event. <br /></td></tr>
<tr class="separator:ae90845ef66c2359cbc1b4969ed570ab1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adf0807e6a514b9a31f4e0ed74485357e" id="r_adf0807e6a514b9a31f4e0ed74485357e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="uevent_8h.html#adf0807e6a514b9a31f4e0ed74485357e">ueventClear</a> (<a class="el" href="structUEvent.html">UEvent</a> *e)</td></tr>
<tr class="memdesc:adf0807e6a514b9a31f4e0ed74485357e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clears the event signal. <br /></td></tr>
<tr class="separator:adf0807e6a514b9a31f4e0ed74485357e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac7b1648405299ea5cf3d7850b9b10aa7" id="r_ac7b1648405299ea5cf3d7850b9b10aa7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="uevent_8h.html#ac7b1648405299ea5cf3d7850b9b10aa7">ueventSignal</a> (<a class="el" href="structUEvent.html">UEvent</a> *e)</td></tr>
<tr class="memdesc:ac7b1648405299ea5cf3d7850b9b10aa7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Signals the event. <br /></td></tr>
<tr class="separator:ac7b1648405299ea5cf3d7850b9b10aa7"><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>User-mode event synchronization primitive. </p>
<dl class="section author"><dt>Author</dt><dd>plutoo </dd></dl>
<dl class="section copyright"><dt>Copyright</dt><dd>libnx Authors </dd></dl>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="adf0807e6a514b9a31f4e0ed74485357e" name="adf0807e6a514b9a31f4e0ed74485357e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adf0807e6a514b9a31f4e0ed74485357e">&#9670;&#160;</a></span>ueventClear()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ueventClear </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structUEvent.html">UEvent</a> *&#160;</td>
<td class="paramname"><em>e</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Clears the event signal. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">e</td><td><a class="el" href="structUEvent.html" title="User-mode event object.">UEvent</a> object. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ae90845ef66c2359cbc1b4969ed570ab1" name="ae90845ef66c2359cbc1b4969ed570ab1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae90845ef66c2359cbc1b4969ed570ab1">&#9670;&#160;</a></span>ueventCreate()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ueventCreate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structUEvent.html">UEvent</a> *&#160;</td>
<td class="paramname"><em>e</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>auto_clear</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a user-mode event. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">e</td><td><a class="el" href="structUEvent.html" title="User-mode event object.">UEvent</a> object. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">auto_clear</td><td>Whether to automatically clear the event. </td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>It is safe to wait on this event with several threads simultaneously. </dd>
<dd>
If more than one thread is listening on it, at least one thread will get the signal. No other guarantees. </dd></dl>
</div>
</div>
<a id="ac7b1648405299ea5cf3d7850b9b10aa7" name="ac7b1648405299ea5cf3d7850b9b10aa7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac7b1648405299ea5cf3d7850b9b10aa7">&#9670;&#160;</a></span>ueventSignal()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ueventSignal </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structUEvent.html">UEvent</a> *&#160;</td>
<td class="paramname"><em>e</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Signals the event. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">e</td><td><a class="el" href="structUEvent.html" title="User-mode event object.">UEvent</a> object. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>