struct_connected_notify_event.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228
  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: ConnectedNotifyEvent 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_connected_notify_event-members.html">List of all members</a> </div>
  76. <div class="headertitle"><div class="title">ConnectedNotifyEvent Struct Reference</div></div>
  77. </div><!--header-->
  78. <div class="contents">
  79. <p>Notify simulation of state of a connection.
  80. <a href="struct_connected_notify_event.html#details">More...</a></p>
  81. <p><code>#include &lt;event.h&gt;</code></p>
  82. <div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  83. <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for ConnectedNotifyEvent:</div>
  84. <div id="dynsection-0-summary" class="dynsummary" style="display:block;">
  85. </div>
  86. <div id="dynsection-0-content" class="dyncontent" style="display:none;">
  87. <div class="center">
  88. <img src="struct_connected_notify_event.png" usemap="#ConnectedNotifyEvent_map" alt=""/>
  89. <map id="ConnectedNotifyEvent_map" name="ConnectedNotifyEvent_map">
  90. <area href="struct_event.html" title="Base event structure (also used for FrameEvent and QuitEvent)" alt="Event" shape="rect" coords="0,0,138,24"/>
  91. </map>
  92. </div></div>
  93. <table class="memberdecls">
  94. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
  95. Public Types</h2></td></tr>
  96. <tr class="memitem:a5d74787dedbc4e11c1ab15bf487e61f8" id="r_a5d74787dedbc4e11c1ab15bf487e61f8"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_connected_notify_event.html#a5d74787dedbc4e11c1ab15bf487e61f8">State</a> { <br />
  97. &#160;&#160;<a class="el" href="struct_connected_notify_event.html#a5d74787dedbc4e11c1ab15bf487e61f8a863539c15e3951f667939f14e5622854">DNSResolved</a>
  98. , <a class="el" href="struct_connected_notify_event.html#a5d74787dedbc4e11c1ab15bf487e61f8af7305d010d426fda568ade6d959c89be">DNSFailed</a>
  99. , <a class="el" href="struct_connected_notify_event.html#a5d74787dedbc4e11c1ab15bf487e61f8ad253364cc2926eb617b0833335fe4467">Connected</a>
  100. , <a class="el" href="struct_connected_notify_event.html#a5d74787dedbc4e11c1ab15bf487e61f8a21bdfb4a7dfb3d3c26bdabf983777eb0">ConnectFailed</a>
  101. , <br />
  102. &#160;&#160;<a class="el" href="struct_connected_notify_event.html#a5d74787dedbc4e11c1ab15bf487e61f8a84ab0fbbb76a8c897feb1cd806d56443">Disconnected</a>
  103. <br />
  104. }</td></tr>
  105. <tr class="memdesc:a5d74787dedbc4e11c1ab15bf487e61f8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Valid connection states. <a href="struct_connected_notify_event.html#a5d74787dedbc4e11c1ab15bf487e61f8">More...</a><br /></td></tr>
  106. <tr class="separator:a5d74787dedbc4e11c1ab15bf487e61f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. </table><table class="memberdecls">
  108. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  109. Public Member Functions</h2></td></tr>
  110. <tr class="memitem:a7035a6da2d6a329f76ee34a730921231" id="r_a7035a6da2d6a329f76ee34a730921231"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_connected_notify_event.html#a7035a6da2d6a329f76ee34a730921231">ConnectedNotifyEvent</a> ()</td></tr>
  111. <tr class="separator:a7035a6da2d6a329f76ee34a730921231"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <tr class="inherit_header pub_methods_struct_event"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_struct_event')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="struct_event.html">Event</a></td></tr>
  113. <tr class="memitem:a85b9e8172cffad1f169d55688e49a72f inherit pub_methods_struct_event" id="r_a85b9e8172cffad1f169d55688e49a72f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_event.html#a85b9e8172cffad1f169d55688e49a72f">Event</a> ()</td></tr>
  114. <tr class="separator:a85b9e8172cffad1f169d55688e49a72f inherit pub_methods_struct_event"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. </table><table class="memberdecls">
  116. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
  117. Public Attributes</h2></td></tr>
  118. <tr class="memitem:a5518cc4919b6fe5d9fd1b873be194127" id="r_a5518cc4919b6fe5d9fd1b873be194127"><td class="memItemLeft" align="right" valign="top">U32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_connected_notify_event.html#a5518cc4919b6fe5d9fd1b873be194127">state</a></td></tr>
  119. <tr class="memdesc:a5518cc4919b6fe5d9fd1b873be194127"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicates current connection state. <br /></td></tr>
  120. <tr class="separator:a5518cc4919b6fe5d9fd1b873be194127"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <tr class="memitem:abc52217fba007d6ea01acd390e807d1b" id="r_abc52217fba007d6ea01acd390e807d1b"><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_connected_notify_event.html#abc52217fba007d6ea01acd390e807d1b">tag</a></td></tr>
  122. <tr class="memdesc:abc52217fba007d6ea01acd390e807d1b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Identifies connection. <br /></td></tr>
  123. <tr class="separator:abc52217fba007d6ea01acd390e807d1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="inherit_header pub_attribs_struct_event"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_struct_event')"><img src="closed.png" alt="-"/>&#160;Public Attributes inherited from <a class="el" href="struct_event.html">Event</a></td></tr>
  125. <tr class="memitem:a839a5921fd505dfcc828a03bf241b4e0 inherit pub_attribs_struct_event" id="r_a839a5921fd505dfcc828a03bf241b4e0"><td class="memItemLeft" align="right" valign="top">U16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_event.html#a839a5921fd505dfcc828a03bf241b4e0">type</a></td></tr>
  126. <tr class="separator:a839a5921fd505dfcc828a03bf241b4e0 inherit pub_attribs_struct_event"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <tr class="memitem:aba179bdf16bf15367217b28c4744745a inherit pub_attribs_struct_event" id="r_aba179bdf16bf15367217b28c4744745a"><td class="memItemLeft" align="right" valign="top">U16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_event.html#aba179bdf16bf15367217b28c4744745a">size</a></td></tr>
  128. <tr class="separator:aba179bdf16bf15367217b28c4744745a inherit pub_attribs_struct_event"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. </table>
  130. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  131. <div class="textblock"><p>Notify simulation of state of a connection. </p>
  132. </div><h2 class="groupheader">Member Enumeration Documentation</h2>
  133. <a id="a5d74787dedbc4e11c1ab15bf487e61f8" name="a5d74787dedbc4e11c1ab15bf487e61f8"></a>
  134. <h2 class="memtitle"><span class="permalink"><a href="#a5d74787dedbc4e11c1ab15bf487e61f8">&#9670;&#160;</a></span>State</h2>
  135. <div class="memitem">
  136. <div class="memproto">
  137. <table class="memname">
  138. <tr>
  139. <td class="memname">enum <a class="el" href="struct_connected_notify_event.html#a5d74787dedbc4e11c1ab15bf487e61f8">State</a></td>
  140. </tr>
  141. </table>
  142. </div><div class="memdoc">
  143. <p>Valid connection states. </p>
  144. <table class="fieldtable">
  145. <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a5d74787dedbc4e11c1ab15bf487e61f8a863539c15e3951f667939f14e5622854" name="a5d74787dedbc4e11c1ab15bf487e61f8a863539c15e3951f667939f14e5622854"></a>DNSResolved&#160;</td><td class="fielddoc"></td></tr>
  146. <tr><td class="fieldname"><a id="a5d74787dedbc4e11c1ab15bf487e61f8af7305d010d426fda568ade6d959c89be" name="a5d74787dedbc4e11c1ab15bf487e61f8af7305d010d426fda568ade6d959c89be"></a>DNSFailed&#160;</td><td class="fielddoc"></td></tr>
  147. <tr><td class="fieldname"><a id="a5d74787dedbc4e11c1ab15bf487e61f8ad253364cc2926eb617b0833335fe4467" name="a5d74787dedbc4e11c1ab15bf487e61f8ad253364cc2926eb617b0833335fe4467"></a>Connected&#160;</td><td class="fielddoc"></td></tr>
  148. <tr><td class="fieldname"><a id="a5d74787dedbc4e11c1ab15bf487e61f8a21bdfb4a7dfb3d3c26bdabf983777eb0" name="a5d74787dedbc4e11c1ab15bf487e61f8a21bdfb4a7dfb3d3c26bdabf983777eb0"></a>ConnectFailed&#160;</td><td class="fielddoc"></td></tr>
  149. <tr><td class="fieldname"><a id="a5d74787dedbc4e11c1ab15bf487e61f8a84ab0fbbb76a8c897feb1cd806d56443" name="a5d74787dedbc4e11c1ab15bf487e61f8a84ab0fbbb76a8c897feb1cd806d56443"></a>Disconnected&#160;</td><td class="fielddoc"></td></tr>
  150. </table>
  151. </div>
  152. </div>
  153. <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  154. <a id="a7035a6da2d6a329f76ee34a730921231" name="a7035a6da2d6a329f76ee34a730921231"></a>
  155. <h2 class="memtitle"><span class="permalink"><a href="#a7035a6da2d6a329f76ee34a730921231">&#9670;&#160;</a></span>ConnectedNotifyEvent()</h2>
  156. <div class="memitem">
  157. <div class="memproto">
  158. <table class="mlabels">
  159. <tr>
  160. <td class="mlabels-left">
  161. <table class="memname">
  162. <tr>
  163. <td class="memname"><a class="el" href="struct_connected_notify_event.html">ConnectedNotifyEvent</a> </td>
  164. <td>(</td>
  165. <td class="paramname"></td><td>)</td>
  166. <td></td>
  167. </tr>
  168. </table>
  169. </td>
  170. <td class="mlabels-right">
  171. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  172. </tr>
  173. </table>
  174. </div><div class="memdoc">
  175. </div>
  176. </div>
  177. <h2 class="groupheader">Member Data Documentation</h2>
  178. <a id="a5518cc4919b6fe5d9fd1b873be194127" name="a5518cc4919b6fe5d9fd1b873be194127"></a>
  179. <h2 class="memtitle"><span class="permalink"><a href="#a5518cc4919b6fe5d9fd1b873be194127">&#9670;&#160;</a></span>state</h2>
  180. <div class="memitem">
  181. <div class="memproto">
  182. <table class="memname">
  183. <tr>
  184. <td class="memname">U32 state</td>
  185. </tr>
  186. </table>
  187. </div><div class="memdoc">
  188. <p>Indicates current connection state. </p>
  189. </div>
  190. </div>
  191. <a id="abc52217fba007d6ea01acd390e807d1b" name="abc52217fba007d6ea01acd390e807d1b"></a>
  192. <h2 class="memtitle"><span class="permalink"><a href="#abc52217fba007d6ea01acd390e807d1b">&#9670;&#160;</a></span>tag</h2>
  193. <div class="memitem">
  194. <div class="memproto">
  195. <table class="memname">
  196. <tr>
  197. <td class="memname"><a class="el" href="class_net_socket.html">NetSocket</a> tag</td>
  198. </tr>
  199. </table>
  200. </div><div class="memdoc">
  201. <p>Identifies connection. </p>
  202. </div>
  203. </div>
  204. <hr/>The documentation for this struct was generated from the following file:<ul>
  205. <li>platform/<b>event.h</b></li>
  206. </ul>
  207. </div><!-- contents -->
  208. <!-- start footer part -->
  209. <hr class="footer"/><address class="footer"><small>
  210. 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
  211. </small></address>
  212. </body>
  213. </html>