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

374 lines
19 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/condvar.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="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">condvar.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Condition variable synchronization primitive.
<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="svc_8h_source.html">../kernel/svc.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="mutex_8h_source.html">../kernel/mutex.h</a>&quot;</code><br />
</div>
<p><a href="condvar_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="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:aae8dd0591cb6fe4a1077118947220f55" id="r_aae8dd0591cb6fe4a1077118947220f55"><td class="memItemLeft" align="right" valign="top"><a id="aae8dd0591cb6fe4a1077118947220f55" name="aae8dd0591cb6fe4a1077118947220f55"></a>
typedef <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>&#160;</td><td class="memItemRight" valign="bottom"><b>CondVar</b></td></tr>
<tr class="memdesc:aae8dd0591cb6fe4a1077118947220f55"><td class="mdescLeft">&#160;</td><td class="mdescRight">Condition variable. <br /></td></tr>
<tr class="separator:aae8dd0591cb6fe4a1077118947220f55"><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:a5182abd86302ee242efde30b96146d01" id="r_a5182abd86302ee242efde30b96146d01"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="condvar_8h.html#a5182abd86302ee242efde30b96146d01">condvarInit</a> (<a class="el" href="condvar_8h.html#aae8dd0591cb6fe4a1077118947220f55">CondVar</a> *c)</td></tr>
<tr class="memdesc:a5182abd86302ee242efde30b96146d01"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes a condition variable. <br /></td></tr>
<tr class="separator:a5182abd86302ee242efde30b96146d01"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a112b9205478a71036d3eedf3d141149c" id="r_a112b9205478a71036d3eedf3d141149c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="condvar_8h.html#a112b9205478a71036d3eedf3d141149c">condvarWaitTimeout</a> (<a class="el" href="condvar_8h.html#aae8dd0591cb6fe4a1077118947220f55">CondVar</a> *c, <a class="el" href="mutex_8h.html#a2d649c880d4330dc891cda67837eb897">Mutex</a> *m, <a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> timeout)</td></tr>
<tr class="memdesc:a112b9205478a71036d3eedf3d141149c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Waits on a condition variable with a timeout. <br /></td></tr>
<tr class="separator:a112b9205478a71036d3eedf3d141149c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a909b25f3dd32c54ac4d9b88b2508945a" id="r_a909b25f3dd32c54ac4d9b88b2508945a"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="condvar_8h.html#a909b25f3dd32c54ac4d9b88b2508945a">condvarWait</a> (<a class="el" href="condvar_8h.html#aae8dd0591cb6fe4a1077118947220f55">CondVar</a> *c, <a class="el" href="mutex_8h.html#a2d649c880d4330dc891cda67837eb897">Mutex</a> *m)</td></tr>
<tr class="memdesc:a909b25f3dd32c54ac4d9b88b2508945a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Waits on a condition variable. <br /></td></tr>
<tr class="separator:a909b25f3dd32c54ac4d9b88b2508945a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a338da4e7731169a3dd983996d017a0d8" id="r_a338da4e7731169a3dd983996d017a0d8"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="condvar_8h.html#a338da4e7731169a3dd983996d017a0d8">condvarWake</a> (<a class="el" href="condvar_8h.html#aae8dd0591cb6fe4a1077118947220f55">CondVar</a> *c, int num)</td></tr>
<tr class="memdesc:a338da4e7731169a3dd983996d017a0d8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wakes up up to the specified number of threads waiting on a condition variable. <br /></td></tr>
<tr class="separator:a338da4e7731169a3dd983996d017a0d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac7c17938f1064c5aca215f7cdc0b89c8" id="r_ac7c17938f1064c5aca215f7cdc0b89c8"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="condvar_8h.html#ac7c17938f1064c5aca215f7cdc0b89c8">condvarWakeOne</a> (<a class="el" href="condvar_8h.html#aae8dd0591cb6fe4a1077118947220f55">CondVar</a> *c)</td></tr>
<tr class="memdesc:ac7c17938f1064c5aca215f7cdc0b89c8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wakes up a single thread waiting on a condition variable. <br /></td></tr>
<tr class="separator:ac7c17938f1064c5aca215f7cdc0b89c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a22ee69acf725efc3684b69f9f508e085" id="r_a22ee69acf725efc3684b69f9f508e085"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="condvar_8h.html#a22ee69acf725efc3684b69f9f508e085">condvarWakeAll</a> (<a class="el" href="condvar_8h.html#aae8dd0591cb6fe4a1077118947220f55">CondVar</a> *c)</td></tr>
<tr class="memdesc:a22ee69acf725efc3684b69f9f508e085"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wakes up all thread waiting on a condition variable. <br /></td></tr>
<tr class="separator:a22ee69acf725efc3684b69f9f508e085"><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>Condition variable 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="a5182abd86302ee242efde30b96146d01" name="a5182abd86302ee242efde30b96146d01"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5182abd86302ee242efde30b96146d01">&#9670;&#160;</a></span>condvarInit()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void condvarInit </td>
<td>(</td>
<td class="paramtype"><a class="el" href="condvar_8h.html#aae8dd0591cb6fe4a1077118947220f55">CondVar</a> *&#160;</td>
<td class="paramname"><em>c</em></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 condition variable. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">c</td><td>Condition variable object. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a909b25f3dd32c54ac4d9b88b2508945a" name="a909b25f3dd32c54ac4d9b88b2508945a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a909b25f3dd32c54ac4d9b88b2508945a">&#9670;&#160;</a></span>condvarWait()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> condvarWait </td>
<td>(</td>
<td class="paramtype"><a class="el" href="condvar_8h.html#aae8dd0591cb6fe4a1077118947220f55">CondVar</a> *&#160;</td>
<td class="paramname"><em>c</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="mutex_8h.html#a2d649c880d4330dc891cda67837eb897">Mutex</a> *&#160;</td>
<td class="paramname"><em>m</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>Waits on a condition variable. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">c</td><td>Condition variable object. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">m</td><td>Mutex object to use inside the condition variable. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Result code. </dd></dl>
<dl class="section remark"><dt>Remarks</dt><dd>On function return, the underlying mutex is acquired. </dd></dl>
</div>
</div>
<a id="a112b9205478a71036d3eedf3d141149c" name="a112b9205478a71036d3eedf3d141149c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a112b9205478a71036d3eedf3d141149c">&#9670;&#160;</a></span>condvarWaitTimeout()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> condvarWaitTimeout </td>
<td>(</td>
<td class="paramtype"><a class="el" href="condvar_8h.html#aae8dd0591cb6fe4a1077118947220f55">CondVar</a> *&#160;</td>
<td class="paramname"><em>c</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="mutex_8h.html#a2d649c880d4330dc891cda67837eb897">Mutex</a> *&#160;</td>
<td class="paramname"><em>m</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</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Waits on a condition variable with a timeout. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">c</td><td>Condition variable object. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">m</td><td>Mutex object to use inside the condition variable. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">timeout</td><td>Timeout in nanoseconds. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Result code (0xEA01 on timeout). </dd></dl>
<dl class="section remark"><dt>Remarks</dt><dd>On function return, the underlying mutex is acquired. </dd></dl>
</div>
</div>
<a id="a338da4e7731169a3dd983996d017a0d8" name="a338da4e7731169a3dd983996d017a0d8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a338da4e7731169a3dd983996d017a0d8">&#9670;&#160;</a></span>condvarWake()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> condvarWake </td>
<td>(</td>
<td class="paramtype"><a class="el" href="condvar_8h.html#aae8dd0591cb6fe4a1077118947220f55">CondVar</a> *&#160;</td>
<td class="paramname"><em>c</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>num</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>Wakes up up to the specified number of threads waiting on a condition variable. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">c</td><td>Condition variable object. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">num</td><td>Maximum number of threads to wake up (or -1 to wake them all up). </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Result code. </dd></dl>
</div>
</div>
<a id="a22ee69acf725efc3684b69f9f508e085" name="a22ee69acf725efc3684b69f9f508e085"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a22ee69acf725efc3684b69f9f508e085">&#9670;&#160;</a></span>condvarWakeAll()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> condvarWakeAll </td>
<td>(</td>
<td class="paramtype"><a class="el" href="condvar_8h.html#aae8dd0591cb6fe4a1077118947220f55">CondVar</a> *&#160;</td>
<td class="paramname"><em>c</em></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>Wakes up all thread waiting on a condition variable. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">c</td><td>Condition variable object. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Result code. </dd></dl>
</div>
</div>
<a id="ac7c17938f1064c5aca215f7cdc0b89c8" name="ac7c17938f1064c5aca215f7cdc0b89c8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac7c17938f1064c5aca215f7cdc0b89c8">&#9670;&#160;</a></span>condvarWakeOne()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> condvarWakeOne </td>
<td>(</td>
<td class="paramtype"><a class="el" href="condvar_8h.html#aae8dd0591cb6fe4a1077118947220f55">CondVar</a> *&#160;</td>
<td class="paramname"><em>c</em></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>Wakes up a single thread waiting on a condition variable. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">c</td><td>Condition variable object. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Result code. </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