/src/middleware/enet/docs/protocol_8h.html

https://bitbucket.org/vivkin/gam3b00bs/ · HTML · 157 lines · 154 code · 2 blank · 1 comment · 0 complexity · 1ec6e420bafaeacb70ea2a5ea32df73e MD5 · raw file

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <title>enet: protocol.h File Reference</title>
  6. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  7. <link href="doxygen.css" rel="stylesheet" type="text/css"/>
  8. </head>
  9. <body>
  10. <!-- Generated by Doxygen 1.7.1 -->
  11. <div class="navigation" id="top">
  12. <div class="tabs">
  13. <ul class="tablist">
  14. <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
  15. <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  16. <li><a href="modules.html"><span>Modules</span></a></li>
  17. <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
  18. <li class="current"><a href="files.html"><span>Files</span></a></li>
  19. </ul>
  20. </div>
  21. <div class="tabs2">
  22. <ul class="tablist">
  23. <li><a href="files.html"><span>File&nbsp;List</span></a></li>
  24. <li><a href="globals.html"><span>Globals</span></a></li>
  25. </ul>
  26. </div>
  27. </div>
  28. <div class="header">
  29. <div class="summary">
  30. <a href="#nested-classes">Data Structures</a> &#124;
  31. <a href="#define-members">Defines</a> &#124;
  32. <a href="#typedef-members">Typedefs</a> &#124;
  33. <a href="#enum-members">Enumerations</a> </div>
  34. <div class="headertitle">
  35. <h1>protocol.h File Reference</h1> </div>
  36. </div>
  37. <div class="contents">
  38. <p>ENet protocol.
  39. <a href="#_details">More...</a></p>
  40. <code>#include &quot;<a class="el" href="types_8h_source.html">enet/types.h</a>&quot;</code><br/>
  41. <p><a href="protocol_8h_source.html">Go to the source code of this file.</a></p>
  42. <table class="memberdecls">
  43. <tr><td colspan="2"><h2><a name="nested-classes"></a>
  44. Data Structures</h2></td></tr>
  45. <tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetProtocolHeader.html">_ENetProtocolHeader</a></td></tr>
  46. <tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetProtocolCommandHeader.html">_ENetProtocolCommandHeader</a></td></tr>
  47. <tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetProtocolAcknowledge.html">_ENetProtocolAcknowledge</a></td></tr>
  48. <tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetProtocolConnect.html">_ENetProtocolConnect</a></td></tr>
  49. <tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetProtocolVerifyConnect.html">_ENetProtocolVerifyConnect</a></td></tr>
  50. <tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetProtocolBandwidthLimit.html">_ENetProtocolBandwidthLimit</a></td></tr>
  51. <tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetProtocolThrottleConfigure.html">_ENetProtocolThrottleConfigure</a></td></tr>
  52. <tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetProtocolDisconnect.html">_ENetProtocolDisconnect</a></td></tr>
  53. <tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetProtocolPing.html">_ENetProtocolPing</a></td></tr>
  54. <tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetProtocolSendReliable.html">_ENetProtocolSendReliable</a></td></tr>
  55. <tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetProtocolSendUnreliable.html">_ENetProtocolSendUnreliable</a></td></tr>
  56. <tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetProtocolSendUnsequenced.html">_ENetProtocolSendUnsequenced</a></td></tr>
  57. <tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetProtocolSendFragment.html">_ENetProtocolSendFragment</a></td></tr>
  58. <tr><td class="memItemLeft" align="right" valign="top">union &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="union__ENetProtocol.html">_ENetProtocol</a></td></tr>
  59. <tr><td colspan="2"><h2><a name="typedef-members"></a>
  60. Typedefs</h2></td></tr>
  61. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a05a936aa528d618375ed1e7d19a161c5"></a><!-- doxytag: member="protocol.h::ENetProtocolCommand" ref="a05a936aa528d618375ed1e7d19a161c5" args="" -->
  62. typedef enum _ENetProtocolCommand&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetProtocolCommand</b></td></tr>
  63. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af14766e694ee036cce548b3c16123541"></a><!-- doxytag: member="protocol.h::ENetProtocolFlag" ref="af14766e694ee036cce548b3c16123541" args="" -->
  64. typedef enum _ENetProtocolFlag&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetProtocolFlag</b></td></tr>
  65. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aad507ebf1b925e294e3a2f175cbcd7d9"></a><!-- doxytag: member="protocol.h::ENetProtocolHeader" ref="aad507ebf1b925e294e3a2f175cbcd7d9" args="" -->
  66. typedef struct <a class="el" href="struct__ENetProtocolHeader.html">_ENetProtocolHeader</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetProtocolHeader</b></td></tr>
  67. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9e3618482e85596ba9403ee09e9c1020"></a><!-- doxytag: member="protocol.h::ENetProtocolCommandHeader" ref="a9e3618482e85596ba9403ee09e9c1020" args="" -->
  68. typedef struct <br class="typebreak"/>
  69. <a class="el" href="struct__ENetProtocolCommandHeader.html">_ENetProtocolCommandHeader</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetProtocolCommandHeader</b></td></tr>
  70. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7d9fbdba6e50c3d5fad0c4b6cf6f6c90"></a><!-- doxytag: member="protocol.h::ENetProtocolAcknowledge" ref="a7d9fbdba6e50c3d5fad0c4b6cf6f6c90" args="" -->
  71. typedef struct <br class="typebreak"/>
  72. <a class="el" href="struct__ENetProtocolAcknowledge.html">_ENetProtocolAcknowledge</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetProtocolAcknowledge</b></td></tr>
  73. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7891380ae5c2590c92690c7521ece09c"></a><!-- doxytag: member="protocol.h::ENetProtocolConnect" ref="a7891380ae5c2590c92690c7521ece09c" args="" -->
  74. typedef struct <a class="el" href="struct__ENetProtocolConnect.html">_ENetProtocolConnect</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetProtocolConnect</b></td></tr>
  75. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1aa28002e4974f1b6c22c24014e5fe35"></a><!-- doxytag: member="protocol.h::ENetProtocolVerifyConnect" ref="a1aa28002e4974f1b6c22c24014e5fe35" args="" -->
  76. typedef struct <br class="typebreak"/>
  77. <a class="el" href="struct__ENetProtocolVerifyConnect.html">_ENetProtocolVerifyConnect</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetProtocolVerifyConnect</b></td></tr>
  78. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a46b110845b0c0b748aa953f1cb4fe9a8"></a><!-- doxytag: member="protocol.h::ENetProtocolBandwidthLimit" ref="a46b110845b0c0b748aa953f1cb4fe9a8" args="" -->
  79. typedef struct <br class="typebreak"/>
  80. <a class="el" href="struct__ENetProtocolBandwidthLimit.html">_ENetProtocolBandwidthLimit</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetProtocolBandwidthLimit</b></td></tr>
  81. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a853de3af91cf6cd5391c29ae512a5ecd"></a><!-- doxytag: member="protocol.h::ENetProtocolThrottleConfigure" ref="a853de3af91cf6cd5391c29ae512a5ecd" args="" -->
  82. typedef struct <br class="typebreak"/>
  83. <a class="el" href="struct__ENetProtocolThrottleConfigure.html">_ENetProtocolThrottleConfigure</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetProtocolThrottleConfigure</b></td></tr>
  84. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a795e6ba7faf70e597a9c7ac883250d85"></a><!-- doxytag: member="protocol.h::ENetProtocolDisconnect" ref="a795e6ba7faf70e597a9c7ac883250d85" args="" -->
  85. typedef struct <br class="typebreak"/>
  86. <a class="el" href="struct__ENetProtocolDisconnect.html">_ENetProtocolDisconnect</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetProtocolDisconnect</b></td></tr>
  87. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0b5b74b8cd1b5afb02646354ed7d0220"></a><!-- doxytag: member="protocol.h::ENetProtocolPing" ref="a0b5b74b8cd1b5afb02646354ed7d0220" args="" -->
  88. typedef struct <a class="el" href="struct__ENetProtocolPing.html">_ENetProtocolPing</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetProtocolPing</b></td></tr>
  89. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5ad19c5fc39268a2b5e33f9714abdb8f"></a><!-- doxytag: member="protocol.h::ENetProtocolSendReliable" ref="a5ad19c5fc39268a2b5e33f9714abdb8f" args="" -->
  90. typedef struct <br class="typebreak"/>
  91. <a class="el" href="struct__ENetProtocolSendReliable.html">_ENetProtocolSendReliable</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetProtocolSendReliable</b></td></tr>
  92. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afef850d31e169ddf1dd02c430db82ef6"></a><!-- doxytag: member="protocol.h::ENetProtocolSendUnreliable" ref="afef850d31e169ddf1dd02c430db82ef6" args="" -->
  93. typedef struct <br class="typebreak"/>
  94. <a class="el" href="struct__ENetProtocolSendUnreliable.html">_ENetProtocolSendUnreliable</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetProtocolSendUnreliable</b></td></tr>
  95. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad63e61158b89a5d160de36986bba52b2"></a><!-- doxytag: member="protocol.h::ENetProtocolSendUnsequenced" ref="ad63e61158b89a5d160de36986bba52b2" args="" -->
  96. typedef struct <br class="typebreak"/>
  97. <a class="el" href="struct__ENetProtocolSendUnsequenced.html">_ENetProtocolSendUnsequenced</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetProtocolSendUnsequenced</b></td></tr>
  98. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4e419692dc01a5627967ff1703121ef7"></a><!-- doxytag: member="protocol.h::ENetProtocolSendFragment" ref="a4e419692dc01a5627967ff1703121ef7" args="" -->
  99. typedef struct <br class="typebreak"/>
  100. <a class="el" href="struct__ENetProtocolSendFragment.html">_ENetProtocolSendFragment</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetProtocolSendFragment</b></td></tr>
  101. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afceae4a4825b2d50174babcc224c5c93"></a><!-- doxytag: member="protocol.h::ENetProtocol" ref="afceae4a4825b2d50174babcc224c5c93" args="" -->
  102. typedef union <a class="el" href="union__ENetProtocol.html">_ENetProtocol</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetProtocol</b></td></tr>
  103. <tr><td colspan="2"><h2><a name="enum-members"></a>
  104. Enumerations</h2></td></tr>
  105. <tr><td class="memItemLeft" align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom">{ <br/>
  106. &nbsp;&nbsp;<b>ENET_PROTOCOL_MINIMUM_MTU</b> = 576,
  107. <b>ENET_PROTOCOL_MAXIMUM_MTU</b> = 4096,
  108. <b>ENET_PROTOCOL_MAXIMUM_PACKET_COMMANDS</b> = 32,
  109. <b>ENET_PROTOCOL_MINIMUM_WINDOW_SIZE</b> = 4096,
  110. <br/>
  111. &nbsp;&nbsp;<b>ENET_PROTOCOL_MAXIMUM_WINDOW_SIZE</b> = 32768,
  112. <b>ENET_PROTOCOL_MINIMUM_CHANNEL_COUNT</b> = 1,
  113. <b>ENET_PROTOCOL_MAXIMUM_CHANNEL_COUNT</b> = 255,
  114. <b>ENET_PROTOCOL_MAXIMUM_PEER_ID</b> = 0xFFF
  115. <br/>
  116. }</td></tr>
  117. <tr><td class="memItemLeft" align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><b>_ENetProtocolCommand</b> { <br/>
  118. &nbsp;&nbsp;<b>ENET_PROTOCOL_COMMAND_NONE</b> = 0,
  119. <b>ENET_PROTOCOL_COMMAND_ACKNOWLEDGE</b> = 1,
  120. <b>ENET_PROTOCOL_COMMAND_CONNECT</b> = 2,
  121. <b>ENET_PROTOCOL_COMMAND_VERIFY_CONNECT</b> = 3,
  122. <br/>
  123. &nbsp;&nbsp;<b>ENET_PROTOCOL_COMMAND_DISCONNECT</b> = 4,
  124. <b>ENET_PROTOCOL_COMMAND_PING</b> = 5,
  125. <b>ENET_PROTOCOL_COMMAND_SEND_RELIABLE</b> = 6,
  126. <b>ENET_PROTOCOL_COMMAND_SEND_UNRELIABLE</b> = 7,
  127. <br/>
  128. &nbsp;&nbsp;<b>ENET_PROTOCOL_COMMAND_SEND_FRAGMENT</b> = 8,
  129. <b>ENET_PROTOCOL_COMMAND_SEND_UNSEQUENCED</b> = 9,
  130. <b>ENET_PROTOCOL_COMMAND_BANDWIDTH_LIMIT</b> = 10,
  131. <b>ENET_PROTOCOL_COMMAND_THROTTLE_CONFIGURE</b> = 11,
  132. <br/>
  133. &nbsp;&nbsp;<b>ENET_PROTOCOL_COMMAND_COUNT</b> = 12,
  134. <b>ENET_PROTOCOL_COMMAND_MASK</b> = 0x0F
  135. <br/>
  136. }</td></tr>
  137. <tr><td class="memItemLeft" align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><b>_ENetProtocolFlag</b> { <br/>
  138. &nbsp;&nbsp;<b>ENET_PROTOCOL_COMMAND_FLAG_ACKNOWLEDGE</b> = (1 &lt;&lt; 7),
  139. <b>ENET_PROTOCOL_COMMAND_FLAG_UNSEQUENCED</b> = (1 &lt;&lt; 6),
  140. <b>ENET_PROTOCOL_HEADER_FLAG_COMPRESSED</b> = (1 &lt;&lt; 14),
  141. <b>ENET_PROTOCOL_HEADER_FLAG_SENT_TIME</b> = (1 &lt;&lt; 15),
  142. <br/>
  143. &nbsp;&nbsp;<b>ENET_PROTOCOL_HEADER_FLAG_MASK</b> = ENET_PROTOCOL_HEADER_FLAG_COMPRESSED | ENET_PROTOCOL_HEADER_FLAG_SENT_TIME,
  144. <b>ENET_PROTOCOL_HEADER_SESSION_MASK</b> = (3 &lt;&lt; 12),
  145. <b>ENET_PROTOCOL_HEADER_SESSION_SHIFT</b> = 12
  146. <br/>
  147. }</td></tr>
  148. </table>
  149. <hr/><a name="_details"></a><h2>Detailed Description</h2>
  150. </div>
  151. <hr class="footer"/><address class="footer"><small>Generated on Wed Feb 9 2011 21:31:05 for enet by&nbsp;
  152. <a href="http://www.doxygen.org/index.html">
  153. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
  154. </body>
  155. </html>