TorqueEngine
/
Torque2D
miroir de https://github.com/TorqueGameEngines/Torque2D.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439
							<!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: Thread 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&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><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="class_thread-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">Thread Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;thread.h&gt;</code></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for Thread:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
 <div class="center">
  <img src="class_thread.png" usemap="#Thread_map" alt=""/>
  <map id="Thread_map" name="Thread_map">
<area href="class_execute_thread.html" alt="ExecuteThread" shape="rect" coords="0,56,97,80"/>
  </map>
</div></div>
<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:a5056e7cc7df6d63531f093ea4c390922" 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>
<tr class="separator:a5056e7cc7df6d63531f093ea4c390922"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a87a9c69a69ee4b13cb1ec5772f6d32ad" 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>
<tr class="separator:a87a9c69a69ee4b13cb1ec5772f6d32ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a60de64d75454385b23995437f1d72669" 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>
<tr class="separator:a60de64d75454385b23995437f1d72669"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8c528baf37154d347366083f0f816846" 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>
<tr class="memdesc:a8c528baf37154d347366083f0f816846"><td class="mdescLeft">&#160;</td><td class="mdescRight">Ask a thread to stop running.  <br /></td></tr>
<tr class="separator:a8c528baf37154d347366083f0f816846"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a263205361ae213885c5c5532bea185a5" 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>
<tr class="memdesc:a263205361ae213885c5c5532bea185a5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Block until the thread stops running.  <br /></td></tr>
<tr class="separator:a263205361ae213885c5c5532bea185a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abe3e6246f55ddc3ad2723234bfeb21e0" 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>
<tr class="separator:abe3e6246f55ddc3ad2723234bfeb21e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a748ffc60cede16bc85d9ed896a5d9525" id="r_a748ffc60cede16bc85d9ed896a5d9525"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_thread.html#a748ffc60cede16bc85d9ed896a5d9525">run</a> (void *arg=0)</td></tr>
<tr class="separator:a748ffc60cede16bc85d9ed896a5d9525"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a59db7399f5931387fa42b8685cbc137c" 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>
<tr class="memdesc:a59db7399f5931387fa42b8685cbc137c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if the thread is running.  <br /></td></tr>
<tr class="separator:a59db7399f5931387fa42b8685cbc137c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a94e964773223324e74288732dca2c27b" 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>
<tr class="memdesc:a94e964773223324e74288732dca2c27b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the platform specific thread id for this thread.  <br /></td></tr>
<tr class="separator:a94e964773223324e74288732dca2c27b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a2e8e56a7cf5972efebc109f4ba26f486" 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>
<tr class="memdesc:a2e8e56a7cf5972efebc109f4ba26f486"><td class="mdescLeft">&#160;</td><td class="mdescRight">If set, the thread will delete itself once it has finished running.  <br /></td></tr>
<tr class="separator:a2e8e56a7cf5972efebc109f4ba26f486"><td class="memSeparator" colspan="2">&#160;</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:ad0b7e71d2f1b148abe41358d3c5971f9" 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>
<tr class="separator:ad0b7e71d2f1b148abe41358d3c5971f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1066b945376ab0752467c2b528948b04" 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>
<tr class="separator:a1066b945376ab0752467c2b528948b04"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a5056e7cc7df6d63531f093ea4c390922" name="a5056e7cc7df6d63531f093ea4c390922"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5056e7cc7df6d63531f093ea4c390922">&#9670;&#160;</a></span>Thread()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_thread.html">Thread</a> </td>
          <td>(</td>
          <td class="paramtype">ThreadRunFunction&#160;</td>
          <td class="paramname"><em>func</em> = <code>0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>arg</em> = <code>0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>start_thread</em> = <code>true</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>autodelete</em> = <code>false</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Create a thread. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">func</td><td>The starting function for the thread. </td></tr>
    <tr><td class="paramname">arg</td><td>Data to be passed to func, when the thread starts. </td></tr>
    <tr><td class="paramname">start_thread</td><td>Whether to start the <a class="el" href="class_thread.html">Thread</a> immediately. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a87a9c69a69ee4b13cb1ec5772f6d32ad" name="a87a9c69a69ee4b13cb1ec5772f6d32ad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a87a9c69a69ee4b13cb1ec5772f6d32ad">&#9670;&#160;</a></span>~Thread()</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_thread.html">Thread</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">
<p>Destroy a thread. The thread MUST be allowed to exit before it is destroyed. </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="abe3e6246f55ddc3ad2723234bfeb21e0" name="abe3e6246f55ddc3ad2723234bfeb21e0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abe3e6246f55ddc3ad2723234bfeb21e0">&#9670;&#160;</a></span>checkForStop()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool checkForStop </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>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Threads may call <a class="el" href="class_thread.html#abe3e6246f55ddc3ad2723234bfeb21e0">checkForStop()</a> periodically to check if they've been asked to stop. As soon as <a class="el" href="class_thread.html#abe3e6246f55ddc3ad2723234bfeb21e0">checkForStop()</a> returns true, the thread should clean up and return. </p>

</div>
</div>
<a id="a94e964773223324e74288732dca2c27b" name="a94e964773223324e74288732dca2c27b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a94e964773223324e74288732dca2c27b">&#9670;&#160;</a></span>getId()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">U32 getId </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the platform specific thread id for this thread. </p>

</div>
</div>
<a id="a59db7399f5931387fa42b8685cbc137c" name="a59db7399f5931387fa42b8685cbc137c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a59db7399f5931387fa42b8685cbc137c">&#9670;&#160;</a></span>isAlive()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool isAlive </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns true if the thread is running. </p>

</div>
</div>
<a id="a263205361ae213885c5c5532bea185a5" name="a263205361ae213885c5c5532bea185a5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a263205361ae213885c5c5532bea185a5">&#9670;&#160;</a></span>join()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool join </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Block until the thread stops running. </p>

</div>
</div>
<a id="a748ffc60cede16bc85d9ed896a5d9525" name="a748ffc60cede16bc85d9ed896a5d9525"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a748ffc60cede16bc85d9ed896a5d9525">&#9670;&#160;</a></span>run()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void run </td>
          <td>(</td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>arg</em> = <code>0</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">
<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>

<p>Reimplemented in <a class="el" href="class_execute_thread.html#a022c5ac4312c9cc1c976aa2d1409908d">ExecuteThread</a>.</p>

</div>
</div>
<a id="a60de64d75454385b23995437f1d72669" name="a60de64d75454385b23995437f1d72669"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a60de64d75454385b23995437f1d72669">&#9670;&#160;</a></span>start()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void start </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Start a thread. Sets shouldStop to false and calls <a class="el" href="class_thread.html#a748ffc60cede16bc85d9ed896a5d9525">run()</a> in a new thread of execution. </p>

</div>
</div>
<a id="a8c528baf37154d347366083f0f816846" name="a8c528baf37154d347366083f0f816846"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8c528baf37154d347366083f0f816846">&#9670;&#160;</a></span>stop()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void stop </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>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Ask a thread to stop running. </p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a2e8e56a7cf5972efebc109f4ba26f486" name="a2e8e56a7cf5972efebc109f4ba26f486"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2e8e56a7cf5972efebc109f4ba26f486">&#9670;&#160;</a></span>autoDelete</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool autoDelete</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>If set, the thread will delete itself once it has finished running. </p>

</div>
</div>
<a id="ad0b7e71d2f1b148abe41358d3c5971f9" name="ad0b7e71d2f1b148abe41358d3c5971f9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad0b7e71d2f1b148abe41358d3c5971f9">&#9670;&#160;</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_thread_data.html">PlatformThreadData</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>
<a id="a1066b945376ab0752467c2b528948b04" name="a1066b945376ab0752467c2b528948b04"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1066b945376ab0752467c2b528948b04">&#9670;&#160;</a></span>shouldStop</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool shouldStop</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Used to signal threads need to stop. Threads set this flag to false in <a class="el" href="class_thread.html#a60de64d75454385b23995437f1d72669">start()</a> </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>platform/threads/<b>thread.h</b></li>
<li>platformAndroid/<b>AndroidThread.cpp</b></li>
<li>platformEmscripten/<b>EmscriptenThread.cpp</b></li>
</ul>
</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>