class_execute_thread.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213
  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: ExecuteThread 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="class_execute_thread-members.html">List of all members</a> </div>
  74. <div class="headertitle"><div class="title">ExecuteThread Class Reference</div></div>
  75. </div><!--header-->
  76. <div class="contents">
  77. <div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  78. <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for ExecuteThread:</div>
  79. <div id="dynsection-0-summary" class="dynsummary" style="display:block;">
  80. </div>
  81. <div id="dynsection-0-content" class="dyncontent" style="display:none;">
  82. <div class="center">
  83. <img src="class_execute_thread.png" usemap="#ExecuteThread_map" alt=""/>
  84. <map id="ExecuteThread_map" name="ExecuteThread_map">
  85. <area href="class_thread.html" alt="Thread" shape="rect" coords="0,0,97,24"/>
  86. </map>
  87. </div></div>
  88. <table class="memberdecls">
  89. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  90. Public Member Functions</h2></td></tr>
  91. <tr class="memitem:a3e67b19d3f642702bc7c39933f204193" id="r_a3e67b19d3f642702bc7c39933f204193"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_execute_thread.html#a3e67b19d3f642702bc7c39933f204193">ExecuteThread</a> (const char *_executable, const char *_args, const char *_directory)</td></tr>
  92. <tr class="separator:a3e67b19d3f642702bc7c39933f204193"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <tr class="memitem:a022c5ac4312c9cc1c976aa2d1409908d" id="r_a022c5ac4312c9cc1c976aa2d1409908d"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_execute_thread.html#a022c5ac4312c9cc1c976aa2d1409908d">run</a> (void *arg)</td></tr>
  94. <tr class="separator:a022c5ac4312c9cc1c976aa2d1409908d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. <tr class="inherit_header pub_methods_class_thread"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_thread')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_thread.html">Thread</a></td></tr>
  96. <tr class="memitem:a5056e7cc7df6d63531f093ea4c390922 inherit pub_methods_class_thread" id="r_a5056e7cc7df6d63531f093ea4c390922"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_thread.html#a5056e7cc7df6d63531f093ea4c390922">Thread</a> (ThreadRunFunction func=0, void *arg=0, bool start_thread=true, bool autodelete=false)</td></tr>
  97. <tr class="separator:a5056e7cc7df6d63531f093ea4c390922 inherit pub_methods_class_thread"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:a87a9c69a69ee4b13cb1ec5772f6d32ad inherit pub_methods_class_thread" id="r_a87a9c69a69ee4b13cb1ec5772f6d32ad"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_thread.html#a87a9c69a69ee4b13cb1ec5772f6d32ad">~Thread</a> ()</td></tr>
  99. <tr class="separator:a87a9c69a69ee4b13cb1ec5772f6d32ad inherit pub_methods_class_thread"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:a60de64d75454385b23995437f1d72669 inherit pub_methods_class_thread" id="r_a60de64d75454385b23995437f1d72669"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_thread.html#a60de64d75454385b23995437f1d72669">start</a> ()</td></tr>
  101. <tr class="separator:a60de64d75454385b23995437f1d72669 inherit pub_methods_class_thread"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:a8c528baf37154d347366083f0f816846 inherit pub_methods_class_thread" id="r_a8c528baf37154d347366083f0f816846"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_thread.html#a8c528baf37154d347366083f0f816846">stop</a> ()</td></tr>
  103. <tr class="memdesc:a8c528baf37154d347366083f0f816846 inherit pub_methods_class_thread"><td class="mdescLeft">&#160;</td><td class="mdescRight">Ask a thread to stop running. <br /></td></tr>
  104. <tr class="separator:a8c528baf37154d347366083f0f816846 inherit pub_methods_class_thread"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:a263205361ae213885c5c5532bea185a5 inherit pub_methods_class_thread" id="r_a263205361ae213885c5c5532bea185a5"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_thread.html#a263205361ae213885c5c5532bea185a5">join</a> ()</td></tr>
  106. <tr class="memdesc:a263205361ae213885c5c5532bea185a5 inherit pub_methods_class_thread"><td class="mdescLeft">&#160;</td><td class="mdescRight">Block until the thread stops running. <br /></td></tr>
  107. <tr class="separator:a263205361ae213885c5c5532bea185a5 inherit pub_methods_class_thread"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:abe3e6246f55ddc3ad2723234bfeb21e0 inherit pub_methods_class_thread" id="r_abe3e6246f55ddc3ad2723234bfeb21e0"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_thread.html#abe3e6246f55ddc3ad2723234bfeb21e0">checkForStop</a> ()</td></tr>
  109. <tr class="separator:abe3e6246f55ddc3ad2723234bfeb21e0 inherit pub_methods_class_thread"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="memitem:a59db7399f5931387fa42b8685cbc137c inherit pub_methods_class_thread" id="r_a59db7399f5931387fa42b8685cbc137c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_thread.html#a59db7399f5931387fa42b8685cbc137c">isAlive</a> ()</td></tr>
  111. <tr class="memdesc:a59db7399f5931387fa42b8685cbc137c inherit pub_methods_class_thread"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if the thread is running. <br /></td></tr>
  112. <tr class="separator:a59db7399f5931387fa42b8685cbc137c inherit pub_methods_class_thread"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <tr class="memitem:a94e964773223324e74288732dca2c27b inherit pub_methods_class_thread" id="r_a94e964773223324e74288732dca2c27b"><td class="memItemLeft" align="right" valign="top">ThreadIdent&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_thread.html#a94e964773223324e74288732dca2c27b">getId</a> ()</td></tr>
  114. <tr class="memdesc:a94e964773223324e74288732dca2c27b inherit pub_methods_class_thread"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the platform specific thread id for this thread. <br /></td></tr>
  115. <tr class="separator:a94e964773223324e74288732dca2c27b inherit pub_methods_class_thread"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. </table><table class="memberdecls">
  117. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
  118. Additional Inherited Members</h2></td></tr>
  119. <tr class="inherit_header pub_attribs_class_thread"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_class_thread')"><img src="closed.png" alt="-"/>&#160;Public Attributes inherited from <a class="el" href="class_thread.html">Thread</a></td></tr>
  120. <tr class="memitem:a2e8e56a7cf5972efebc109f4ba26f486 inherit pub_attribs_class_thread" id="r_a2e8e56a7cf5972efebc109f4ba26f486"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_thread.html#a2e8e56a7cf5972efebc109f4ba26f486">autoDelete</a></td></tr>
  121. <tr class="memdesc:a2e8e56a7cf5972efebc109f4ba26f486 inherit pub_attribs_class_thread"><td class="mdescLeft">&#160;</td><td class="mdescRight">If set, the thread will delete itself once it has finished running. <br /></td></tr>
  122. <tr class="separator:a2e8e56a7cf5972efebc109f4ba26f486 inherit pub_attribs_class_thread"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <tr class="inherit_header pro_attribs_class_thread"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_class_thread')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="class_thread.html">Thread</a></td></tr>
  124. <tr class="memitem:ad0b7e71d2f1b148abe41358d3c5971f9 inherit pro_attribs_class_thread" id="r_ad0b7e71d2f1b148abe41358d3c5971f9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_platform_thread_data.html">PlatformThreadData</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_thread.html#ad0b7e71d2f1b148abe41358d3c5971f9">mData</a></td></tr>
  125. <tr class="separator:ad0b7e71d2f1b148abe41358d3c5971f9 inherit pro_attribs_class_thread"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:a1066b945376ab0752467c2b528948b04 inherit pro_attribs_class_thread" id="r_a1066b945376ab0752467c2b528948b04"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_thread.html#a1066b945376ab0752467c2b528948b04">shouldStop</a></td></tr>
  127. <tr class="separator:a1066b945376ab0752467c2b528948b04 inherit pro_attribs_class_thread"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. </table>
  129. <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  130. <a id="a3e67b19d3f642702bc7c39933f204193" name="a3e67b19d3f642702bc7c39933f204193"></a>
  131. <h2 class="memtitle"><span class="permalink"><a href="#a3e67b19d3f642702bc7c39933f204193">&#9670;&#160;</a></span>ExecuteThread()</h2>
  132. <div class="memitem">
  133. <div class="memproto">
  134. <table class="mlabels">
  135. <tr>
  136. <td class="mlabels-left">
  137. <table class="memname">
  138. <tr>
  139. <td class="memname"><a class="el" href="class_execute_thread.html">ExecuteThread</a> </td>
  140. <td>(</td>
  141. <td class="paramtype">const char *&#160;</td>
  142. <td class="paramname"><em>_executable</em>, </td>
  143. </tr>
  144. <tr>
  145. <td class="paramkey"></td>
  146. <td></td>
  147. <td class="paramtype">const char *&#160;</td>
  148. <td class="paramname"><em>_args</em>, </td>
  149. </tr>
  150. <tr>
  151. <td class="paramkey"></td>
  152. <td></td>
  153. <td class="paramtype">const char *&#160;</td>
  154. <td class="paramname"><em>_directory</em>&#160;</td>
  155. </tr>
  156. <tr>
  157. <td></td>
  158. <td>)</td>
  159. <td></td><td></td>
  160. </tr>
  161. </table>
  162. </td>
  163. <td class="mlabels-right">
  164. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  165. </tr>
  166. </table>
  167. </div><div class="memdoc">
  168. </div>
  169. </div>
  170. <h2 class="groupheader">Member Function Documentation</h2>
  171. <a id="a022c5ac4312c9cc1c976aa2d1409908d" name="a022c5ac4312c9cc1c976aa2d1409908d"></a>
  172. <h2 class="memtitle"><span class="permalink"><a href="#a022c5ac4312c9cc1c976aa2d1409908d">&#9670;&#160;</a></span>run()</h2>
  173. <div class="memitem">
  174. <div class="memproto">
  175. <table class="mlabels">
  176. <tr>
  177. <td class="mlabels-left">
  178. <table class="memname">
  179. <tr>
  180. <td class="memname">void run </td>
  181. <td>(</td>
  182. <td class="paramtype">void *&#160;</td>
  183. <td class="paramname"><em>arg</em></td><td>)</td>
  184. <td></td>
  185. </tr>
  186. </table>
  187. </td>
  188. <td class="mlabels-right">
  189. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  190. </tr>
  191. </table>
  192. </div><div class="memdoc">
  193. <p>Run the <a class="el" href="class_thread.html">Thread</a>'s entry point function. Override this method in a subclass of <a class="el" href="class_thread.html">Thread</a> to create threaded code in an object oriented way, and without passing a function ptr to <a class="el" href="class_thread.html">Thread()</a>. Also, you can call this method directly to execute the thread's code in a non-threaded way. </p>
  194. <p>Reimplemented from <a class="el" href="class_thread.html#a748ffc60cede16bc85d9ed896a5d9525">Thread</a>.</p>
  195. </div>
  196. </div>
  197. <hr/>The documentation for this class was generated from the following file:<ul>
  198. <li>platformAndroid/<b>AndroidPlatform.cpp</b></li>
  199. </ul>
  200. </div><!-- contents -->
  201. <!-- start footer part -->
  202. <hr class="footer"/><address class="footer"><small>
  203. 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
  204. </small></address>
  205. </body>
  206. </html>