struct_polled_socket.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241
  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: PolledSocket Struct 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-types">Public Types</a> &#124;
  73. <a href="#pub-methods">Public Member Functions</a> &#124;
  74. <a href="#pub-attribs">Public Attributes</a> &#124;
  75. <a href="struct_polled_socket-members.html">List of all members</a> </div>
  76. <div class="headertitle"><div class="title">PolledSocket Struct Reference</div></div>
  77. </div><!--header-->
  78. <div class="contents">
  79. <table class="memberdecls">
  80. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
  81. Public Types</h2></td></tr>
  82. <tr class="memitem:af64ebd6a2e1adf88509ecf12309d951f" id="r_af64ebd6a2e1adf88509ecf12309d951f"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_polled_socket.html#af64ebd6a2e1adf88509ecf12309d951f">SocketState</a> { <br />
  83. &#160;&#160;<a class="el" href="struct_polled_socket.html#af64ebd6a2e1adf88509ecf12309d951faf6f6a29be9dfa45afe92f75a14c31273">InvalidState</a>
  84. , <a class="el" href="struct_polled_socket.html#af64ebd6a2e1adf88509ecf12309d951fad253364cc2926eb617b0833335fe4467">Connected</a>
  85. , <a class="el" href="struct_polled_socket.html#af64ebd6a2e1adf88509ecf12309d951fa83bf475b46da3febcae98c0c4579240e">ConnectionPending</a>
  86. , <a class="el" href="struct_polled_socket.html#af64ebd6a2e1adf88509ecf12309d951faee2f0d075860bf02668cdccf27b4b72c">Listening</a>
  87. , <br />
  88. &#160;&#160;<a class="el" href="struct_polled_socket.html#af64ebd6a2e1adf88509ecf12309d951fabd39fb2e6e9c0f0a64ba563fd086fdef">NameLookupRequired</a>
  89. <br />
  90. }</td></tr>
  91. <tr class="separator:af64ebd6a2e1adf88509ecf12309d951f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. </table><table class="memberdecls">
  93. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  94. Public Member Functions</h2></td></tr>
  95. <tr class="memitem:acd7d886158973caf6df51cda960654e9" id="r_acd7d886158973caf6df51cda960654e9"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_polled_socket.html#acd7d886158973caf6df51cda960654e9">PolledSocket</a> ()</td></tr>
  96. <tr class="separator:acd7d886158973caf6df51cda960654e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. </table><table class="memberdecls">
  98. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
  99. Public Attributes</h2></td></tr>
  100. <tr class="memitem:ac370fbfed318b56f5f88e1cbb3965fd1" id="r_ac370fbfed318b56f5f88e1cbb3965fd1"><td class="memItemLeft" align="right" valign="top">SOCKET&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_polled_socket.html#ac370fbfed318b56f5f88e1cbb3965fd1">fd</a></td></tr>
  101. <tr class="separator:ac370fbfed318b56f5f88e1cbb3965fd1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:a0c4abb109547b8c2271d2a5284e66f95" id="r_a0c4abb109547b8c2271d2a5284e66f95"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_net_socket.html">NetSocket</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_polled_socket.html#a0c4abb109547b8c2271d2a5284e66f95">handleFd</a></td></tr>
  103. <tr class="separator:a0c4abb109547b8c2271d2a5284e66f95"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:a15aaac7718e6aaac4298de94a1b6af70" id="r_a15aaac7718e6aaac4298de94a1b6af70"><td class="memItemLeft" align="right" valign="top">S32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_polled_socket.html#a15aaac7718e6aaac4298de94a1b6af70">state</a></td></tr>
  105. <tr class="separator:a15aaac7718e6aaac4298de94a1b6af70"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:a5ed5738597a614c5de3a2f04c4b6ec48" id="r_a5ed5738597a614c5de3a2f04c4b6ec48"><td class="memItemLeft" align="right" valign="top">char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_polled_socket.html#a5ed5738597a614c5de3a2f04c4b6ec48">remoteAddr</a> [256]</td></tr>
  107. <tr class="separator:a5ed5738597a614c5de3a2f04c4b6ec48"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:ad3127eccbb90aa089a6a4616e8e993b8" id="r_ad3127eccbb90aa089a6a4616e8e993b8"><td class="memItemLeft" align="right" valign="top">S32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_polled_socket.html#ad3127eccbb90aa089a6a4616e8e993b8">remotePort</a></td></tr>
  109. <tr class="separator:ad3127eccbb90aa089a6a4616e8e993b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. </table>
  111. <h2 class="groupheader">Member Enumeration Documentation</h2>
  112. <a id="af64ebd6a2e1adf88509ecf12309d951f" name="af64ebd6a2e1adf88509ecf12309d951f"></a>
  113. <h2 class="memtitle"><span class="permalink"><a href="#af64ebd6a2e1adf88509ecf12309d951f">&#9670;&#160;</a></span>SocketState</h2>
  114. <div class="memitem">
  115. <div class="memproto">
  116. <table class="memname">
  117. <tr>
  118. <td class="memname">enum <a class="el" href="struct_polled_socket.html#af64ebd6a2e1adf88509ecf12309d951f">SocketState</a></td>
  119. </tr>
  120. </table>
  121. </div><div class="memdoc">
  122. <table class="fieldtable">
  123. <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="af64ebd6a2e1adf88509ecf12309d951faf6f6a29be9dfa45afe92f75a14c31273" name="af64ebd6a2e1adf88509ecf12309d951faf6f6a29be9dfa45afe92f75a14c31273"></a>InvalidState&#160;</td><td class="fielddoc"></td></tr>
  124. <tr><td class="fieldname"><a id="af64ebd6a2e1adf88509ecf12309d951fad253364cc2926eb617b0833335fe4467" name="af64ebd6a2e1adf88509ecf12309d951fad253364cc2926eb617b0833335fe4467"></a>Connected&#160;</td><td class="fielddoc"></td></tr>
  125. <tr><td class="fieldname"><a id="af64ebd6a2e1adf88509ecf12309d951fa83bf475b46da3febcae98c0c4579240e" name="af64ebd6a2e1adf88509ecf12309d951fa83bf475b46da3febcae98c0c4579240e"></a>ConnectionPending&#160;</td><td class="fielddoc"></td></tr>
  126. <tr><td class="fieldname"><a id="af64ebd6a2e1adf88509ecf12309d951faee2f0d075860bf02668cdccf27b4b72c" name="af64ebd6a2e1adf88509ecf12309d951faee2f0d075860bf02668cdccf27b4b72c"></a>Listening&#160;</td><td class="fielddoc"></td></tr>
  127. <tr><td class="fieldname"><a id="af64ebd6a2e1adf88509ecf12309d951fabd39fb2e6e9c0f0a64ba563fd086fdef" name="af64ebd6a2e1adf88509ecf12309d951fabd39fb2e6e9c0f0a64ba563fd086fdef"></a>NameLookupRequired&#160;</td><td class="fielddoc"></td></tr>
  128. </table>
  129. </div>
  130. </div>
  131. <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  132. <a id="acd7d886158973caf6df51cda960654e9" name="acd7d886158973caf6df51cda960654e9"></a>
  133. <h2 class="memtitle"><span class="permalink"><a href="#acd7d886158973caf6df51cda960654e9">&#9670;&#160;</a></span>PolledSocket()</h2>
  134. <div class="memitem">
  135. <div class="memproto">
  136. <table class="mlabels">
  137. <tr>
  138. <td class="mlabels-left">
  139. <table class="memname">
  140. <tr>
  141. <td class="memname"><a class="el" href="struct_polled_socket.html">PolledSocket</a> </td>
  142. <td>(</td>
  143. <td class="paramname"></td><td>)</td>
  144. <td></td>
  145. </tr>
  146. </table>
  147. </td>
  148. <td class="mlabels-right">
  149. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  150. </tr>
  151. </table>
  152. </div><div class="memdoc">
  153. </div>
  154. </div>
  155. <h2 class="groupheader">Member Data Documentation</h2>
  156. <a id="ac370fbfed318b56f5f88e1cbb3965fd1" name="ac370fbfed318b56f5f88e1cbb3965fd1"></a>
  157. <h2 class="memtitle"><span class="permalink"><a href="#ac370fbfed318b56f5f88e1cbb3965fd1">&#9670;&#160;</a></span>fd</h2>
  158. <div class="memitem">
  159. <div class="memproto">
  160. <table class="memname">
  161. <tr>
  162. <td class="memname">SOCKET fd</td>
  163. </tr>
  164. </table>
  165. </div><div class="memdoc">
  166. </div>
  167. </div>
  168. <a id="a0c4abb109547b8c2271d2a5284e66f95" name="a0c4abb109547b8c2271d2a5284e66f95"></a>
  169. <h2 class="memtitle"><span class="permalink"><a href="#a0c4abb109547b8c2271d2a5284e66f95">&#9670;&#160;</a></span>handleFd</h2>
  170. <div class="memitem">
  171. <div class="memproto">
  172. <table class="memname">
  173. <tr>
  174. <td class="memname"><a class="el" href="class_net_socket.html">NetSocket</a> handleFd</td>
  175. </tr>
  176. </table>
  177. </div><div class="memdoc">
  178. </div>
  179. </div>
  180. <a id="a5ed5738597a614c5de3a2f04c4b6ec48" name="a5ed5738597a614c5de3a2f04c4b6ec48"></a>
  181. <h2 class="memtitle"><span class="permalink"><a href="#a5ed5738597a614c5de3a2f04c4b6ec48">&#9670;&#160;</a></span>remoteAddr</h2>
  182. <div class="memitem">
  183. <div class="memproto">
  184. <table class="memname">
  185. <tr>
  186. <td class="memname">char remoteAddr[256]</td>
  187. </tr>
  188. </table>
  189. </div><div class="memdoc">
  190. </div>
  191. </div>
  192. <a id="ad3127eccbb90aa089a6a4616e8e993b8" name="ad3127eccbb90aa089a6a4616e8e993b8"></a>
  193. <h2 class="memtitle"><span class="permalink"><a href="#ad3127eccbb90aa089a6a4616e8e993b8">&#9670;&#160;</a></span>remotePort</h2>
  194. <div class="memitem">
  195. <div class="memproto">
  196. <table class="memname">
  197. <tr>
  198. <td class="memname">S32 remotePort</td>
  199. </tr>
  200. </table>
  201. </div><div class="memdoc">
  202. </div>
  203. </div>
  204. <a id="a15aaac7718e6aaac4298de94a1b6af70" name="a15aaac7718e6aaac4298de94a1b6af70"></a>
  205. <h2 class="memtitle"><span class="permalink"><a href="#a15aaac7718e6aaac4298de94a1b6af70">&#9670;&#160;</a></span>state</h2>
  206. <div class="memitem">
  207. <div class="memproto">
  208. <table class="memname">
  209. <tr>
  210. <td class="memname">S32 state</td>
  211. </tr>
  212. </table>
  213. </div><div class="memdoc">
  214. </div>
  215. </div>
  216. <hr/>The documentation for this struct was generated from the following file:<ul>
  217. <li>platform/<b>platformNet.cpp</b></li>
  218. </ul>
  219. </div><!-- contents -->
  220. <!-- start footer part -->
  221. <hr class="footer"/><address class="footer"><small>
  222. 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
  223. </small></address>
  224. </body>
  225. </html>