class_thread_storage.html 9.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192
  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: ThreadStorage 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_thread_storage-members.html">List of all members</a> </div>
  74. <div class="headertitle"><div class="title">ThreadStorage Class Reference</div></div>
  75. </div><!--header-->
  76. <div class="contents">
  77. <p><a class="el" href="struct_platform.html">Platform</a> independent per-thread storage class.
  78. <a href="class_thread_storage.html#details">More...</a></p>
  79. <p><code>#include &lt;platformTLS.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:a214b5fcdada39e7f3700e469a916a112" id="r_a214b5fcdada39e7f3700e469a916a112"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_thread_storage.html#a214b5fcdada39e7f3700e469a916a112">ThreadStorage</a> ()</td></tr>
  84. <tr class="memdesc:a214b5fcdada39e7f3700e469a916a112"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="class_thread_storage.html" title="Platform independent per-thread storage class.">ThreadStorage</a> constructor. <br /></td></tr>
  85. <tr class="separator:a214b5fcdada39e7f3700e469a916a112"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:ab09113c53079f9e6911f80afbf526cb1" id="r_ab09113c53079f9e6911f80afbf526cb1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_thread_storage.html#ab09113c53079f9e6911f80afbf526cb1">~ThreadStorage</a> ()</td></tr>
  87. <tr class="memdesc:ab09113c53079f9e6911f80afbf526cb1"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="class_thread_storage.html" title="Platform independent per-thread storage class.">ThreadStorage</a> destructor. <br /></td></tr>
  88. <tr class="separator:ab09113c53079f9e6911f80afbf526cb1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <tr class="memitem:a9300e01f768bac34d652a41b42ff985d" id="r_a9300e01f768bac34d652a41b42ff985d"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_thread_storage.html#a9300e01f768bac34d652a41b42ff985d">get</a> ()</td></tr>
  90. <tr class="memdesc:a9300e01f768bac34d652a41b42ff985d"><td class="mdescLeft">&#160;</td><td class="mdescRight">returns the per-thread stored void pointer for this <a class="el" href="class_thread_storage.html" title="Platform independent per-thread storage class.">ThreadStorage</a>. The default value is NULL. <br /></td></tr>
  91. <tr class="separator:a9300e01f768bac34d652a41b42ff985d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:ad7e3df337fcbe4d03fba3345cfb3277e" id="r_ad7e3df337fcbe4d03fba3345cfb3277e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_thread_storage.html#ad7e3df337fcbe4d03fba3345cfb3277e">set</a> (void *data)</td></tr>
  93. <tr class="memdesc:ad7e3df337fcbe4d03fba3345cfb3277e"><td class="mdescLeft">&#160;</td><td class="mdescRight">sets the per-thread stored void pointer for this <a class="el" href="class_thread_storage.html" title="Platform independent per-thread storage class.">ThreadStorage</a> object. <br /></td></tr>
  94. <tr class="separator:ad7e3df337fcbe4d03fba3345cfb3277e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. </table>
  96. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  97. <div class="textblock"><p><a class="el" href="struct_platform.html">Platform</a> independent per-thread storage class. </p>
  98. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  99. <a id="a214b5fcdada39e7f3700e469a916a112" name="a214b5fcdada39e7f3700e469a916a112"></a>
  100. <h2 class="memtitle"><span class="permalink"><a href="#a214b5fcdada39e7f3700e469a916a112">&#9670;&#160;</a></span>ThreadStorage()</h2>
  101. <div class="memitem">
  102. <div class="memproto">
  103. <table class="memname">
  104. <tr>
  105. <td class="memname"><a class="el" href="class_thread_storage.html">ThreadStorage</a> </td>
  106. <td>(</td>
  107. <td class="paramname"></td><td>)</td>
  108. <td></td>
  109. </tr>
  110. </table>
  111. </div><div class="memdoc">
  112. <p><a class="el" href="class_thread_storage.html" title="Platform independent per-thread storage class.">ThreadStorage</a> constructor. </p>
  113. </div>
  114. </div>
  115. <a id="ab09113c53079f9e6911f80afbf526cb1" name="ab09113c53079f9e6911f80afbf526cb1"></a>
  116. <h2 class="memtitle"><span class="permalink"><a href="#ab09113c53079f9e6911f80afbf526cb1">&#9670;&#160;</a></span>~ThreadStorage()</h2>
  117. <div class="memitem">
  118. <div class="memproto">
  119. <table class="memname">
  120. <tr>
  121. <td class="memname">~<a class="el" href="class_thread_storage.html">ThreadStorage</a> </td>
  122. <td>(</td>
  123. <td class="paramname"></td><td>)</td>
  124. <td></td>
  125. </tr>
  126. </table>
  127. </div><div class="memdoc">
  128. <p><a class="el" href="class_thread_storage.html" title="Platform independent per-thread storage class.">ThreadStorage</a> destructor. </p>
  129. </div>
  130. </div>
  131. <h2 class="groupheader">Member Function Documentation</h2>
  132. <a id="a9300e01f768bac34d652a41b42ff985d" name="a9300e01f768bac34d652a41b42ff985d"></a>
  133. <h2 class="memtitle"><span class="permalink"><a href="#a9300e01f768bac34d652a41b42ff985d">&#9670;&#160;</a></span>get()</h2>
  134. <div class="memitem">
  135. <div class="memproto">
  136. <table class="memname">
  137. <tr>
  138. <td class="memname">void * get </td>
  139. <td>(</td>
  140. <td class="paramname"></td><td>)</td>
  141. <td></td>
  142. </tr>
  143. </table>
  144. </div><div class="memdoc">
  145. <p>returns the per-thread stored void pointer for this <a class="el" href="class_thread_storage.html" title="Platform independent per-thread storage class.">ThreadStorage</a>. The default value is NULL. </p>
  146. </div>
  147. </div>
  148. <a id="ad7e3df337fcbe4d03fba3345cfb3277e" name="ad7e3df337fcbe4d03fba3345cfb3277e"></a>
  149. <h2 class="memtitle"><span class="permalink"><a href="#ad7e3df337fcbe4d03fba3345cfb3277e">&#9670;&#160;</a></span>set()</h2>
  150. <div class="memitem">
  151. <div class="memproto">
  152. <table class="memname">
  153. <tr>
  154. <td class="memname">void set </td>
  155. <td>(</td>
  156. <td class="paramtype">void *&#160;</td>
  157. <td class="paramname"><em>data</em></td><td>)</td>
  158. <td></td>
  159. </tr>
  160. </table>
  161. </div><div class="memdoc">
  162. <p>sets the per-thread stored void pointer for this <a class="el" href="class_thread_storage.html" title="Platform independent per-thread storage class.">ThreadStorage</a> object. </p>
  163. </div>
  164. </div>
  165. <hr/>The documentation for this class was generated from the following files:<ul>
  166. <li>platform/<b>platformTLS.h</b></li>
  167. <li>platformAndroid/<b>AndroidThread.cpp</b></li>
  168. <li>platformEmscripten/<b>EmscriptenThread.cpp</b></li>
  169. </ul>
  170. </div><!-- contents -->
  171. <!-- start footer part -->
  172. <hr class="footer"/><address class="footer"><small>
  173. 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
  174. </small></address>
  175. </body>
  176. </html>