| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354 |
- <!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>Torque2D Reference: Mutex Class 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" />
- <link href="t2d-stylesheet-extra.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">Torque2D Reference
- </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&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&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><!-- top -->
- <div class="header">
- <div class="summary">
- <a href="#pub-methods">Public Member Functions</a> |
- <a href="#pub-static-methods">Static Public Member Functions</a> |
- <a href="#pro-attribs">Protected Attributes</a> |
- <a href="class_mutex-members.html">List of all members</a> </div>
- <div class="headertitle"><div class="title">Mutex Class Reference</div></div>
- </div><!--header-->
- <div class="contents">
- <p><code>#include <mutex.h></code></p>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
- Public Member Functions</h2></td></tr>
- <tr class="memitem:a4b5dfbd24f5bc4c03b24b2da362f66d5" id="r_a4b5dfbd24f5bc4c03b24b2da362f66d5"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_mutex.html#a4b5dfbd24f5bc4c03b24b2da362f66d5">Mutex</a> ()</td></tr>
- <tr class="separator:a4b5dfbd24f5bc4c03b24b2da362f66d5"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a205e2c334b25cb96e4f1303a4fde6b0c" id="r_a205e2c334b25cb96e4f1303a4fde6b0c"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_mutex.html#a205e2c334b25cb96e4f1303a4fde6b0c">~Mutex</a> ()</td></tr>
- <tr class="separator:a205e2c334b25cb96e4f1303a4fde6b0c"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a4021c0d21891caafe409f68976596216" id="r_a4021c0d21891caafe409f68976596216"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_mutex.html#a4021c0d21891caafe409f68976596216">lock</a> (bool block=true)</td></tr>
- <tr class="separator:a4021c0d21891caafe409f68976596216"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a9278be8203e1c42e2619179882ae4403" id="r_a9278be8203e1c42e2619179882ae4403"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_mutex.html#a9278be8203e1c42e2619179882ae4403">unlock</a> ()</td></tr>
- <tr class="separator:a9278be8203e1c42e2619179882ae4403"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
- Static Public Member Functions</h2></td></tr>
- <tr class="memitem:a34a9ebaefd3cf673f98d0ce61ab25338" id="r_a34a9ebaefd3cf673f98d0ce61ab25338"><td class="memItemLeft" align="right" valign="top">static void * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_mutex.html#a34a9ebaefd3cf673f98d0ce61ab25338">createMutex</a> ()</td></tr>
- <tr class="separator:a34a9ebaefd3cf673f98d0ce61ab25338"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a7131d1a019e1d59a5dbd0ace893c4bd5" id="r_a7131d1a019e1d59a5dbd0ace893c4bd5"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_mutex.html#a7131d1a019e1d59a5dbd0ace893c4bd5">destroyMutex</a> (void *mutex)</td></tr>
- <tr class="separator:a7131d1a019e1d59a5dbd0ace893c4bd5"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a87c2e63830212bfae35f11eafaad7d3c" id="r_a87c2e63830212bfae35f11eafaad7d3c"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_mutex.html#a87c2e63830212bfae35f11eafaad7d3c">lockMutex</a> (void *mutex, bool block=true)</td></tr>
- <tr class="separator:a87c2e63830212bfae35f11eafaad7d3c"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a2839adeb8625ab1394a22d178e5cf41d" id="r_a2839adeb8625ab1394a22d178e5cf41d"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_mutex.html#a2839adeb8625ab1394a22d178e5cf41d">unlockMutex</a> (void *mutex)</td></tr>
- <tr class="separator:a2839adeb8625ab1394a22d178e5cf41d"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a>
- Protected Attributes</h2></td></tr>
- <tr class="memitem:a7b1c8422f4ef22eb34e90251d5740b21" id="r_a7b1c8422f4ef22eb34e90251d5740b21"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_platform_mutex_data.html">PlatformMutexData</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_mutex.html#a7b1c8422f4ef22eb34e90251d5740b21">mData</a></td></tr>
- <tr class="separator:a7b1c8422f4ef22eb34e90251d5740b21"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <h2 class="groupheader">Constructor & Destructor Documentation</h2>
- <a id="a4b5dfbd24f5bc4c03b24b2da362f66d5" name="a4b5dfbd24f5bc4c03b24b2da362f66d5"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a4b5dfbd24f5bc4c03b24b2da362f66d5">◆ </a></span>Mutex()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="class_mutex.html">Mutex</a> </td>
- <td>(</td>
- <td class="paramtype">void </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a205e2c334b25cb96e4f1303a4fde6b0c" name="a205e2c334b25cb96e4f1303a4fde6b0c"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a205e2c334b25cb96e4f1303a4fde6b0c">◆ </a></span>~Mutex()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">~<a class="el" href="class_mutex.html">Mutex</a> </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <h2 class="groupheader">Member Function Documentation</h2>
- <a id="a34a9ebaefd3cf673f98d0ce61ab25338" name="a34a9ebaefd3cf673f98d0ce61ab25338"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a34a9ebaefd3cf673f98d0ce61ab25338">◆ </a></span>createMutex()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">static void * createMutex </td>
- <td>(</td>
- <td class="paramname"></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">
- </div>
- </div>
- <a id="a7131d1a019e1d59a5dbd0ace893c4bd5" name="a7131d1a019e1d59a5dbd0ace893c4bd5"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a7131d1a019e1d59a5dbd0ace893c4bd5">◆ </a></span>destroyMutex()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">static void destroyMutex </td>
- <td>(</td>
- <td class="paramtype">void * </td>
- <td class="paramname"><em>mutex</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">
- </div>
- </div>
- <a id="a4021c0d21891caafe409f68976596216" name="a4021c0d21891caafe409f68976596216"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a4021c0d21891caafe409f68976596216">◆ </a></span>lock()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool lock </td>
- <td>(</td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>block</em> = <code>true</code></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a87c2e63830212bfae35f11eafaad7d3c" name="a87c2e63830212bfae35f11eafaad7d3c"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a87c2e63830212bfae35f11eafaad7d3c">◆ </a></span>lockMutex()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">static bool lockMutex </td>
- <td>(</td>
- <td class="paramtype">void * </td>
- <td class="paramname"><em>mutex</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>block</em> = <code>true</code> </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">
- </div>
- </div>
- <a id="a9278be8203e1c42e2619179882ae4403" name="a9278be8203e1c42e2619179882ae4403"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a9278be8203e1c42e2619179882ae4403">◆ </a></span>unlock()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void unlock </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a2839adeb8625ab1394a22d178e5cf41d" name="a2839adeb8625ab1394a22d178e5cf41d"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a2839adeb8625ab1394a22d178e5cf41d">◆ </a></span>unlockMutex()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">static void unlockMutex </td>
- <td>(</td>
- <td class="paramtype">void * </td>
- <td class="paramname"><em>mutex</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">
- </div>
- </div>
- <h2 class="groupheader">Member Data Documentation</h2>
- <a id="a7b1c8422f4ef22eb34e90251d5740b21" name="a7b1c8422f4ef22eb34e90251d5740b21"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a7b1c8422f4ef22eb34e90251d5740b21">◆ </a></span>mData</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="struct_platform_mutex_data.html">PlatformMutexData</a>* mData</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">protected</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <hr/>The documentation for this class was generated from the following files:<ul>
- <li>platform/threads/<b>mutex.h</b></li>
- <li>platformAndroid/<b>AndroidMutex.cpp</b></li>
- <li>platformEmscripten/<b>EmscriptenMutex.cpp</b></li>
- </ul>
- </div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated by <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>
|