class_thread_manager.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310
  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: ThreadManager 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-static-methods">Static Public Member Functions</a> &#124;
  73. <a href="class_thread_manager-members.html">List of all members</a> </div>
  74. <div class="headertitle"><div class="title">ThreadManager Class Reference</div></div>
  75. </div><!--header-->
  76. <div class="contents">
  77. <p><code>#include &lt;thread.h&gt;</code></p>
  78. <table class="memberdecls">
  79. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
  80. Static Public Member Functions</h2></td></tr>
  81. <tr class="memitem:a720bbcb0f43087e51e93a06d965daafd" id="r_a720bbcb0f43087e51e93a06d965daafd"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_thread_manager.html#a720bbcb0f43087e51e93a06d965daafd">isCurrentThread</a> (ThreadIdent threadId)</td></tr>
  82. <tr class="memdesc:a720bbcb0f43087e51e93a06d965daafd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if threadId is the same as the calling thread's id. <br /></td></tr>
  83. <tr class="separator:a720bbcb0f43087e51e93a06d965daafd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:a1df3c073c8e05998557fc5a59a763f24" id="r_a1df3c073c8e05998557fc5a59a763f24"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_thread_manager.html#a1df3c073c8e05998557fc5a59a763f24">compare</a> (ThreadIdent threadId_1, ThreadIdent threadId_2)</td></tr>
  85. <tr class="separator:a1df3c073c8e05998557fc5a59a763f24"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:a8dbf383112507ed61cdb4e35e583fb8c" id="r_a8dbf383112507ed61cdb4e35e583fb8c"><td class="memItemLeft" align="right" valign="top">static ThreadIdent&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_thread_manager.html#a8dbf383112507ed61cdb4e35e583fb8c">getCurrentThreadId</a> ()</td></tr>
  87. <tr class="separator:a8dbf383112507ed61cdb4e35e583fb8c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:acc4fa4b3ab5db01b15c52d607be03fa2" id="r_acc4fa4b3ab5db01b15c52d607be03fa2"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_thread_manager.html#acc4fa4b3ab5db01b15c52d607be03fa2">addThread</a> (<a class="el" href="class_thread.html">Thread</a> *thread)</td></tr>
  89. <tr class="memdesc:acc4fa4b3ab5db01b15c52d607be03fa2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Each thread should add itself to the thread pool the first time it runs. <br /></td></tr>
  90. <tr class="separator:acc4fa4b3ab5db01b15c52d607be03fa2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. <tr class="memitem:a6916917eebf96b0787bb91cf20a64387" id="r_a6916917eebf96b0787bb91cf20a64387"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_thread_manager.html#a6916917eebf96b0787bb91cf20a64387">removeThread</a> (<a class="el" href="class_thread.html">Thread</a> *thread)</td></tr>
  92. <tr class="separator:a6916917eebf96b0787bb91cf20a64387"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <tr class="memitem:a235fe2b0d1a277a2056aad9dcfc3d54d" id="r_a235fe2b0d1a277a2056aad9dcfc3d54d"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_thread.html">Thread</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_thread_manager.html#a235fe2b0d1a277a2056aad9dcfc3d54d">getThreadById</a> (ThreadIdent threadid)</td></tr>
  94. <tr class="separator:a235fe2b0d1a277a2056aad9dcfc3d54d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. <tr class="memitem:a9bf647bc2d37c624a0b78dae57b1ba66" id="r_a9bf647bc2d37c624a0b78dae57b1ba66"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_thread.html">Thread</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_thread_manager.html#a9bf647bc2d37c624a0b78dae57b1ba66">getCurrentThread</a> ()</td></tr>
  96. <tr class="separator:a9bf647bc2d37c624a0b78dae57b1ba66"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. </table>
  98. <h2 class="groupheader">Member Function Documentation</h2>
  99. <a id="acc4fa4b3ab5db01b15c52d607be03fa2" name="acc4fa4b3ab5db01b15c52d607be03fa2"></a>
  100. <h2 class="memtitle"><span class="permalink"><a href="#acc4fa4b3ab5db01b15c52d607be03fa2">&#9670;&#160;</a></span>addThread()</h2>
  101. <div class="memitem">
  102. <div class="memproto">
  103. <table class="mlabels">
  104. <tr>
  105. <td class="mlabels-left">
  106. <table class="memname">
  107. <tr>
  108. <td class="memname">static void addThread </td>
  109. <td>(</td>
  110. <td class="paramtype"><a class="el" href="class_thread.html">Thread</a> *&#160;</td>
  111. <td class="paramname"><em>thread</em></td><td>)</td>
  112. <td></td>
  113. </tr>
  114. </table>
  115. </td>
  116. <td class="mlabels-right">
  117. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
  118. </tr>
  119. </table>
  120. </div><div class="memdoc">
  121. <p>Each thread should add itself to the thread pool the first time it runs. </p>
  122. </div>
  123. </div>
  124. <a id="a1df3c073c8e05998557fc5a59a763f24" name="a1df3c073c8e05998557fc5a59a763f24"></a>
  125. <h2 class="memtitle"><span class="permalink"><a href="#a1df3c073c8e05998557fc5a59a763f24">&#9670;&#160;</a></span>compare()</h2>
  126. <div class="memitem">
  127. <div class="memproto">
  128. <table class="mlabels">
  129. <tr>
  130. <td class="mlabels-left">
  131. <table class="memname">
  132. <tr>
  133. <td class="memname">bool compare </td>
  134. <td>(</td>
  135. <td class="paramtype">ThreadIdent&#160;</td>
  136. <td class="paramname"><em>threadId_1</em>, </td>
  137. </tr>
  138. <tr>
  139. <td class="paramkey"></td>
  140. <td></td>
  141. <td class="paramtype">ThreadIdent&#160;</td>
  142. <td class="paramname"><em>threadId_2</em>&#160;</td>
  143. </tr>
  144. <tr>
  145. <td></td>
  146. <td>)</td>
  147. <td></td><td></td>
  148. </tr>
  149. </table>
  150. </td>
  151. <td class="mlabels-right">
  152. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  153. </tr>
  154. </table>
  155. </div><div class="memdoc">
  156. <p>Returns true if the 2 thread ids represent the same thread. Some thread APIs return an opaque object as a thread id, so the == operator cannot reliably compare thread ids. </p>
  157. </div>
  158. </div>
  159. <a id="a9bf647bc2d37c624a0b78dae57b1ba66" name="a9bf647bc2d37c624a0b78dae57b1ba66"></a>
  160. <h2 class="memtitle"><span class="permalink"><a href="#a9bf647bc2d37c624a0b78dae57b1ba66">&#9670;&#160;</a></span>getCurrentThread()</h2>
  161. <div class="memitem">
  162. <div class="memproto">
  163. <table class="mlabels">
  164. <tr>
  165. <td class="mlabels-left">
  166. <table class="memname">
  167. <tr>
  168. <td class="memname">static <a class="el" href="class_thread.html">Thread</a> * getCurrentThread </td>
  169. <td>(</td>
  170. <td class="paramname"></td><td>)</td>
  171. <td></td>
  172. </tr>
  173. </table>
  174. </td>
  175. <td class="mlabels-right">
  176. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
  177. </tr>
  178. </table>
  179. </div><div class="memdoc">
  180. </div>
  181. </div>
  182. <a id="a8dbf383112507ed61cdb4e35e583fb8c" name="a8dbf383112507ed61cdb4e35e583fb8c"></a>
  183. <h2 class="memtitle"><span class="permalink"><a href="#a8dbf383112507ed61cdb4e35e583fb8c">&#9670;&#160;</a></span>getCurrentThreadId()</h2>
  184. <div class="memitem">
  185. <div class="memproto">
  186. <table class="mlabels">
  187. <tr>
  188. <td class="mlabels-left">
  189. <table class="memname">
  190. <tr>
  191. <td class="memname">U32 getCurrentThreadId </td>
  192. <td>(</td>
  193. <td class="paramname"></td><td>)</td>
  194. <td></td>
  195. </tr>
  196. </table>
  197. </td>
  198. <td class="mlabels-right">
  199. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  200. </tr>
  201. </table>
  202. </div><div class="memdoc">
  203. <p>Returns the platform specific thread id of the calling thread. Some platforms do not guarantee that this ID stays the same over the life of the thread, so use <a class="el" href="class_thread_manager.html#a1df3c073c8e05998557fc5a59a763f24">ThreadManager::compare()</a> to compare thread ids. </p>
  204. </div>
  205. </div>
  206. <a id="a235fe2b0d1a277a2056aad9dcfc3d54d" name="a235fe2b0d1a277a2056aad9dcfc3d54d"></a>
  207. <h2 class="memtitle"><span class="permalink"><a href="#a235fe2b0d1a277a2056aad9dcfc3d54d">&#9670;&#160;</a></span>getThreadById()</h2>
  208. <div class="memitem">
  209. <div class="memproto">
  210. <table class="mlabels">
  211. <tr>
  212. <td class="mlabels-left">
  213. <table class="memname">
  214. <tr>
  215. <td class="memname">static <a class="el" href="class_thread.html">Thread</a> * getThreadById </td>
  216. <td>(</td>
  217. <td class="paramtype">ThreadIdent&#160;</td>
  218. <td class="paramname"><em>threadid</em></td><td>)</td>
  219. <td></td>
  220. </tr>
  221. </table>
  222. </td>
  223. <td class="mlabels-right">
  224. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
  225. </tr>
  226. </table>
  227. </div><div class="memdoc">
  228. <p>Searches the pool of known threads for a thread whose id is equivalent to the given threadid. Compares thread ids with <a class="el" href="class_thread_manager.html#a1df3c073c8e05998557fc5a59a763f24">ThreadManager::compare()</a>. </p>
  229. </div>
  230. </div>
  231. <a id="a720bbcb0f43087e51e93a06d965daafd" name="a720bbcb0f43087e51e93a06d965daafd"></a>
  232. <h2 class="memtitle"><span class="permalink"><a href="#a720bbcb0f43087e51e93a06d965daafd">&#9670;&#160;</a></span>isCurrentThread()</h2>
  233. <div class="memitem">
  234. <div class="memproto">
  235. <table class="mlabels">
  236. <tr>
  237. <td class="mlabels-left">
  238. <table class="memname">
  239. <tr>
  240. <td class="memname">bool isCurrentThread </td>
  241. <td>(</td>
  242. <td class="paramtype">ThreadIdent&#160;</td>
  243. <td class="paramname"><em>threadId</em></td><td>)</td>
  244. <td></td>
  245. </tr>
  246. </table>
  247. </td>
  248. <td class="mlabels-right">
  249. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
  250. </tr>
  251. </table>
  252. </div><div class="memdoc">
  253. <p>Returns true if threadId is the same as the calling thread's id. </p>
  254. </div>
  255. </div>
  256. <a id="a6916917eebf96b0787bb91cf20a64387" name="a6916917eebf96b0787bb91cf20a64387"></a>
  257. <h2 class="memtitle"><span class="permalink"><a href="#a6916917eebf96b0787bb91cf20a64387">&#9670;&#160;</a></span>removeThread()</h2>
  258. <div class="memitem">
  259. <div class="memproto">
  260. <table class="mlabels">
  261. <tr>
  262. <td class="mlabels-left">
  263. <table class="memname">
  264. <tr>
  265. <td class="memname">static void removeThread </td>
  266. <td>(</td>
  267. <td class="paramtype"><a class="el" href="class_thread.html">Thread</a> *&#160;</td>
  268. <td class="paramname"><em>thread</em></td><td>)</td>
  269. <td></td>
  270. </tr>
  271. </table>
  272. </td>
  273. <td class="mlabels-right">
  274. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
  275. </tr>
  276. </table>
  277. </div><div class="memdoc">
  278. </div>
  279. </div>
  280. <hr/>The documentation for this class was generated from the following files:<ul>
  281. <li>platform/threads/<b>thread.h</b></li>
  282. <li>platformAndroid/<b>AndroidThread.cpp</b></li>
  283. <li>platformEmscripten/<b>EmscriptenThread.cpp</b></li>
  284. </ul>
  285. </div><!-- contents -->
  286. <!-- start footer part -->
  287. <hr class="footer"/><address class="footer"><small>
  288. 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
  289. </small></address>
  290. </body>
  291. </html>