| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310 |
- <!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: ThreadManager 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-static-methods">Static Public Member Functions</a> |
- <a href="class_thread_manager-members.html">List of all members</a> </div>
- <div class="headertitle"><div class="title">ThreadManager Class Reference</div></div>
- </div><!--header-->
- <div class="contents">
- <p><code>#include <thread.h></code></p>
- <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:a720bbcb0f43087e51e93a06d965daafd" id="r_a720bbcb0f43087e51e93a06d965daafd"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_thread_manager.html#a720bbcb0f43087e51e93a06d965daafd">isCurrentThread</a> (ThreadIdent threadId)</td></tr>
- <tr class="memdesc:a720bbcb0f43087e51e93a06d965daafd"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if threadId is the same as the calling thread's id. <br /></td></tr>
- <tr class="separator:a720bbcb0f43087e51e93a06d965daafd"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1df3c073c8e05998557fc5a59a763f24" id="r_a1df3c073c8e05998557fc5a59a763f24"><td class="memItemLeft" align="right" valign="top">static bool </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>
- <tr class="separator:a1df3c073c8e05998557fc5a59a763f24"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a8dbf383112507ed61cdb4e35e583fb8c" id="r_a8dbf383112507ed61cdb4e35e583fb8c"><td class="memItemLeft" align="right" valign="top">static ThreadIdent </td><td class="memItemRight" valign="bottom"><a class="el" href="class_thread_manager.html#a8dbf383112507ed61cdb4e35e583fb8c">getCurrentThreadId</a> ()</td></tr>
- <tr class="separator:a8dbf383112507ed61cdb4e35e583fb8c"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:acc4fa4b3ab5db01b15c52d607be03fa2" id="r_acc4fa4b3ab5db01b15c52d607be03fa2"><td class="memItemLeft" align="right" valign="top">static void </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>
- <tr class="memdesc:acc4fa4b3ab5db01b15c52d607be03fa2"><td class="mdescLeft"> </td><td class="mdescRight">Each thread should add itself to the thread pool the first time it runs. <br /></td></tr>
- <tr class="separator:acc4fa4b3ab5db01b15c52d607be03fa2"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a6916917eebf96b0787bb91cf20a64387" id="r_a6916917eebf96b0787bb91cf20a64387"><td class="memItemLeft" align="right" valign="top">static void </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>
- <tr class="separator:a6916917eebf96b0787bb91cf20a64387"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a235fe2b0d1a277a2056aad9dcfc3d54d" id="r_a235fe2b0d1a277a2056aad9dcfc3d54d"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_thread.html">Thread</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_thread_manager.html#a235fe2b0d1a277a2056aad9dcfc3d54d">getThreadById</a> (ThreadIdent threadid)</td></tr>
- <tr class="separator:a235fe2b0d1a277a2056aad9dcfc3d54d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a9bf647bc2d37c624a0b78dae57b1ba66" id="r_a9bf647bc2d37c624a0b78dae57b1ba66"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_thread.html">Thread</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_thread_manager.html#a9bf647bc2d37c624a0b78dae57b1ba66">getCurrentThread</a> ()</td></tr>
- <tr class="separator:a9bf647bc2d37c624a0b78dae57b1ba66"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <h2 class="groupheader">Member Function Documentation</h2>
- <a id="acc4fa4b3ab5db01b15c52d607be03fa2" name="acc4fa4b3ab5db01b15c52d607be03fa2"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#acc4fa4b3ab5db01b15c52d607be03fa2">◆ </a></span>addThread()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">static void addThread </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="class_thread.html">Thread</a> * </td>
- <td class="paramname"><em>thread</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">
- <p>Each thread should add itself to the thread pool the first time it runs. </p>
- </div>
- </div>
- <a id="a1df3c073c8e05998557fc5a59a763f24" name="a1df3c073c8e05998557fc5a59a763f24"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a1df3c073c8e05998557fc5a59a763f24">◆ </a></span>compare()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool compare </td>
- <td>(</td>
- <td class="paramtype">ThreadIdent </td>
- <td class="paramname"><em>threadId_1</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">ThreadIdent </td>
- <td class="paramname"><em>threadId_2</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">static</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- </div>
- </div>
- <a id="a9bf647bc2d37c624a0b78dae57b1ba66" name="a9bf647bc2d37c624a0b78dae57b1ba66"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a9bf647bc2d37c624a0b78dae57b1ba66">◆ </a></span>getCurrentThread()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">static <a class="el" href="class_thread.html">Thread</a> * getCurrentThread </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="a8dbf383112507ed61cdb4e35e583fb8c" name="a8dbf383112507ed61cdb4e35e583fb8c"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a8dbf383112507ed61cdb4e35e583fb8c">◆ </a></span>getCurrentThreadId()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">U32 getCurrentThreadId </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">static</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- </div>
- </div>
- <a id="a235fe2b0d1a277a2056aad9dcfc3d54d" name="a235fe2b0d1a277a2056aad9dcfc3d54d"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a235fe2b0d1a277a2056aad9dcfc3d54d">◆ </a></span>getThreadById()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">static <a class="el" href="class_thread.html">Thread</a> * getThreadById </td>
- <td>(</td>
- <td class="paramtype">ThreadIdent </td>
- <td class="paramname"><em>threadid</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">
- <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>
- </div>
- </div>
- <a id="a720bbcb0f43087e51e93a06d965daafd" name="a720bbcb0f43087e51e93a06d965daafd"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a720bbcb0f43087e51e93a06d965daafd">◆ </a></span>isCurrentThread()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool isCurrentThread </td>
- <td>(</td>
- <td class="paramtype">ThreadIdent </td>
- <td class="paramname"><em>threadId</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">
- <p>Returns true if threadId is the same as the calling thread's id. </p>
- </div>
- </div>
- <a id="a6916917eebf96b0787bb91cf20a64387" name="a6916917eebf96b0787bb91cf20a64387"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a6916917eebf96b0787bb91cf20a64387">◆ </a></span>removeThread()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">static void removeThread </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="class_thread.html">Thread</a> * </td>
- <td class="paramname"><em>thread</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>
- <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 <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>
|