class_net_socket.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351
  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: NetSocket 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="#pub-static-methods">Static Public Member Functions</a> &#124;
  74. <a href="#pub-static-attribs">Static Public Attributes</a> &#124;
  75. <a href="#pro-attribs">Protected Attributes</a> &#124;
  76. <a href="class_net_socket-members.html">List of all members</a> </div>
  77. <div class="headertitle"><div class="title">NetSocket Class Reference</div></div>
  78. </div><!--header-->
  79. <div class="contents">
  80. <p><code>#include &lt;platformNet.h&gt;</code></p>
  81. <table class="memberdecls">
  82. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  83. Public Member Functions</h2></td></tr>
  84. <tr class="memitem:a2615bf5c36b8ab5d8547c1d10a38c17b" id="r_a2615bf5c36b8ab5d8547c1d10a38c17b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_net_socket.html#a2615bf5c36b8ab5d8547c1d10a38c17b">NetSocket</a> ()</td></tr>
  85. <tr class="separator:a2615bf5c36b8ab5d8547c1d10a38c17b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:a696bcb47153951eb246b09a501530ad7" id="r_a696bcb47153951eb246b09a501530ad7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_net_socket.html#a696bcb47153951eb246b09a501530ad7">setHandle</a> (S32 handleId)</td></tr>
  87. <tr class="separator:a696bcb47153951eb246b09a501530ad7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:aaf6699fa447cd5467646f9768fa11d8d" id="r_aaf6699fa447cd5467646f9768fa11d8d"><td class="memItemLeft" align="right" valign="top">S32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_net_socket.html#aaf6699fa447cd5467646f9768fa11d8d">getHandle</a> () const</td></tr>
  89. <tr class="separator:aaf6699fa447cd5467646f9768fa11d8d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:a13fe8fb74956089fb45332fa8b89f270" id="r_a13fe8fb74956089fb45332fa8b89f270"><td class="memItemLeft" align="right" valign="top">U32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_net_socket.html#a13fe8fb74956089fb45332fa8b89f270">getHash</a> () const</td></tr>
  91. <tr class="separator:a13fe8fb74956089fb45332fa8b89f270"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:a2b7fddd6932bec6dff9a447094e8d75b" id="r_a2b7fddd6932bec6dff9a447094e8d75b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_net_socket.html#a2b7fddd6932bec6dff9a447094e8d75b">operator==</a> (const <a class="el" href="class_net_socket.html">NetSocket</a> &amp;other) const</td></tr>
  93. <tr class="separator:a2b7fddd6932bec6dff9a447094e8d75b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:aee134ffe92ce78a16673d98a9f1c9bee" id="r_aee134ffe92ce78a16673d98a9f1c9bee"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_net_socket.html#aee134ffe92ce78a16673d98a9f1c9bee">operator!=</a> (const <a class="el" href="class_net_socket.html">NetSocket</a> &amp;other) const</td></tr>
  95. <tr class="separator:aee134ffe92ce78a16673d98a9f1c9bee"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. </table><table class="memberdecls">
  97. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
  98. Static Public Member Functions</h2></td></tr>
  99. <tr class="memitem:ad0b85d1f4d65b2c34b3c48647b1973d0" id="r_ad0b85d1f4d65b2c34b3c48647b1973d0"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_net_socket.html">NetSocket</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_net_socket.html#ad0b85d1f4d65b2c34b3c48647b1973d0">fromHandle</a> (S32 handleId)</td></tr>
  100. <tr class="separator:ad0b85d1f4d65b2c34b3c48647b1973d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. </table><table class="memberdecls">
  102. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-attribs" name="pub-static-attribs"></a>
  103. Static Public Attributes</h2></td></tr>
  104. <tr class="memitem:a484e8ef86ca208fab5bbb9419dd90552" id="r_a484e8ef86ca208fab5bbb9419dd90552"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_net_socket.html">NetSocket</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_net_socket.html#a484e8ef86ca208fab5bbb9419dd90552">INVALID</a> = <a class="el" href="class_net_socket.html#ad0b85d1f4d65b2c34b3c48647b1973d0">NetSocket::fromHandle</a>(-1)</td></tr>
  105. <tr class="separator:a484e8ef86ca208fab5bbb9419dd90552"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. </table><table class="memberdecls">
  107. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a>
  108. Protected Attributes</h2></td></tr>
  109. <tr class="memitem:ac566232025e23626d9583c9779102f07" id="r_ac566232025e23626d9583c9779102f07"><td class="memItemLeft" align="right" valign="top">S32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_net_socket.html#ac566232025e23626d9583c9779102f07">mHandle</a></td></tr>
  110. <tr class="separator:ac566232025e23626d9583c9779102f07"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. </table>
  112. <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  113. <a id="a2615bf5c36b8ab5d8547c1d10a38c17b" name="a2615bf5c36b8ab5d8547c1d10a38c17b"></a>
  114. <h2 class="memtitle"><span class="permalink"><a href="#a2615bf5c36b8ab5d8547c1d10a38c17b">&#9670;&#160;</a></span>NetSocket()</h2>
  115. <div class="memitem">
  116. <div class="memproto">
  117. <table class="mlabels">
  118. <tr>
  119. <td class="mlabels-left">
  120. <table class="memname">
  121. <tr>
  122. <td class="memname"><a class="el" href="class_net_socket.html">NetSocket</a> </td>
  123. <td>(</td>
  124. <td class="paramname"></td><td>)</td>
  125. <td></td>
  126. </tr>
  127. </table>
  128. </td>
  129. <td class="mlabels-right">
  130. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  131. </tr>
  132. </table>
  133. </div><div class="memdoc">
  134. </div>
  135. </div>
  136. <h2 class="groupheader">Member Function Documentation</h2>
  137. <a id="ad0b85d1f4d65b2c34b3c48647b1973d0" name="ad0b85d1f4d65b2c34b3c48647b1973d0"></a>
  138. <h2 class="memtitle"><span class="permalink"><a href="#ad0b85d1f4d65b2c34b3c48647b1973d0">&#9670;&#160;</a></span>fromHandle()</h2>
  139. <div class="memitem">
  140. <div class="memproto">
  141. <table class="mlabels">
  142. <tr>
  143. <td class="mlabels-left">
  144. <table class="memname">
  145. <tr>
  146. <td class="memname">static <a class="el" href="class_net_socket.html">NetSocket</a> fromHandle </td>
  147. <td>(</td>
  148. <td class="paramtype">S32&#160;</td>
  149. <td class="paramname"><em>handleId</em></td><td>)</td>
  150. <td></td>
  151. </tr>
  152. </table>
  153. </td>
  154. <td class="mlabels-right">
  155. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
  156. </tr>
  157. </table>
  158. </div><div class="memdoc">
  159. </div>
  160. </div>
  161. <a id="aaf6699fa447cd5467646f9768fa11d8d" name="aaf6699fa447cd5467646f9768fa11d8d"></a>
  162. <h2 class="memtitle"><span class="permalink"><a href="#aaf6699fa447cd5467646f9768fa11d8d">&#9670;&#160;</a></span>getHandle()</h2>
  163. <div class="memitem">
  164. <div class="memproto">
  165. <table class="mlabels">
  166. <tr>
  167. <td class="mlabels-left">
  168. <table class="memname">
  169. <tr>
  170. <td class="memname">S32 getHandle </td>
  171. <td>(</td>
  172. <td class="paramname"></td><td>)</td>
  173. <td> const</td>
  174. </tr>
  175. </table>
  176. </td>
  177. <td class="mlabels-right">
  178. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  179. </tr>
  180. </table>
  181. </div><div class="memdoc">
  182. </div>
  183. </div>
  184. <a id="a13fe8fb74956089fb45332fa8b89f270" name="a13fe8fb74956089fb45332fa8b89f270"></a>
  185. <h2 class="memtitle"><span class="permalink"><a href="#a13fe8fb74956089fb45332fa8b89f270">&#9670;&#160;</a></span>getHash()</h2>
  186. <div class="memitem">
  187. <div class="memproto">
  188. <table class="mlabels">
  189. <tr>
  190. <td class="mlabels-left">
  191. <table class="memname">
  192. <tr>
  193. <td class="memname">U32 getHash </td>
  194. <td>(</td>
  195. <td class="paramname"></td><td>)</td>
  196. <td> const</td>
  197. </tr>
  198. </table>
  199. </td>
  200. <td class="mlabels-right">
  201. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  202. </tr>
  203. </table>
  204. </div><div class="memdoc">
  205. </div>
  206. </div>
  207. <a id="aee134ffe92ce78a16673d98a9f1c9bee" name="aee134ffe92ce78a16673d98a9f1c9bee"></a>
  208. <h2 class="memtitle"><span class="permalink"><a href="#aee134ffe92ce78a16673d98a9f1c9bee">&#9670;&#160;</a></span>operator!=()</h2>
  209. <div class="memitem">
  210. <div class="memproto">
  211. <table class="mlabels">
  212. <tr>
  213. <td class="mlabels-left">
  214. <table class="memname">
  215. <tr>
  216. <td class="memname">bool operator!= </td>
  217. <td>(</td>
  218. <td class="paramtype">const <a class="el" href="class_net_socket.html">NetSocket</a> &amp;&#160;</td>
  219. <td class="paramname"><em>other</em></td><td>)</td>
  220. <td> const</td>
  221. </tr>
  222. </table>
  223. </td>
  224. <td class="mlabels-right">
  225. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  226. </tr>
  227. </table>
  228. </div><div class="memdoc">
  229. </div>
  230. </div>
  231. <a id="a2b7fddd6932bec6dff9a447094e8d75b" name="a2b7fddd6932bec6dff9a447094e8d75b"></a>
  232. <h2 class="memtitle"><span class="permalink"><a href="#a2b7fddd6932bec6dff9a447094e8d75b">&#9670;&#160;</a></span>operator==()</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 operator== </td>
  241. <td>(</td>
  242. <td class="paramtype">const <a class="el" href="class_net_socket.html">NetSocket</a> &amp;&#160;</td>
  243. <td class="paramname"><em>other</em></td><td>)</td>
  244. <td> const</td>
  245. </tr>
  246. </table>
  247. </td>
  248. <td class="mlabels-right">
  249. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  250. </tr>
  251. </table>
  252. </div><div class="memdoc">
  253. </div>
  254. </div>
  255. <a id="a696bcb47153951eb246b09a501530ad7" name="a696bcb47153951eb246b09a501530ad7"></a>
  256. <h2 class="memtitle"><span class="permalink"><a href="#a696bcb47153951eb246b09a501530ad7">&#9670;&#160;</a></span>setHandle()</h2>
  257. <div class="memitem">
  258. <div class="memproto">
  259. <table class="mlabels">
  260. <tr>
  261. <td class="mlabels-left">
  262. <table class="memname">
  263. <tr>
  264. <td class="memname">void setHandle </td>
  265. <td>(</td>
  266. <td class="paramtype">S32&#160;</td>
  267. <td class="paramname"><em>handleId</em></td><td>)</td>
  268. <td></td>
  269. </tr>
  270. </table>
  271. </td>
  272. <td class="mlabels-right">
  273. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  274. </tr>
  275. </table>
  276. </div><div class="memdoc">
  277. </div>
  278. </div>
  279. <h2 class="groupheader">Member Data Documentation</h2>
  280. <a id="a484e8ef86ca208fab5bbb9419dd90552" name="a484e8ef86ca208fab5bbb9419dd90552"></a>
  281. <h2 class="memtitle"><span class="permalink"><a href="#a484e8ef86ca208fab5bbb9419dd90552">&#9670;&#160;</a></span>INVALID</h2>
  282. <div class="memitem">
  283. <div class="memproto">
  284. <table class="mlabels">
  285. <tr>
  286. <td class="mlabels-left">
  287. <table class="memname">
  288. <tr>
  289. <td class="memname"><a class="el" href="class_net_socket.html">NetSocket</a> INVALID = <a class="el" href="class_net_socket.html#ad0b85d1f4d65b2c34b3c48647b1973d0">NetSocket::fromHandle</a>(-1)</td>
  290. </tr>
  291. </table>
  292. </td>
  293. <td class="mlabels-right">
  294. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  295. </tr>
  296. </table>
  297. </div><div class="memdoc">
  298. </div>
  299. </div>
  300. <a id="ac566232025e23626d9583c9779102f07" name="ac566232025e23626d9583c9779102f07"></a>
  301. <h2 class="memtitle"><span class="permalink"><a href="#ac566232025e23626d9583c9779102f07">&#9670;&#160;</a></span>mHandle</h2>
  302. <div class="memitem">
  303. <div class="memproto">
  304. <table class="mlabels">
  305. <tr>
  306. <td class="mlabels-left">
  307. <table class="memname">
  308. <tr>
  309. <td class="memname">S32 mHandle</td>
  310. </tr>
  311. </table>
  312. </td>
  313. <td class="mlabels-right">
  314. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  315. </tr>
  316. </table>
  317. </div><div class="memdoc">
  318. </div>
  319. </div>
  320. <hr/>The documentation for this class was generated from the following files:<ul>
  321. <li>platform/<b>platformNet.h</b></li>
  322. <li>platform/<b>platformNet.cpp</b></li>
  323. </ul>
  324. </div><!-- contents -->
  325. <!-- start footer part -->
  326. <hr class="footer"/><address class="footer"><small>
  327. 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
  328. </small></address>
  329. </body>
  330. </html>