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

376 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/rwlock.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">rwlock.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Read/write lock synchronization primitive.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="mutex_8h_source.html">../kernel/mutex.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="condvar_8h_source.html">../kernel/condvar.h</a>&quot;</code><br />
</div>
<p><a href="rwlock_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="structRwLock.html">RwLock</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read/write lock structure. <a href="structRwLock.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:aefbfc9e21aa88c421ca09d0c1cacaf91" id="r_aefbfc9e21aa88c421ca09d0c1cacaf91"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="rwlock_8h.html#aefbfc9e21aa88c421ca09d0c1cacaf91">rwlockInit</a> (<a class="el" href="structRwLock.html">RwLock</a> *r)</td></tr>
<tr class="memdesc:aefbfc9e21aa88c421ca09d0c1cacaf91"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes the read/write lock. <br /></td></tr>
<tr class="separator:aefbfc9e21aa88c421ca09d0c1cacaf91"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af4686bff28dba24ce1b9aa552109f740" id="r_af4686bff28dba24ce1b9aa552109f740"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="rwlock_8h.html#af4686bff28dba24ce1b9aa552109f740">rwlockReadLock</a> (<a class="el" href="structRwLock.html">RwLock</a> *r)</td></tr>
<tr class="memdesc:af4686bff28dba24ce1b9aa552109f740"><td class="mdescLeft">&#160;</td><td class="mdescRight">Locks the read/write lock for reading. <br /></td></tr>
<tr class="separator:af4686bff28dba24ce1b9aa552109f740"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4a743ae934e413693e20a2e38ec0569d" id="r_a4a743ae934e413693e20a2e38ec0569d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="rwlock_8h.html#a4a743ae934e413693e20a2e38ec0569d">rwlockTryReadLock</a> (<a class="el" href="structRwLock.html">RwLock</a> *r)</td></tr>
<tr class="memdesc:a4a743ae934e413693e20a2e38ec0569d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Attempts to lock the read/write lock for reading without waiting. <br /></td></tr>
<tr class="separator:a4a743ae934e413693e20a2e38ec0569d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaedf3ac67e4ff6bd8407d530ce6579bb" id="r_aaedf3ac67e4ff6bd8407d530ce6579bb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="rwlock_8h.html#aaedf3ac67e4ff6bd8407d530ce6579bb">rwlockReadUnlock</a> (<a class="el" href="structRwLock.html">RwLock</a> *r)</td></tr>
<tr class="memdesc:aaedf3ac67e4ff6bd8407d530ce6579bb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unlocks the read/write lock for reading. <br /></td></tr>
<tr class="separator:aaedf3ac67e4ff6bd8407d530ce6579bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8d4224ba82b14a7df4f102e9c4d3f36a" id="r_a8d4224ba82b14a7df4f102e9c4d3f36a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="rwlock_8h.html#a8d4224ba82b14a7df4f102e9c4d3f36a">rwlockWriteLock</a> (<a class="el" href="structRwLock.html">RwLock</a> *r)</td></tr>
<tr class="memdesc:a8d4224ba82b14a7df4f102e9c4d3f36a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Locks the read/write lock for writing. <br /></td></tr>
<tr class="separator:a8d4224ba82b14a7df4f102e9c4d3f36a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1e947b119ba2e6a120f37d79a605baf0" id="r_a1e947b119ba2e6a120f37d79a605baf0"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="rwlock_8h.html#a1e947b119ba2e6a120f37d79a605baf0">rwlockTryWriteLock</a> (<a class="el" href="structRwLock.html">RwLock</a> *r)</td></tr>
<tr class="memdesc:a1e947b119ba2e6a120f37d79a605baf0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Attempts to lock the read/write lock for writing without waiting. <br /></td></tr>
<tr class="separator:a1e947b119ba2e6a120f37d79a605baf0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a14f75537e3015e7031cdac05914da56e" id="r_a14f75537e3015e7031cdac05914da56e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="rwlock_8h.html#a14f75537e3015e7031cdac05914da56e">rwlockWriteUnlock</a> (<a class="el" href="structRwLock.html">RwLock</a> *r)</td></tr>
<tr class="memdesc:a14f75537e3015e7031cdac05914da56e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unlocks the read/write lock for writing. <br /></td></tr>
<tr class="separator:a14f75537e3015e7031cdac05914da56e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae187bd2b121b65d1c4b7c94ec8f925a5" id="r_ae187bd2b121b65d1c4b7c94ec8f925a5"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="rwlock_8h.html#ae187bd2b121b65d1c4b7c94ec8f925a5">rwlockIsWriteLockHeldByCurrentThread</a> (<a class="el" href="structRwLock.html">RwLock</a> *r)</td></tr>
<tr class="memdesc:ae187bd2b121b65d1c4b7c94ec8f925a5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if the write lock is held by the current thread. <br /></td></tr>
<tr class="separator:ae187bd2b121b65d1c4b7c94ec8f925a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a657d397c411d02fe8eeef33fe37245f4" id="r_a657d397c411d02fe8eeef33fe37245f4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="rwlock_8h.html#a657d397c411d02fe8eeef33fe37245f4">rwlockIsOwnedByCurrentThread</a> (<a class="el" href="structRwLock.html">RwLock</a> *r)</td></tr>
<tr class="memdesc:a657d397c411d02fe8eeef33fe37245f4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if the read/write lock is owned by the current thread. <br /></td></tr>
<tr class="separator:a657d397c411d02fe8eeef33fe37245f4"><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>Read/write lock synchronization primitive. </p>
<dl class="section author"><dt>Author</dt><dd>plutoo, SciresM </dd></dl>
<dl class="section copyright"><dt>Copyright</dt><dd>libnx Authors </dd></dl>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="aefbfc9e21aa88c421ca09d0c1cacaf91" name="aefbfc9e21aa88c421ca09d0c1cacaf91"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aefbfc9e21aa88c421ca09d0c1cacaf91">&#9670;&#160;</a></span>rwlockInit()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void rwlockInit </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structRwLock.html">RwLock</a> *&#160;</td>
<td class="paramname"><em>r</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initializes the read/write lock. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">r</td><td>Read/write lock object. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a657d397c411d02fe8eeef33fe37245f4" name="a657d397c411d02fe8eeef33fe37245f4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a657d397c411d02fe8eeef33fe37245f4">&#9670;&#160;</a></span>rwlockIsOwnedByCurrentThread()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool rwlockIsOwnedByCurrentThread </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structRwLock.html">RwLock</a> *&#160;</td>
<td class="paramname"><em>r</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks if the read/write lock is owned by the current thread. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">r</td><td>Read/write lock object. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>1 if the current hold holds the write lock or if it holds read locks acquired while it held the write lock, and 0 if it does not. </dd></dl>
</div>
</div>
<a id="ae187bd2b121b65d1c4b7c94ec8f925a5" name="ae187bd2b121b65d1c4b7c94ec8f925a5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae187bd2b121b65d1c4b7c94ec8f925a5">&#9670;&#160;</a></span>rwlockIsWriteLockHeldByCurrentThread()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool rwlockIsWriteLockHeldByCurrentThread </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structRwLock.html">RwLock</a> *&#160;</td>
<td class="paramname"><em>r</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks if the write lock is held by the current thread. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">r</td><td>Read/write lock object. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>1 if the current hold holds the write lock, and 0 if it does not. </dd></dl>
</div>
</div>
<a id="af4686bff28dba24ce1b9aa552109f740" name="af4686bff28dba24ce1b9aa552109f740"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af4686bff28dba24ce1b9aa552109f740">&#9670;&#160;</a></span>rwlockReadLock()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void rwlockReadLock </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structRwLock.html">RwLock</a> *&#160;</td>
<td class="paramname"><em>r</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Locks the read/write lock for reading. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">r</td><td>Read/write lock object. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aaedf3ac67e4ff6bd8407d530ce6579bb" name="aaedf3ac67e4ff6bd8407d530ce6579bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaedf3ac67e4ff6bd8407d530ce6579bb">&#9670;&#160;</a></span>rwlockReadUnlock()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void rwlockReadUnlock </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structRwLock.html">RwLock</a> *&#160;</td>
<td class="paramname"><em>r</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Unlocks the read/write lock for reading. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">r</td><td>Read/write lock object. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a4a743ae934e413693e20a2e38ec0569d" name="a4a743ae934e413693e20a2e38ec0569d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4a743ae934e413693e20a2e38ec0569d">&#9670;&#160;</a></span>rwlockTryReadLock()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool rwlockTryReadLock </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structRwLock.html">RwLock</a> *&#160;</td>
<td class="paramname"><em>r</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Attempts to lock the read/write lock for reading without waiting. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">r</td><td>Read/write lock object. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>1 if the mutex has been acquired successfully, and 0 on contention. </dd></dl>
</div>
</div>
<a id="a1e947b119ba2e6a120f37d79a605baf0" name="a1e947b119ba2e6a120f37d79a605baf0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1e947b119ba2e6a120f37d79a605baf0">&#9670;&#160;</a></span>rwlockTryWriteLock()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool rwlockTryWriteLock </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structRwLock.html">RwLock</a> *&#160;</td>
<td class="paramname"><em>r</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Attempts to lock the read/write lock for writing without waiting. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">r</td><td>Read/write lock object. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>1 if the mutex has been acquired successfully, and 0 on contention. </dd></dl>
</div>
</div>
<a id="a8d4224ba82b14a7df4f102e9c4d3f36a" name="a8d4224ba82b14a7df4f102e9c4d3f36a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8d4224ba82b14a7df4f102e9c4d3f36a">&#9670;&#160;</a></span>rwlockWriteLock()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void rwlockWriteLock </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structRwLock.html">RwLock</a> *&#160;</td>
<td class="paramname"><em>r</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Locks the read/write lock for writing. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">r</td><td>Read/write lock object. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a14f75537e3015e7031cdac05914da56e" name="a14f75537e3015e7031cdac05914da56e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a14f75537e3015e7031cdac05914da56e">&#9670;&#160;</a></span>rwlockWriteUnlock()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void rwlockWriteUnlock </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structRwLock.html">RwLock</a> *&#160;</td>
<td class="paramname"><em>r</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Unlocks the read/write lock for writing. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">r</td><td>Read/write lock 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>
Reference in New Issue View Git Blame Copy Permalink