/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. 

  2. <html xmlns="http://www.w3.org/1999/xhtml">
    3. 

  3. <head>
    4. 

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
    5. 

  5. <title>enet: protocol.h File Reference</title>
    6. 

  6. <link href="tabs.css" rel="stylesheet" type="text/css"/>
    7. 

  7. <link href="doxygen.css" rel="stylesheet" type="text/css"/>
    8. 

  8. </head>
    9. 

  9. <body>
    10. 

  10. <!-- Generated by Doxygen 1.7.1 -->
    11. 

  11. <div class="navigation" id="top">
    12. 

  12.   <div class="tabs">
    13. 

  13.     <ul class="tablist">
    14. 

  14.       <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    15. 

  15.       <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
    16. 

  16.       <li><a href="modules.html"><span>Modules</span></a></li>
    17. 

  17.       <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
    18. 

  18.       <li class="current"><a href="files.html"><span>Files</span></a></li>
    19. 

  19.     </ul>
    20. 

  20.   </div>
    21. 

  21.   <div class="tabs2">
    22. 

  22.     <ul class="tablist">
    23. 

  23.       <li><a href="files.html"><span>File&nbsp;List</span></a></li>
    24. 

  24.       <li><a href="globals.html"><span>Globals</span></a></li>
    25. 

  25.     </ul>
    26. 

  26.   </div>
    27. 

  27. </div>
    28. 

  28. <div class="header">
    29. 

  29.   <div class="summary">
    30. 

  30. <a href="#nested-classes">Data Structures</a> &#124;
    31. 

  31. <a href="#define-members">Defines</a> &#124;
    32. 

  32. <a href="#typedef-members">Typedefs</a> &#124;
    33. 

  33. <a href="#enum-members">Enumerations</a>  </div>
    34. 

  34.   <div class="headertitle">
    35. 

  35. <h1>protocol.h File Reference</h1>  </div>
    36. 

  36. </div>
    37. 

  37. <div class="contents">
    38. 

  38. 

  39. <p>ENet protocol.  
    40. 

  40. <a href="#_details">More...</a></p>
    41. 

  41. <code>#include &quot;<a class="el" href="types_8h_source.html">enet/types.h</a>&quot;</code><br/>
    42. 

  42. 

  43. <p><a href="protocol_8h_source.html">Go to the source code of this file.</a></p>
    44. 

  44. <table class="memberdecls">
    45. 

  45. <tr><td colspan="2"><h2><a name="nested-classes"></a>
    46. 

  46. Data Structures</h2></td></tr>
    47. 

  47. <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>
    48. 

  48. <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>
    49. 

  49. <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>
    50. 

  50. <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>
    51. 

  51. <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>
    52. 

  52. <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>
    53. 

  53. <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>
    54. 

  54. <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>
    55. 

  55. <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>
    56. 

  56. <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>
    57. 

  57. <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>
    58. 

  58. <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>
    59. 

  59. <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>
    60. 

  60. <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>
    61. 

  61. <tr><td colspan="2"><h2><a name="typedef-members"></a>
    62. 

  62. Typedefs</h2></td></tr>
    63. 

  63. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a05a936aa528d618375ed1e7d19a161c5"></a><!-- doxytag: member="protocol.h::ENetProtocolCommand" ref="a05a936aa528d618375ed1e7d19a161c5" args="" -->
    64. 

  64. typedef enum _ENetProtocolCommand&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetProtocolCommand</b></td></tr>
    65. 

  65. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af14766e694ee036cce548b3c16123541"></a><!-- doxytag: member="protocol.h::ENetProtocolFlag" ref="af14766e694ee036cce548b3c16123541" args="" -->
    66. 

  66. typedef enum _ENetProtocolFlag&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetProtocolFlag</b></td></tr>
    67. 

  67. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aad507ebf1b925e294e3a2f175cbcd7d9"></a><!-- doxytag: member="protocol.h::ENetProtocolHeader" ref="aad507ebf1b925e294e3a2f175cbcd7d9" args="" -->
    68. 

  68. typedef struct <a class="el" href="struct__ENetProtocolHeader.html">_ENetProtocolHeader</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetProtocolHeader</b></td></tr>
    69. 

  69. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9e3618482e85596ba9403ee09e9c1020"></a><!-- doxytag: member="protocol.h::ENetProtocolCommandHeader" ref="a9e3618482e85596ba9403ee09e9c1020" args="" -->
    70. 

  70. typedef struct <br class="typebreak"/>
    71. 

  71. <a class="el" href="struct__ENetProtocolCommandHeader.html">_ENetProtocolCommandHeader</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetProtocolCommandHeader</b></td></tr>
    72. 

  72. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7d9fbdba6e50c3d5fad0c4b6cf6f6c90"></a><!-- doxytag: member="protocol.h::ENetProtocolAcknowledge" ref="a7d9fbdba6e50c3d5fad0c4b6cf6f6c90" args="" -->
    73. 

  73. typedef struct <br class="typebreak"/>
    74. 

  74. <a class="el" href="struct__ENetProtocolAcknowledge.html">_ENetProtocolAcknowledge</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetProtocolAcknowledge</b></td></tr>
    75. 

  75. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7891380ae5c2590c92690c7521ece09c"></a><!-- doxytag: member="protocol.h::ENetProtocolConnect" ref="a7891380ae5c2590c92690c7521ece09c" args="" -->
    76. 

  76. typedef struct <a class="el" href="struct__ENetProtocolConnect.html">_ENetProtocolConnect</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetProtocolConnect</b></td></tr>
    77. 

  77. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1aa28002e4974f1b6c22c24014e5fe35"></a><!-- doxytag: member="protocol.h::ENetProtocolVerifyConnect" ref="a1aa28002e4974f1b6c22c24014e5fe35" args="" -->
    78. 

  78. typedef struct <br class="typebreak"/>
    79. 

  79. <a class="el" href="struct__ENetProtocolVerifyConnect.html">_ENetProtocolVerifyConnect</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetProtocolVerifyConnect</b></td></tr>
    80. 

  80. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a46b110845b0c0b748aa953f1cb4fe9a8"></a><!-- doxytag: member="protocol.h::ENetProtocolBandwidthLimit" ref="a46b110845b0c0b748aa953f1cb4fe9a8" args="" -->
    81. 

  81. typedef struct <br class="typebreak"/>
    82. 

  82. <a class="el" href="struct__ENetProtocolBandwidthLimit.html">_ENetProtocolBandwidthLimit</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetProtocolBandwidthLimit</b></td></tr>
    83. 

  83. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a853de3af91cf6cd5391c29ae512a5ecd"></a><!-- doxytag: member="protocol.h::ENetProtocolThrottleConfigure" ref="a853de3af91cf6cd5391c29ae512a5ecd" args="" -->
    84. 

  84. typedef struct <br class="typebreak"/>
    85. 

  85. <a class="el" href="struct__ENetProtocolThrottleConfigure.html">_ENetProtocolThrottleConfigure</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetProtocolThrottleConfigure</b></td></tr>
    86. 

  86. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a795e6ba7faf70e597a9c7ac883250d85"></a><!-- doxytag: member="protocol.h::ENetProtocolDisconnect" ref="a795e6ba7faf70e597a9c7ac883250d85" args="" -->
    87. 

  87. typedef struct <br class="typebreak"/>
    88. 

  88. <a class="el" href="struct__ENetProtocolDisconnect.html">_ENetProtocolDisconnect</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetProtocolDisconnect</b></td></tr>
    89. 

  89. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0b5b74b8cd1b5afb02646354ed7d0220"></a><!-- doxytag: member="protocol.h::ENetProtocolPing" ref="a0b5b74b8cd1b5afb02646354ed7d0220" args="" -->
    90. 

  90. typedef struct <a class="el" href="struct__ENetProtocolPing.html">_ENetProtocolPing</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetProtocolPing</b></td></tr>
    91. 

  91. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5ad19c5fc39268a2b5e33f9714abdb8f"></a><!-- doxytag: member="protocol.h::ENetProtocolSendReliable" ref="a5ad19c5fc39268a2b5e33f9714abdb8f" args="" -->
    92. 

  92. typedef struct <br class="typebreak"/>
    93. 

  93. <a class="el" href="struct__ENetProtocolSendReliable.html">_ENetProtocolSendReliable</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetProtocolSendReliable</b></td></tr>
    94. 

  94. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afef850d31e169ddf1dd02c430db82ef6"></a><!-- doxytag: member="protocol.h::ENetProtocolSendUnreliable" ref="afef850d31e169ddf1dd02c430db82ef6" args="" -->
    95. 

  95. typedef struct <br class="typebreak"/>
    96. 

  96. <a class="el" href="struct__ENetProtocolSendUnreliable.html">_ENetProtocolSendUnreliable</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetProtocolSendUnreliable</b></td></tr>
    97. 

  97. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad63e61158b89a5d160de36986bba52b2"></a><!-- doxytag: member="protocol.h::ENetProtocolSendUnsequenced" ref="ad63e61158b89a5d160de36986bba52b2" args="" -->
    98. 

  98. typedef struct <br class="typebreak"/>
    99. 

  99. <a class="el" href="struct__ENetProtocolSendUnsequenced.html">_ENetProtocolSendUnsequenced</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetProtocolSendUnsequenced</b></td></tr>
    100. 

  100. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4e419692dc01a5627967ff1703121ef7"></a><!-- doxytag: member="protocol.h::ENetProtocolSendFragment" ref="a4e419692dc01a5627967ff1703121ef7" args="" -->
    101. 

  101. typedef struct <br class="typebreak"/>
    102. 

  102. <a class="el" href="struct__ENetProtocolSendFragment.html">_ENetProtocolSendFragment</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetProtocolSendFragment</b></td></tr>
    103. 

  103. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afceae4a4825b2d50174babcc224c5c93"></a><!-- doxytag: member="protocol.h::ENetProtocol" ref="afceae4a4825b2d50174babcc224c5c93" args="" -->
    104. 

  104. typedef union <a class="el" href="union__ENetProtocol.html">_ENetProtocol</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetProtocol</b></td></tr>
    105. 

  105. <tr><td colspan="2"><h2><a name="enum-members"></a>
    106. 

  106. Enumerations</h2></td></tr>
    107. 

  107. <tr><td class="memItemLeft" align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom">{ <br/>
    108. 

  108. &nbsp;&nbsp;<b>ENET_PROTOCOL_MINIMUM_MTU</b> =  576, 
    109. 

  109. <b>ENET_PROTOCOL_MAXIMUM_MTU</b> =  4096, 
    110. 

  110. <b>ENET_PROTOCOL_MAXIMUM_PACKET_COMMANDS</b> =  32, 
    111. 

  111. <b>ENET_PROTOCOL_MINIMUM_WINDOW_SIZE</b> =  4096, 
    112. 

  112. <br/>
    113. 

  113. &nbsp;&nbsp;<b>ENET_PROTOCOL_MAXIMUM_WINDOW_SIZE</b> =  32768, 
    114. 

  114. <b>ENET_PROTOCOL_MINIMUM_CHANNEL_COUNT</b> =  1, 
    115. 

  115. <b>ENET_PROTOCOL_MAXIMUM_CHANNEL_COUNT</b> =  255, 
    116. 

  116. <b>ENET_PROTOCOL_MAXIMUM_PEER_ID</b> =  0xFFF
    117. 

  117. <br/>
    118. 

  118.  }</td></tr>
    119. 

  119. <tr><td class="memItemLeft" align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><b>_ENetProtocolCommand</b> { <br/>
    120. 

  120. &nbsp;&nbsp;<b>ENET_PROTOCOL_COMMAND_NONE</b> =  0, 
    121. 

  121. <b>ENET_PROTOCOL_COMMAND_ACKNOWLEDGE</b> =  1, 
    122. 

  122. <b>ENET_PROTOCOL_COMMAND_CONNECT</b> =  2, 
    123. 

  123. <b>ENET_PROTOCOL_COMMAND_VERIFY_CONNECT</b> =  3, 
    124. 

  124. <br/>
    125. 

  125. &nbsp;&nbsp;<b>ENET_PROTOCOL_COMMAND_DISCONNECT</b> =  4, 
    126. 

  126. <b>ENET_PROTOCOL_COMMAND_PING</b> =  5, 
    127. 

  127. <b>ENET_PROTOCOL_COMMAND_SEND_RELIABLE</b> =  6, 
    128. 

  128. <b>ENET_PROTOCOL_COMMAND_SEND_UNRELIABLE</b> =  7, 
    129. 

  129. <br/>
    130. 

  130. &nbsp;&nbsp;<b>ENET_PROTOCOL_COMMAND_SEND_FRAGMENT</b> =  8, 
    131. 

  131. <b>ENET_PROTOCOL_COMMAND_SEND_UNSEQUENCED</b> =  9, 
    132. 

  132. <b>ENET_PROTOCOL_COMMAND_BANDWIDTH_LIMIT</b> =  10, 
    133. 

  133. <b>ENET_PROTOCOL_COMMAND_THROTTLE_CONFIGURE</b> =  11, 
    134. 

  134. <br/>
    135. 

  135. &nbsp;&nbsp;<b>ENET_PROTOCOL_COMMAND_COUNT</b> =  12, 
    136. 

  136. <b>ENET_PROTOCOL_COMMAND_MASK</b> =  0x0F
    137. 

  137. <br/>
    138. 

  138.  }</td></tr>
    139. 

  139. <tr><td class="memItemLeft" align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><b>_ENetProtocolFlag</b> { <br/>
    140. 

  140. &nbsp;&nbsp;<b>ENET_PROTOCOL_COMMAND_FLAG_ACKNOWLEDGE</b> =  (1 &lt;&lt; 7), 
    141. 

  141. <b>ENET_PROTOCOL_COMMAND_FLAG_UNSEQUENCED</b> =  (1 &lt;&lt; 6), 
    142. 

  142. <b>ENET_PROTOCOL_HEADER_FLAG_COMPRESSED</b> =  (1 &lt;&lt; 14), 
    143. 

  143. <b>ENET_PROTOCOL_HEADER_FLAG_SENT_TIME</b> =  (1 &lt;&lt; 15), 
    144. 

  144. <br/>
    145. 

  145. &nbsp;&nbsp;<b>ENET_PROTOCOL_HEADER_FLAG_MASK</b> =  ENET_PROTOCOL_HEADER_FLAG_COMPRESSED | ENET_PROTOCOL_HEADER_FLAG_SENT_TIME, 
    146. 

  146. <b>ENET_PROTOCOL_HEADER_SESSION_MASK</b> =  (3 &lt;&lt; 12), 
    147. 

  147. <b>ENET_PROTOCOL_HEADER_SESSION_SHIFT</b> =  12
    148. 

  148. <br/>
    149. 

  149.  }</td></tr>
    150. 

  150. </table>
    151. 

  151. <hr/><a name="_details"></a><h2>Detailed Description</h2>
    152. 

  152. </div>
    153. 

  153. <hr class="footer"/><address class="footer"><small>Generated on Wed Feb 9 2011 21:31:05 for enet by&nbsp;
    154. 

  154. <a href="http://www.doxygen.org/index.html">
    155. 

  155. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
    156. 

  156. </body>
    157. 

  157. </html>
    158.