mika/libnx
1
0
Fork 0
mirror of https://github.com/switchbrew/libnx.git synced 2025-06-21 12:32:40 +02:00
Code Issues Packages Projects Releases Wiki Activity
gh-pages
libnx/levent_8h.html
WinterMute bf00061749 Deploying to gh-pages from @ 29f6f4fa7a 🚀
2025-05-08 06:59:12 +00:00

296 lines
14 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" 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/levent.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">levent.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Light event synchronization primitive [4.0.0+].
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="types_8h_source.html">../types.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="result_8h_source.html">../result.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="svc_8h_source.html">svc.h</a>&quot;</code><br />
</div>
<p><a href="levent_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="structLEvent.html">LEvent</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">User-mode light event structure. <a href="structLEvent.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:a2496108d9905cdf20d14189c2bf04f44" id="r_a2496108d9905cdf20d14189c2bf04f44"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="levent_8h.html#a2496108d9905cdf20d14189c2bf04f44">leventInit</a> (<a class="el" href="structLEvent.html">LEvent</a> *le, bool signaled, bool autoclear)</td></tr>
<tr class="memdesc:a2496108d9905cdf20d14189c2bf04f44"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes a user-mode light event. <br /></td></tr>
<tr class="separator:a2496108d9905cdf20d14189c2bf04f44"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a585115dbfe161aeba5646c708276f6df" id="r_a585115dbfe161aeba5646c708276f6df"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="levent_8h.html#a585115dbfe161aeba5646c708276f6df">leventWait</a> (<a class="el" href="structLEvent.html">LEvent</a> *le, <a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> timeout_ns)</td></tr>
<tr class="memdesc:a585115dbfe161aeba5646c708276f6df"><td class="mdescLeft">&#160;</td><td class="mdescRight">Waits on a user-mode light event. <br /></td></tr>
<tr class="separator:a585115dbfe161aeba5646c708276f6df"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af1f2b5065b0dc51847a39b2f53a5f462" id="r_af1f2b5065b0dc51847a39b2f53a5f462"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="levent_8h.html#af1f2b5065b0dc51847a39b2f53a5f462">leventTryWait</a> (<a class="el" href="structLEvent.html">LEvent</a> *le)</td></tr>
<tr class="memdesc:af1f2b5065b0dc51847a39b2f53a5f462"><td class="mdescLeft">&#160;</td><td class="mdescRight">Polls a user-mode light event. <br /></td></tr>
<tr class="separator:af1f2b5065b0dc51847a39b2f53a5f462"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a947dadc8c57ec9631826f7b3d0a7641e" id="r_a947dadc8c57ec9631826f7b3d0a7641e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="levent_8h.html#a947dadc8c57ec9631826f7b3d0a7641e">leventSignal</a> (<a class="el" href="structLEvent.html">LEvent</a> *le)</td></tr>
<tr class="memdesc:a947dadc8c57ec9631826f7b3d0a7641e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Signals a user-mode light event. <br /></td></tr>
<tr class="separator:a947dadc8c57ec9631826f7b3d0a7641e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1414c8d6b33ef406745ee1c16ee194c3" id="r_a1414c8d6b33ef406745ee1c16ee194c3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="levent_8h.html#a1414c8d6b33ef406745ee1c16ee194c3">leventClear</a> (<a class="el" href="structLEvent.html">LEvent</a> *le)</td></tr>
<tr class="memdesc:a1414c8d6b33ef406745ee1c16ee194c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clears a user-mode light event. <br /></td></tr>
<tr class="separator:a1414c8d6b33ef406745ee1c16ee194c3"><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>Light event synchronization primitive [4.0.0+]. </p>
<dl class="section author"><dt>Author</dt><dd>fincs </dd></dl>
<dl class="section copyright"><dt>Copyright</dt><dd>libnx Authors </dd></dl>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a1414c8d6b33ef406745ee1c16ee194c3" name="a1414c8d6b33ef406745ee1c16ee194c3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1414c8d6b33ef406745ee1c16ee194c3">&#9670;&#160;</a></span>leventClear()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void leventClear </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structLEvent.html">LEvent</a> *&#160;</td>
<td class="paramname"><em>le</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Clears a user-mode light event. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">le</td><td>Pointer to <a class="el" href="structLEvent.html">LEvent</a> structure. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a2496108d9905cdf20d14189c2bf04f44" name="a2496108d9905cdf20d14189c2bf04f44"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2496108d9905cdf20d14189c2bf04f44">&#9670;&#160;</a></span>leventInit()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void leventInit </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structLEvent.html">LEvent</a> *&#160;</td>
<td class="paramname"><em>le</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>signaled</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>autoclear</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Initializes a user-mode light event. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">le</td><td>Pointer to <a class="el" href="structLEvent.html">LEvent</a> structure. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">signaled</td><td>Whether the event starts off in signaled state. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">autoclear</td><td>Autoclear flag. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a947dadc8c57ec9631826f7b3d0a7641e" name="a947dadc8c57ec9631826f7b3d0a7641e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a947dadc8c57ec9631826f7b3d0a7641e">&#9670;&#160;</a></span>leventSignal()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void leventSignal </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structLEvent.html">LEvent</a> *&#160;</td>
<td class="paramname"><em>le</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Signals a user-mode light event. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">le</td><td>Pointer to <a class="el" href="structLEvent.html">LEvent</a> structure. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="af1f2b5065b0dc51847a39b2f53a5f462" name="af1f2b5065b0dc51847a39b2f53a5f462"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af1f2b5065b0dc51847a39b2f53a5f462">&#9670;&#160;</a></span>leventTryWait()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool leventTryWait </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structLEvent.html">LEvent</a> *&#160;</td>
<td class="paramname"><em>le</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Polls a user-mode light event. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">le</td><td>Pointer to <a class="el" href="structLEvent.html">LEvent</a> structure. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if event is signaled, false otherwise. </dd></dl>
</div>
</div>
<a id="a585115dbfe161aeba5646c708276f6df" name="a585115dbfe161aeba5646c708276f6df"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a585115dbfe161aeba5646c708276f6df">&#9670;&#160;</a></span>leventWait()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool leventWait </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structLEvent.html">LEvent</a> *&#160;</td>
<td class="paramname"><em>le</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a>&#160;</td>
<td class="paramname"><em>timeout_ns</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Waits on a user-mode light event. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">le</td><td>Pointer to <a class="el" href="structLEvent.html">LEvent</a> structure. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">timeout_ns</td><td>Timeout in nanoseconds (pass UINT64_MAX to wait indefinitely). </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if wait succeeded, false if wait timed out. </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>
Reference in New Issue View Git Blame Copy Permalink