Files
wut/mutex_8h.html
2026-02-21 12:43:12 +00:00

175 lines
13 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>wut: /home/runner/work/wut/wut/include/coreinit/mutex.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">wut<span id="projectnumber">&#160;v1.9.1</span>
</div>
<div id="projectbrief">Wii U Toolchain</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_5050f3de292bd66075be80c4b119f1df.html">coreinit</a></li> </ul>
</div>
</div><!-- top -->
<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="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">mutex.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;<a class="el" href="wut_8h_source.html">wut.h</a>&gt;</code><br />
<code>#include &quot;<a class="el" href="threadqueue_8h_source.html">threadqueue.h</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for mutex.h:</div>
<div class="dyncontent">
<div class="center"><img src="mutex_8h__incl.png" border="0" usemap="#a_2home_2runner_2work_2wut_2wut_2include_2coreinit_2mutex_8h" alt=""/></div>
<map name="a_2home_2runner_2work_2wut_2wut_2include_2coreinit_2mutex_8h" id="a_2home_2runner_2work_2wut_2wut_2include_2coreinit_2mutex_8h">
<area shape="rect" title=" " alt="" coords="122,5,295,60"/>
<area shape="rect" href="wut_8h.html" title=" " alt="" coords="179,181,238,207"/>
<area shape="poly" title=" " alt="" coords="199,61,189,95,189,133,200,168,195,170,183,134,184,94,194,59"/>
<area shape="rect" href="threadqueue_8h.html" title=" " alt="" coords="199,108,315,133"/>
<area shape="poly" title=" " alt="" coords="226,59,246,95,241,97,221,61"/>
<area shape="rect" title=" " alt="" coords="6,255,134,280"/>
<area shape="poly" title=" " alt="" coords="188,209,106,251,104,246,185,204"/>
<area shape="rect" href="wut__types_8h.html" title=" " alt="" coords="158,255,259,280"/>
<area shape="poly" title=" " alt="" coords="211,207,211,241,206,241,206,207"/>
<area shape="rect" href="wut__rplwrap_8h.html" title=" " alt="" coords="283,255,398,280"/>
<area shape="poly" title=" " alt="" coords="231,204,308,246,306,250,229,209"/>
<area shape="rect" title=" " alt="" coords="5,328,92,353"/>
<area shape="poly" title=" " alt="" coords="184,282,88,325,86,320,182,278"/>
<area shape="rect" title=" " alt="" coords="117,328,199,353"/>
<area shape="poly" title=" " alt="" coords="202,282,176,318,172,315,198,279"/>
<area shape="rect" title=" " alt="" coords="223,328,298,353"/>
<area shape="poly" title=" " alt="" coords="219,279,246,315,242,318,215,282"/>
<area shape="rect" title=" " alt="" coords="323,328,393,353"/>
<area shape="poly" title=" " alt="" coords="234,278,322,320,320,324,232,282"/>
<area shape="poly" title=" " alt="" coords="251,135,226,172,222,169,247,132"/>
</map>
</div>
</div><div class="textblock"><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><img src="mutex_8h__dep__incl.png" border="0" usemap="#a_2home_2runner_2work_2wut_2wut_2include_2coreinit_2mutex_8hdep" alt=""/></div>
<map name="a_2home_2runner_2work_2wut_2wut_2include_2coreinit_2mutex_8hdep" id="a_2home_2runner_2work_2wut_2wut_2include_2coreinit_2mutex_8hdep">
<area shape="rect" title=" " alt="" coords="111,5,284,60"/>
<area shape="rect" href="ipcbufpool_8h.html" title=" " alt="" coords="5,108,179,163"/>
<area shape="poly" title=" " alt="" coords="162,72,121,110,118,106,158,68"/>
<area shape="rect" href="smd_8h.html" title=" " alt="" coords="203,115,402,155"/>
<area shape="poly" title=" " alt="" coords="237,68,284,113,281,117,233,71"/>
</map>
</div>
</div>
<p><a href="mutex_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:structOSMutexLink" id="r_structOSMutexLink"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__mutex.html#structOSMutexLink">OSMutexLink</a></td></tr>
<tr class="separator:structOSMutexLink"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:structOSMutex" id="r_structOSMutex"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__mutex.html#structOSMutex">OSMutex</a></td></tr>
<tr class="separator:structOSMutex"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga30202e2a89cd5859a39b31a3f636cdca" id="r_ga30202e2a89cd5859a39b31a3f636cdca"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__mutex.html#ga30202e2a89cd5859a39b31a3f636cdca">OS_MUTEX_TAG</a>&#160;&#160;&#160;0x6D557458u</td></tr>
<tr class="separator:ga30202e2a89cd5859a39b31a3f636cdca"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:ga21cc46877b04baece01ef544fa06a906" id="r_ga21cc46877b04baece01ef544fa06a906"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="group__coreinit__thread.html#structOSThread">OSThread</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__mutex.html#ga21cc46877b04baece01ef544fa06a906">OSThread</a></td></tr>
<tr class="separator:ga21cc46877b04baece01ef544fa06a906"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga42b7c5a07043d7f6c8324f51ac1747c8" id="r_ga42b7c5a07043d7f6c8324f51ac1747c8"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="group__coreinit__mutex.html#structOSMutex">OSMutex</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__mutex.html#ga42b7c5a07043d7f6c8324f51ac1747c8">OSMutex</a></td></tr>
<tr class="separator:ga42b7c5a07043d7f6c8324f51ac1747c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga02c300c2030e332ddab54fba6272d821" id="r_ga02c300c2030e332ddab54fba6272d821"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="group__coreinit__mutex.html#structOSMutexLink">OSMutexLink</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__mutex.html#ga02c300c2030e332ddab54fba6272d821">OSMutexLink</a></td></tr>
<tr class="separator:ga02c300c2030e332ddab54fba6272d821"><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:ga03d1b0af602295a14f6df01d5a0aa12e" id="r_ga03d1b0af602295a14f6df01d5a0aa12e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__mutex.html#ga03d1b0af602295a14f6df01d5a0aa12e">OSInitMutex</a> (<a class="el" href="group__coreinit__mutex.html#structOSMutex">OSMutex</a> *mutex)</td></tr>
<tr class="memdesc:ga03d1b0af602295a14f6df01d5a0aa12e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialise a mutex structure. <br /></td></tr>
<tr class="separator:ga03d1b0af602295a14f6df01d5a0aa12e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7bfdd3b29adc53f3fc206934d80c13e7" id="r_ga7bfdd3b29adc53f3fc206934d80c13e7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__mutex.html#ga7bfdd3b29adc53f3fc206934d80c13e7">OSInitMutexEx</a> (<a class="el" href="group__coreinit__mutex.html#structOSMutex">OSMutex</a> *mutex, const char *name)</td></tr>
<tr class="memdesc:ga7bfdd3b29adc53f3fc206934d80c13e7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialise a mutex structure with a name. <br /></td></tr>
<tr class="separator:ga7bfdd3b29adc53f3fc206934d80c13e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac540b8ab45b64548e31395f193f0fc49" id="r_gac540b8ab45b64548e31395f193f0fc49"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__mutex.html#gac540b8ab45b64548e31395f193f0fc49">OSLockMutex</a> (<a class="el" href="group__coreinit__mutex.html#structOSMutex">OSMutex</a> *mutex)</td></tr>
<tr class="memdesc:gac540b8ab45b64548e31395f193f0fc49"><td class="mdescLeft">&#160;</td><td class="mdescRight">Lock the mutex. <br /></td></tr>
<tr class="separator:gac540b8ab45b64548e31395f193f0fc49"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5892ff24353a07eaec68242ef44998d2" id="r_ga5892ff24353a07eaec68242ef44998d2"><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__mutex.html#ga5892ff24353a07eaec68242ef44998d2">OSTryLockMutex</a> (<a class="el" href="group__coreinit__mutex.html#structOSMutex">OSMutex</a> *mutex)</td></tr>
<tr class="memdesc:ga5892ff24353a07eaec68242ef44998d2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Try to lock a mutex. <br /></td></tr>
<tr class="separator:ga5892ff24353a07eaec68242ef44998d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabdcea1245d3bf588114b33e213892d6f" id="r_gabdcea1245d3bf588114b33e213892d6f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__mutex.html#gabdcea1245d3bf588114b33e213892d6f">OSUnlockMutex</a> (<a class="el" href="group__coreinit__mutex.html#structOSMutex">OSMutex</a> *mutex)</td></tr>
<tr class="memdesc:gabdcea1245d3bf588114b33e213892d6f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unlocks the mutex. <br /></td></tr>
<tr class="separator:gabdcea1245d3bf588114b33e213892d6f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</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>