class_mutex.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=11"/>
  6. <meta name="generator" content="Doxygen 1.9.8"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>Torque2D Reference: Mutex Class Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
  17. </head>
  18. <body>
  19. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  20. <div id="titlearea">
  21. <table cellspacing="0" cellpadding="0">
  22. <tbody>
  23. <tr id="projectrow">
  24. <td id="projectalign">
  25. <div id="projectname">Torque2D Reference
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.9.8 -->
  34. <script type="text/javascript">
  35. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  36. var searchBox = new SearchBox("searchBox", "search/",'.html');
  37. /* @license-end */
  38. </script>
  39. <script type="text/javascript" src="menudata.js"></script>
  40. <script type="text/javascript" src="menu.js"></script>
  41. <script type="text/javascript">
  42. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  43. $(function() {
  44. initMenu('',true,false,'search.php','Search');
  45. $(document).ready(function() { init_search(); });
  46. });
  47. /* @license-end */
  48. </script>
  49. <div id="main-nav"></div>
  50. <!-- window showing the filter options -->
  51. <div id="MSearchSelectWindow"
  52. onmouseover="return searchBox.OnSearchSelectShow()"
  53. onmouseout="return searchBox.OnSearchSelectHide()"
  54. onkeydown="return searchBox.OnSearchSelectKey(event)">
  55. </div>
  56. <!-- iframe showing the search results (closed by default) -->
  57. <div id="MSearchResultsWindow">
  58. <div id="MSearchResults">
  59. <div class="SRPage">
  60. <div id="SRIndex">
  61. <div id="SRResults"></div>
  62. <div class="SRStatus" id="Loading">Loading...</div>
  63. <div class="SRStatus" id="Searching">Searching...</div>
  64. <div class="SRStatus" id="NoMatches">No Matches</div>
  65. </div>
  66. </div>
  67. </div>
  68. </div>
  69. </div><!-- top -->
  70. <div class="header">
  71. <div class="summary">
  72. <a href="#pub-methods">Public Member Functions</a> &#124;
  73. <a href="#pub-static-methods">Static Public Member Functions</a> &#124;
  74. <a href="#pro-attribs">Protected Attributes</a> &#124;
  75. <a href="class_mutex-members.html">List of all members</a> </div>
  76. <div class="headertitle"><div class="title">Mutex Class Reference</div></div>
  77. </div><!--header-->
  78. <div class="contents">
  79. <p><code>#include &lt;mutex.h&gt;</code></p>
  80. <table class="memberdecls">
  81. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  82. Public Member Functions</h2></td></tr>
  83. <tr class="memitem:a4b5dfbd24f5bc4c03b24b2da362f66d5" id="r_a4b5dfbd24f5bc4c03b24b2da362f66d5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_mutex.html#a4b5dfbd24f5bc4c03b24b2da362f66d5">Mutex</a> ()</td></tr>
  84. <tr class="separator:a4b5dfbd24f5bc4c03b24b2da362f66d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="memitem:a205e2c334b25cb96e4f1303a4fde6b0c" id="r_a205e2c334b25cb96e4f1303a4fde6b0c"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_mutex.html#a205e2c334b25cb96e4f1303a4fde6b0c">~Mutex</a> ()</td></tr>
  86. <tr class="separator:a205e2c334b25cb96e4f1303a4fde6b0c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="memitem:a4021c0d21891caafe409f68976596216" id="r_a4021c0d21891caafe409f68976596216"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_mutex.html#a4021c0d21891caafe409f68976596216">lock</a> (bool block=true)</td></tr>
  88. <tr class="separator:a4021c0d21891caafe409f68976596216"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <tr class="memitem:a9278be8203e1c42e2619179882ae4403" id="r_a9278be8203e1c42e2619179882ae4403"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_mutex.html#a9278be8203e1c42e2619179882ae4403">unlock</a> ()</td></tr>
  90. <tr class="separator:a9278be8203e1c42e2619179882ae4403"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. </table><table class="memberdecls">
  92. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
  93. Static Public Member Functions</h2></td></tr>
  94. <tr class="memitem:a34a9ebaefd3cf673f98d0ce61ab25338" id="r_a34a9ebaefd3cf673f98d0ce61ab25338"><td class="memItemLeft" align="right" valign="top">static void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_mutex.html#a34a9ebaefd3cf673f98d0ce61ab25338">createMutex</a> ()</td></tr>
  95. <tr class="separator:a34a9ebaefd3cf673f98d0ce61ab25338"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:a7131d1a019e1d59a5dbd0ace893c4bd5" id="r_a7131d1a019e1d59a5dbd0ace893c4bd5"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_mutex.html#a7131d1a019e1d59a5dbd0ace893c4bd5">destroyMutex</a> (void *mutex)</td></tr>
  97. <tr class="separator:a7131d1a019e1d59a5dbd0ace893c4bd5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:a87c2e63830212bfae35f11eafaad7d3c" id="r_a87c2e63830212bfae35f11eafaad7d3c"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_mutex.html#a87c2e63830212bfae35f11eafaad7d3c">lockMutex</a> (void *mutex, bool block=true)</td></tr>
  99. <tr class="separator:a87c2e63830212bfae35f11eafaad7d3c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:a2839adeb8625ab1394a22d178e5cf41d" id="r_a2839adeb8625ab1394a22d178e5cf41d"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_mutex.html#a2839adeb8625ab1394a22d178e5cf41d">unlockMutex</a> (void *mutex)</td></tr>
  101. <tr class="separator:a2839adeb8625ab1394a22d178e5cf41d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. </table><table class="memberdecls">
  103. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a>
  104. Protected Attributes</h2></td></tr>
  105. <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> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_mutex.html#a7b1c8422f4ef22eb34e90251d5740b21">mData</a></td></tr>
  106. <tr class="separator:a7b1c8422f4ef22eb34e90251d5740b21"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. </table>
  108. <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  109. <a id="a4b5dfbd24f5bc4c03b24b2da362f66d5" name="a4b5dfbd24f5bc4c03b24b2da362f66d5"></a>
  110. <h2 class="memtitle"><span class="permalink"><a href="#a4b5dfbd24f5bc4c03b24b2da362f66d5">&#9670;&#160;</a></span>Mutex()</h2>
  111. <div class="memitem">
  112. <div class="memproto">
  113. <table class="memname">
  114. <tr>
  115. <td class="memname"><a class="el" href="class_mutex.html">Mutex</a> </td>
  116. <td>(</td>
  117. <td class="paramtype">void&#160;</td>
  118. <td class="paramname"></td><td>)</td>
  119. <td></td>
  120. </tr>
  121. </table>
  122. </div><div class="memdoc">
  123. </div>
  124. </div>
  125. <a id="a205e2c334b25cb96e4f1303a4fde6b0c" name="a205e2c334b25cb96e4f1303a4fde6b0c"></a>
  126. <h2 class="memtitle"><span class="permalink"><a href="#a205e2c334b25cb96e4f1303a4fde6b0c">&#9670;&#160;</a></span>~Mutex()</h2>
  127. <div class="memitem">
  128. <div class="memproto">
  129. <table class="mlabels">
  130. <tr>
  131. <td class="mlabels-left">
  132. <table class="memname">
  133. <tr>
  134. <td class="memname">~<a class="el" href="class_mutex.html">Mutex</a> </td>
  135. <td>(</td>
  136. <td class="paramname"></td><td>)</td>
  137. <td></td>
  138. </tr>
  139. </table>
  140. </td>
  141. <td class="mlabels-right">
  142. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  143. </tr>
  144. </table>
  145. </div><div class="memdoc">
  146. </div>
  147. </div>
  148. <h2 class="groupheader">Member Function Documentation</h2>
  149. <a id="a34a9ebaefd3cf673f98d0ce61ab25338" name="a34a9ebaefd3cf673f98d0ce61ab25338"></a>
  150. <h2 class="memtitle"><span class="permalink"><a href="#a34a9ebaefd3cf673f98d0ce61ab25338">&#9670;&#160;</a></span>createMutex()</h2>
  151. <div class="memitem">
  152. <div class="memproto">
  153. <table class="mlabels">
  154. <tr>
  155. <td class="mlabels-left">
  156. <table class="memname">
  157. <tr>
  158. <td class="memname">static void * createMutex </td>
  159. <td>(</td>
  160. <td class="paramname"></td><td>)</td>
  161. <td></td>
  162. </tr>
  163. </table>
  164. </td>
  165. <td class="mlabels-right">
  166. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
  167. </tr>
  168. </table>
  169. </div><div class="memdoc">
  170. </div>
  171. </div>
  172. <a id="a7131d1a019e1d59a5dbd0ace893c4bd5" name="a7131d1a019e1d59a5dbd0ace893c4bd5"></a>
  173. <h2 class="memtitle"><span class="permalink"><a href="#a7131d1a019e1d59a5dbd0ace893c4bd5">&#9670;&#160;</a></span>destroyMutex()</h2>
  174. <div class="memitem">
  175. <div class="memproto">
  176. <table class="mlabels">
  177. <tr>
  178. <td class="mlabels-left">
  179. <table class="memname">
  180. <tr>
  181. <td class="memname">static void destroyMutex </td>
  182. <td>(</td>
  183. <td class="paramtype">void *&#160;</td>
  184. <td class="paramname"><em>mutex</em></td><td>)</td>
  185. <td></td>
  186. </tr>
  187. </table>
  188. </td>
  189. <td class="mlabels-right">
  190. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
  191. </tr>
  192. </table>
  193. </div><div class="memdoc">
  194. </div>
  195. </div>
  196. <a id="a4021c0d21891caafe409f68976596216" name="a4021c0d21891caafe409f68976596216"></a>
  197. <h2 class="memtitle"><span class="permalink"><a href="#a4021c0d21891caafe409f68976596216">&#9670;&#160;</a></span>lock()</h2>
  198. <div class="memitem">
  199. <div class="memproto">
  200. <table class="mlabels">
  201. <tr>
  202. <td class="mlabels-left">
  203. <table class="memname">
  204. <tr>
  205. <td class="memname">bool lock </td>
  206. <td>(</td>
  207. <td class="paramtype">bool&#160;</td>
  208. <td class="paramname"><em>block</em> = <code>true</code></td><td>)</td>
  209. <td></td>
  210. </tr>
  211. </table>
  212. </td>
  213. <td class="mlabels-right">
  214. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  215. </tr>
  216. </table>
  217. </div><div class="memdoc">
  218. </div>
  219. </div>
  220. <a id="a87c2e63830212bfae35f11eafaad7d3c" name="a87c2e63830212bfae35f11eafaad7d3c"></a>
  221. <h2 class="memtitle"><span class="permalink"><a href="#a87c2e63830212bfae35f11eafaad7d3c">&#9670;&#160;</a></span>lockMutex()</h2>
  222. <div class="memitem">
  223. <div class="memproto">
  224. <table class="mlabels">
  225. <tr>
  226. <td class="mlabels-left">
  227. <table class="memname">
  228. <tr>
  229. <td class="memname">static bool lockMutex </td>
  230. <td>(</td>
  231. <td class="paramtype">void *&#160;</td>
  232. <td class="paramname"><em>mutex</em>, </td>
  233. </tr>
  234. <tr>
  235. <td class="paramkey"></td>
  236. <td></td>
  237. <td class="paramtype">bool&#160;</td>
  238. <td class="paramname"><em>block</em> = <code>true</code>&#160;</td>
  239. </tr>
  240. <tr>
  241. <td></td>
  242. <td>)</td>
  243. <td></td><td></td>
  244. </tr>
  245. </table>
  246. </td>
  247. <td class="mlabels-right">
  248. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
  249. </tr>
  250. </table>
  251. </div><div class="memdoc">
  252. </div>
  253. </div>
  254. <a id="a9278be8203e1c42e2619179882ae4403" name="a9278be8203e1c42e2619179882ae4403"></a>
  255. <h2 class="memtitle"><span class="permalink"><a href="#a9278be8203e1c42e2619179882ae4403">&#9670;&#160;</a></span>unlock()</h2>
  256. <div class="memitem">
  257. <div class="memproto">
  258. <table class="mlabels">
  259. <tr>
  260. <td class="mlabels-left">
  261. <table class="memname">
  262. <tr>
  263. <td class="memname">void unlock </td>
  264. <td>(</td>
  265. <td class="paramname"></td><td>)</td>
  266. <td></td>
  267. </tr>
  268. </table>
  269. </td>
  270. <td class="mlabels-right">
  271. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  272. </tr>
  273. </table>
  274. </div><div class="memdoc">
  275. </div>
  276. </div>
  277. <a id="a2839adeb8625ab1394a22d178e5cf41d" name="a2839adeb8625ab1394a22d178e5cf41d"></a>
  278. <h2 class="memtitle"><span class="permalink"><a href="#a2839adeb8625ab1394a22d178e5cf41d">&#9670;&#160;</a></span>unlockMutex()</h2>
  279. <div class="memitem">
  280. <div class="memproto">
  281. <table class="mlabels">
  282. <tr>
  283. <td class="mlabels-left">
  284. <table class="memname">
  285. <tr>
  286. <td class="memname">static void unlockMutex </td>
  287. <td>(</td>
  288. <td class="paramtype">void *&#160;</td>
  289. <td class="paramname"><em>mutex</em></td><td>)</td>
  290. <td></td>
  291. </tr>
  292. </table>
  293. </td>
  294. <td class="mlabels-right">
  295. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
  296. </tr>
  297. </table>
  298. </div><div class="memdoc">
  299. </div>
  300. </div>
  301. <h2 class="groupheader">Member Data Documentation</h2>
  302. <a id="a7b1c8422f4ef22eb34e90251d5740b21" name="a7b1c8422f4ef22eb34e90251d5740b21"></a>
  303. <h2 class="memtitle"><span class="permalink"><a href="#a7b1c8422f4ef22eb34e90251d5740b21">&#9670;&#160;</a></span>mData</h2>
  304. <div class="memitem">
  305. <div class="memproto">
  306. <table class="mlabels">
  307. <tr>
  308. <td class="mlabels-left">
  309. <table class="memname">
  310. <tr>
  311. <td class="memname"><a class="el" href="struct_platform_mutex_data.html">PlatformMutexData</a>* mData</td>
  312. </tr>
  313. </table>
  314. </td>
  315. <td class="mlabels-right">
  316. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  317. </tr>
  318. </table>
  319. </div><div class="memdoc">
  320. </div>
  321. </div>
  322. <hr/>The documentation for this class was generated from the following files:<ul>
  323. <li>platform/threads/<b>mutex.h</b></li>
  324. <li>platformAndroid/<b>AndroidMutex.cpp</b></li>
  325. <li>platformEmscripten/<b>EmscriptenMutex.cpp</b></li>
  326. </ul>
  327. </div><!-- contents -->
  328. <!-- start footer part -->
  329. <hr class="footer"/><address class="footer"><small>
  330. 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
  331. </small></address>
  332. </body>
  333. </html>