PageRenderTime 36ms CodeModel.GetById 20ms RepoModel.GetById 0ms app.codeStats 0ms

/src/middleware/enet/docs/enet_8h.html

https://bitbucket.org/vivkin/gam3b00bs/
HTML | 552 lines | 538 code | 13 blank | 1 comment | 0 complexity | 871cadf1255599b4c573b044dd1ed42a 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: enet.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> &#124;
  34. <a href="#func-members">Functions</a> </div>
  35. <div class="headertitle">
  36. <h1>enet.h File Reference</h1> </div>
  37. </div>
  38. <div class="contents">
  39. <p>ENet public header file.
  40. <a href="#_details">More...</a></p>
  41. <code>#include &lt;stdlib.h&gt;</code><br/>
  42. <code>#include &quot;<a class="el" href="unix_8h_source.html">enet/unix.h</a>&quot;</code><br/>
  43. <code>#include &quot;<a class="el" href="types_8h_source.html">enet/types.h</a>&quot;</code><br/>
  44. <code>#include &quot;<a class="el" href="protocol_8h_source.html">enet/protocol.h</a>&quot;</code><br/>
  45. <code>#include &quot;<a class="el" href="list_8h_source.html">enet/list.h</a>&quot;</code><br/>
  46. <code>#include &quot;<a class="el" href="callbacks_8h_source.html">enet/callbacks.h</a>&quot;</code><br/>
  47. <p><a href="enet_8h_source.html">Go to the source code of this file.</a></p>
  48. <table class="memberdecls">
  49. <tr><td colspan="2"><h2><a name="nested-classes"></a>
  50. Data Structures</h2></td></tr>
  51. <tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetAddress.html">_ENetAddress</a></td></tr>
  52. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Portable internet address structure. <a href="struct__ENetAddress.html#_details">More...</a><br/></td></tr>
  53. <tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetPacket.html">_ENetPacket</a></td></tr>
  54. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">ENet packet structure. <a href="struct__ENetPacket.html#_details">More...</a><br/></td></tr>
  55. <tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetAcknowledgement.html">_ENetAcknowledgement</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__ENetOutgoingCommand.html">_ENetOutgoingCommand</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__ENetIncomingCommand.html">_ENetIncomingCommand</a></td></tr>
  58. <tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetChannel.html">_ENetChannel</a></td></tr>
  59. <tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetPeer.html">_ENetPeer</a></td></tr>
  60. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">An ENet peer which data packets may be sent or received from. <a href="struct__ENetPeer.html#_details">More...</a><br/></td></tr>
  61. <tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetCompressor.html">_ENetCompressor</a></td></tr>
  62. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">An ENet packet compressor for compressing UDP packets before socket sends or receives. <a href="struct__ENetCompressor.html#_details">More...</a><br/></td></tr>
  63. <tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetHost.html">_ENetHost</a></td></tr>
  64. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">An ENet host for communicating with peers. <a href="struct__ENetHost.html#_details">More...</a><br/></td></tr>
  65. <tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetEvent.html">_ENetEvent</a></td></tr>
  66. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">An ENet event as returned by <a class="el" href="group__host.html#ga6ba501b3ee576e5578c8e6d1694ebd49" title="Waits for events on the host specified and shuttles packets between the host and its peers...">enet_host_service()</a>. <a href="struct__ENetEvent.html#_details">More...</a><br/></td></tr>
  67. <tr><td colspan="2"><h2><a name="define-members"></a>
  68. Defines</h2></td></tr>
  69. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab7ed937c2db14ba2efb15c6a1626942a"></a><!-- doxytag: member="enet.h::ENET_VERSION_MAJOR" ref="ab7ed937c2db14ba2efb15c6a1626942a" args="" -->
  70. #define&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENET_VERSION_MAJOR</b>&nbsp;&nbsp;&nbsp;1</td></tr>
  71. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7e3fba7774ffbf6f095c7c1c643db823"></a><!-- doxytag: member="enet.h::ENET_VERSION_MINOR" ref="a7e3fba7774ffbf6f095c7c1c643db823" args="" -->
  72. #define&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENET_VERSION_MINOR</b>&nbsp;&nbsp;&nbsp;3</td></tr>
  73. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7e08f37772431845fe118f9a87bebda2"></a><!-- doxytag: member="enet.h::ENET_VERSION_PATCH" ref="a7e08f37772431845fe118f9a87bebda2" args="" -->
  74. #define&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENET_VERSION_PATCH</b>&nbsp;&nbsp;&nbsp;1</td></tr>
  75. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab3ebd57b901e14fa1ff745b0472ea786"></a><!-- doxytag: member="enet.h::ENET_VERSION_CREATE" ref="ab3ebd57b901e14fa1ff745b0472ea786" args="(major, minor, patch)" -->
  76. #define&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENET_VERSION_CREATE</b>(major, minor, patch)&nbsp;&nbsp;&nbsp;(((major)&lt;&lt;16) | ((minor)&lt;&lt;8) | (patch))</td></tr>
  77. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aefb355eb62b5a7096faf91b3134e9016"></a><!-- doxytag: member="enet.h::ENET_VERSION" ref="aefb355eb62b5a7096faf91b3134e9016" args="" -->
  78. #define&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENET_VERSION</b>&nbsp;&nbsp;&nbsp;ENET_VERSION_CREATE(ENET_VERSION_MAJOR, ENET_VERSION_MINOR, ENET_VERSION_PATCH)</td></tr>
  79. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4e71003e6043d745c1d69d0b35a76c1d"></a><!-- doxytag: member="enet.h::ENET_BUFFER_MAXIMUM" ref="a4e71003e6043d745c1d69d0b35a76c1d" args="" -->
  80. #define&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENET_BUFFER_MAXIMUM</b>&nbsp;&nbsp;&nbsp;(1 + 2 * ENET_PROTOCOL_MAXIMUM_PACKET_COMMANDS)</td></tr>
  81. <tr><td colspan="2"><h2><a name="typedef-members"></a>
  82. Typedefs</h2></td></tr>
  83. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7e77c317884b9dc06ae73615f8da9a6f"></a><!-- doxytag: member="enet.h::ENetVersion" ref="a7e77c317884b9dc06ae73615f8da9a6f" args="" -->
  84. typedef <a class="el" href="types_8h.html#a5273659ca3c664b8550452732e9e4ae3">enet_uint32</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetVersion</b></td></tr>
  85. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0afa7e0d234a436854945ca25edfa1d5"></a><!-- doxytag: member="enet.h::ENetSocketType" ref="a0afa7e0d234a436854945ca25edfa1d5" args="" -->
  86. typedef enum _ENetSocketType&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetSocketType</b></td></tr>
  87. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8831a43df7e7cf1776a8043cccadec6d"></a><!-- doxytag: member="enet.h::ENetSocketWait" ref="a8831a43df7e7cf1776a8043cccadec6d" args="" -->
  88. typedef enum _ENetSocketWait&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetSocketWait</b></td></tr>
  89. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8f3c0ffa966a39a3c44591bb1ce8dcdb"></a><!-- doxytag: member="enet.h::ENetSocketOption" ref="a8f3c0ffa966a39a3c44591bb1ce8dcdb" args="" -->
  90. typedef enum _ENetSocketOption&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetSocketOption</b></td></tr>
  91. <tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="struct__ENetAddress.html">_ENetAddress</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="enet_8h.html#ac056c795b58ec874a9eb91259fb20198">ENetAddress</a></td></tr>
  92. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Portable internet address structure. <a href="#ac056c795b58ec874a9eb91259fb20198"></a><br/></td></tr>
  93. <tr><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="enet_8h.html#a9d1fc0ce6da0a057f18bd8b9c762003d">_ENetPacketFlag</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="enet_8h.html#a8441ed0d3b01899c4b7c6e9c5d72aa41">ENetPacketFlag</a></td></tr>
  94. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Packet flag bit constants. <a href="#a8441ed0d3b01899c4b7c6e9c5d72aa41"></a><br/></td></tr>
  95. <tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="struct__ENetPacket.html">_ENetPacket</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="enet_8h.html#afc931483a08e39defe4fbac06945626c">ENetPacket</a></td></tr>
  96. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">ENet packet structure. <a href="#afc931483a08e39defe4fbac06945626c"></a><br/></td></tr>
  97. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac28ad4a7aa8411543d22746e97477565"></a><!-- doxytag: member="enet.h::ENetAcknowledgement" ref="ac28ad4a7aa8411543d22746e97477565" args="" -->
  98. typedef struct <a class="el" href="struct__ENetAcknowledgement.html">_ENetAcknowledgement</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetAcknowledgement</b></td></tr>
  99. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a809548e645fd0008b76381d2b1b879bb"></a><!-- doxytag: member="enet.h::ENetOutgoingCommand" ref="a809548e645fd0008b76381d2b1b879bb" args="" -->
  100. typedef struct <a class="el" href="struct__ENetOutgoingCommand.html">_ENetOutgoingCommand</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetOutgoingCommand</b></td></tr>
  101. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad60d5b8d20e536abc78f6009592b4008"></a><!-- doxytag: member="enet.h::ENetIncomingCommand" ref="ad60d5b8d20e536abc78f6009592b4008" args="" -->
  102. typedef struct <a class="el" href="struct__ENetIncomingCommand.html">_ENetIncomingCommand</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetIncomingCommand</b></td></tr>
  103. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4edbc38b30da18e7bbc7c77a283632d2"></a><!-- doxytag: member="enet.h::ENetPeerState" ref="a4edbc38b30da18e7bbc7c77a283632d2" args="" -->
  104. typedef enum _ENetPeerState&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetPeerState</b></td></tr>
  105. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9fccff454cb933c4a26ea1e4a8995b74"></a><!-- doxytag: member="enet.h::ENetChannel" ref="a9fccff454cb933c4a26ea1e4a8995b74" args="" -->
  106. typedef struct <a class="el" href="struct__ENetChannel.html">_ENetChannel</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetChannel</b></td></tr>
  107. <tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="struct__ENetPeer.html">_ENetPeer</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="enet_8h.html#ae879b330cb0d2ade08cef4231423eaa7">ENetPeer</a></td></tr>
  108. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">An ENet peer which data packets may be sent or received from. <a href="#ae879b330cb0d2ade08cef4231423eaa7"></a><br/></td></tr>
  109. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aab39c3acb1e98a5d40a2128491db128a"></a><!-- doxytag: member="enet.h::ENetCompressor" ref="aab39c3acb1e98a5d40a2128491db128a" args="" -->
  110. typedef struct <a class="el" href="struct__ENetCompressor.html">_ENetCompressor</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="enet_8h.html#aab39c3acb1e98a5d40a2128491db128a">ENetCompressor</a></td></tr>
  111. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">An ENet packet compressor for compressing UDP packets before socket sends or receives. <br/></td></tr>
  112. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a40a0b9b0c5d219ac1a01e7da58c99ac6"></a><!-- doxytag: member="enet.h::bufferCount" ref="a40a0b9b0c5d219ac1a01e7da58c99ac6" args="" -->
  113. typedef size_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>bufferCount</b></td></tr>
  114. <tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="struct__ENetHost.html">_ENetHost</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="enet_8h.html#a258d786d5940288970898ac827bf2a68">ENetHost</a></td></tr>
  115. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">An ENet host for communicating with peers. <a href="#a258d786d5940288970898ac827bf2a68"></a><br/></td></tr>
  116. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7cf9271483e2ed25d8ecb72068222dd6"></a><!-- doxytag: member="enet.h::ENetEventType" ref="a7cf9271483e2ed25d8ecb72068222dd6" args="" -->
  117. typedef enum <a class="el" href="enet_8h.html#a3cf937b5cf72510493e0a7a2b71d3755">_ENetEventType</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="enet_8h.html#a7cf9271483e2ed25d8ecb72068222dd6">ENetEventType</a></td></tr>
  118. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">An ENet event type, as specified in <a class="el" href="enet_8h.html#a1ed78ad8f38bfa9055feab2f957718bd">ENetEvent</a>. <br/></td></tr>
  119. <tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="struct__ENetEvent.html">_ENetEvent</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="enet_8h.html#a1ed78ad8f38bfa9055feab2f957718bd">ENetEvent</a></td></tr>
  120. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">An ENet event as returned by <a class="el" href="group__host.html#ga6ba501b3ee576e5578c8e6d1694ebd49" title="Waits for events on the host specified and shuttles packets between the host and its peers...">enet_host_service()</a>. <a href="#a1ed78ad8f38bfa9055feab2f957718bd"></a><br/></td></tr>
  121. <tr><td colspan="2"><h2><a name="enum-members"></a>
  122. Enumerations</h2></td></tr>
  123. <tr><td class="memItemLeft" align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><b>_ENetSocketType</b> { <b>ENET_SOCKET_TYPE_STREAM</b> = 1,
  124. <b>ENET_SOCKET_TYPE_DATAGRAM</b> = 2
  125. }</td></tr>
  126. <tr><td class="memItemLeft" align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><b>_ENetSocketWait</b> { <b>ENET_SOCKET_WAIT_NONE</b> = 0,
  127. <b>ENET_SOCKET_WAIT_SEND</b> = (1 &lt;&lt; 0),
  128. <b>ENET_SOCKET_WAIT_RECEIVE</b> = (1 &lt;&lt; 1)
  129. }</td></tr>
  130. <tr><td class="memItemLeft" align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><b>_ENetSocketOption</b> { <br/>
  131. &nbsp;&nbsp;<b>ENET_SOCKOPT_NONBLOCK</b> = 1,
  132. <b>ENET_SOCKOPT_BROADCAST</b> = 2,
  133. <b>ENET_SOCKOPT_RCVBUF</b> = 3,
  134. <b>ENET_SOCKOPT_SNDBUF</b> = 4,
  135. <br/>
  136. &nbsp;&nbsp;<b>ENET_SOCKOPT_REUSEADDR</b> = 5
  137. <br/>
  138. }</td></tr>
  139. <tr><td class="memItemLeft" align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom">{ <a class="el" href="enet_8h.html#adf764cbdea00d65edcd07bb9953ad2b7a3d8d24eeb6e426826e88540d7c87d036">ENET_HOST_ANY</a> = 0,
  140. <a class="el" href="enet_8h.html#adf764cbdea00d65edcd07bb9953ad2b7af40f3e48e3f87859c06d62023601eb57">ENET_HOST_BROADCAST</a> = 0xFFFFFFFF,
  141. <a class="el" href="enet_8h.html#adf764cbdea00d65edcd07bb9953ad2b7a851f798e15c7f68c29a5755ac7d7cce4">ENET_PORT_ANY</a> = 0
  142. }</td></tr>
  143. <tr><td class="memItemLeft" align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="enet_8h.html#a9d1fc0ce6da0a057f18bd8b9c762003d">_ENetPacketFlag</a> { <a class="el" href="enet_8h.html#a9d1fc0ce6da0a057f18bd8b9c762003daab20e7088245ab2ddb7f11dcc9433738">ENET_PACKET_FLAG_RELIABLE</a> = (1 &lt;&lt; 0),
  144. <a class="el" href="enet_8h.html#a9d1fc0ce6da0a057f18bd8b9c762003dad230cc769ef9cc4c7c582b28f9c443fe">ENET_PACKET_FLAG_UNSEQUENCED</a> = (1 &lt;&lt; 1),
  145. <a class="el" href="enet_8h.html#a9d1fc0ce6da0a057f18bd8b9c762003daa6ce462752c36aad22e68ebefac3df8c">ENET_PACKET_FLAG_NO_ALLOCATE</a> = (1 &lt;&lt; 2)
  146. }</td></tr>
  147. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><p>Packet flag bit constants. </p>
  148. <a href="enet_8h.html#a9d1fc0ce6da0a057f18bd8b9c762003d">More...</a><br/></td></tr>
  149. <tr><td class="memItemLeft" align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><b>_ENetPeerState</b> { <br/>
  150. &nbsp;&nbsp;<b>ENET_PEER_STATE_DISCONNECTED</b> = 0,
  151. <b>ENET_PEER_STATE_CONNECTING</b> = 1,
  152. <b>ENET_PEER_STATE_ACKNOWLEDGING_CONNECT</b> = 2,
  153. <b>ENET_PEER_STATE_CONNECTION_PENDING</b> = 3,
  154. <br/>
  155. &nbsp;&nbsp;<b>ENET_PEER_STATE_CONNECTION_SUCCEEDED</b> = 4,
  156. <b>ENET_PEER_STATE_CONNECTED</b> = 5,
  157. <b>ENET_PEER_STATE_DISCONNECT_LATER</b> = 6,
  158. <b>ENET_PEER_STATE_DISCONNECTING</b> = 7,
  159. <br/>
  160. &nbsp;&nbsp;<b>ENET_PEER_STATE_ACKNOWLEDGING_DISCONNECT</b> = 8,
  161. <b>ENET_PEER_STATE_ZOMBIE</b> = 9
  162. <br/>
  163. }</td></tr>
  164. <tr><td class="memItemLeft" align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom">{ <br/>
  165. &nbsp;&nbsp;<b>ENET_HOST_RECEIVE_BUFFER_SIZE</b> = 256 * 1024,
  166. <b>ENET_HOST_SEND_BUFFER_SIZE</b> = 256 * 1024,
  167. <b>ENET_HOST_BANDWIDTH_THROTTLE_INTERVAL</b> = 1000,
  168. <b>ENET_HOST_DEFAULT_MTU</b> = 1400,
  169. <br/>
  170. &nbsp;&nbsp;<b>ENET_PEER_DEFAULT_ROUND_TRIP_TIME</b> = 500,
  171. <b>ENET_PEER_DEFAULT_PACKET_THROTTLE</b> = 32,
  172. <b>ENET_PEER_PACKET_THROTTLE_SCALE</b> = 32,
  173. <b>ENET_PEER_PACKET_THROTTLE_COUNTER</b> = 7,
  174. <br/>
  175. &nbsp;&nbsp;<b>ENET_PEER_PACKET_THROTTLE_ACCELERATION</b> = 2,
  176. <b>ENET_PEER_PACKET_THROTTLE_DECELERATION</b> = 2,
  177. <b>ENET_PEER_PACKET_THROTTLE_INTERVAL</b> = 5000,
  178. <b>ENET_PEER_PACKET_LOSS_SCALE</b> = (1 &lt;&lt; 16),
  179. <br/>
  180. &nbsp;&nbsp;<b>ENET_PEER_PACKET_LOSS_INTERVAL</b> = 10000,
  181. <b>ENET_PEER_WINDOW_SIZE_SCALE</b> = 64 * 1024,
  182. <b>ENET_PEER_TIMEOUT_LIMIT</b> = 32,
  183. <b>ENET_PEER_TIMEOUT_MINIMUM</b> = 5000,
  184. <br/>
  185. &nbsp;&nbsp;<b>ENET_PEER_TIMEOUT_MAXIMUM</b> = 30000,
  186. <b>ENET_PEER_PING_INTERVAL</b> = 500,
  187. <b>ENET_PEER_UNSEQUENCED_WINDOWS</b> = 64,
  188. <b>ENET_PEER_UNSEQUENCED_WINDOW_SIZE</b> = 1024,
  189. <br/>
  190. &nbsp;&nbsp;<b>ENET_PEER_FREE_UNSEQUENCED_WINDOWS</b> = 32,
  191. <b>ENET_PEER_RELIABLE_WINDOWS</b> = 16,
  192. <b>ENET_PEER_RELIABLE_WINDOW_SIZE</b> = 0x1000,
  193. <b>ENET_PEER_FREE_RELIABLE_WINDOWS</b> = 8
  194. <br/>
  195. }</td></tr>
  196. <tr><td class="memItemLeft" align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="enet_8h.html#a3cf937b5cf72510493e0a7a2b71d3755">_ENetEventType</a> { <a class="el" href="enet_8h.html#a3cf937b5cf72510493e0a7a2b71d3755ad76c1d9192a5c6ac60a3820e3d7379c5">ENET_EVENT_TYPE_NONE</a> = 0,
  197. <a class="el" href="enet_8h.html#a3cf937b5cf72510493e0a7a2b71d3755aefd9fa36297e41ca4c1cbcfdeb7e4a9d">ENET_EVENT_TYPE_CONNECT</a> = 1,
  198. <a class="el" href="enet_8h.html#a3cf937b5cf72510493e0a7a2b71d3755a4fa47af84cf901810510aeba077a1c2f">ENET_EVENT_TYPE_DISCONNECT</a> = 2,
  199. <a class="el" href="enet_8h.html#a3cf937b5cf72510493e0a7a2b71d3755a67d928ca38b289db53ec9f56c91c5d9d">ENET_EVENT_TYPE_RECEIVE</a> = 3
  200. }</td></tr>
  201. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><p>An ENet event type, as specified in <a class="el" href="enet_8h.html#a1ed78ad8f38bfa9055feab2f957718bd">ENetEvent</a>. </p>
  202. <a href="enet_8h.html#a3cf937b5cf72510493e0a7a2b71d3755">More...</a><br/></td></tr>
  203. <tr><td colspan="2"><h2><a name="func-members"></a>
  204. Functions</h2></td></tr>
  205. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3a2d26a32098450edee8054a39d71906"></a><!-- doxytag: member="enet.h::void" ref="a3a2d26a32098450edee8054a39d71906" args="(ENET_CALLBACK *ENetPacketFreeCallback)(struct _ENetPacket *)" -->
  206. typedef&nbsp;</td><td class="memItemRight" valign="bottom"><b>void</b> (ENET_CALLBACK *ENetPacketFreeCallback)(struct <a class="el" href="struct__ENetPacket.html">_ENetPacket</a> *)</td></tr>
  207. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8f132d373f37241ccac5dd0a360bdd28"></a><!-- doxytag: member="enet.h::enet_uint32" ref="a8f132d373f37241ccac5dd0a360bdd28" args="(ENET_CALLBACK *ENetChecksumCallback)(const ENetBuffer *buffers" -->
  208. typedef&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="enet_8h.html#a8f132d373f37241ccac5dd0a360bdd28">enet_uint32</a> (ENET_CALLBACK *ENetChecksumCallback)(const <a class="el" href="structENetBuffer.html">ENetBuffer</a> *buffers</td></tr>
  209. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Callback that computes the checksum of the data held in buffers[0:bufferCount-1]. <br/></td></tr>
  210. <tr><td class="memItemLeft" align="right" valign="top">ENET_API int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__global.html#ga67fa85c46a1dc91f968f25fc0637c897">enet_initialize</a> (void)</td></tr>
  211. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initializes ENet globally. <a href="group__global.html#ga67fa85c46a1dc91f968f25fc0637c897"></a><br/></td></tr>
  212. <tr><td class="memItemLeft" align="right" valign="top">ENET_API int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__global.html#gaef1e7849f3ddde18c6a30f32783c899d">enet_initialize_with_callbacks</a> (ENetVersion version, const <a class="el" href="struct__ENetCallbacks.html">ENetCallbacks</a> *inits)</td></tr>
  213. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initializes ENet globally and supplies user-overridden callbacks. <a href="group__global.html#gaef1e7849f3ddde18c6a30f32783c899d"></a><br/></td></tr>
  214. <tr><td class="memItemLeft" align="right" valign="top">ENET_API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__global.html#gad62cf417e08a2b98d48572a336f7db25">enet_deinitialize</a> (void)</td></tr>
  215. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Shuts down ENet globally. <a href="group__global.html#gad62cf417e08a2b98d48572a336f7db25"></a><br/></td></tr>
  216. <tr><td class="memItemLeft" align="right" valign="top">ENET_API <a class="el" href="types_8h.html#a5273659ca3c664b8550452732e9e4ae3">enet_uint32</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="enet_8h.html#a3d60275f78985d9aaba12c2fad13c37f">enet_time_get</a> (void)</td></tr>
  217. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the wall-time in milliseconds. <a href="#a3d60275f78985d9aaba12c2fad13c37f"></a><br/></td></tr>
  218. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a820cd12062e6fabcbfd3c24c4759e8ca"></a><!-- doxytag: member="enet.h::enet_time_set" ref="a820cd12062e6fabcbfd3c24c4759e8ca" args="(enet_uint32)" -->
  219. ENET_API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="enet_8h.html#a820cd12062e6fabcbfd3c24c4759e8ca">enet_time_set</a> (<a class="el" href="types_8h.html#a5273659ca3c664b8550452732e9e4ae3">enet_uint32</a>)</td></tr>
  220. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the current wall-time in milliseconds. <br/></td></tr>
  221. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga425a4420e37f3c46ced4f28091786c44"></a><!-- doxytag: member="enet.h::enet_socket_create" ref="ga425a4420e37f3c46ced4f28091786c44" args="(ENetSocketType)" -->
  222. ENET_API ENetSocket&nbsp;</td><td class="memItemRight" valign="bottom"><b>enet_socket_create</b> (ENetSocketType)</td></tr>
  223. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga1e8cc186381f15397c5523b2ff9d4cf0"></a><!-- doxytag: member="enet.h::enet_socket_bind" ref="ga1e8cc186381f15397c5523b2ff9d4cf0" args="(ENetSocket, const ENetAddress *)" -->
  224. ENET_API int&nbsp;</td><td class="memItemRight" valign="bottom"><b>enet_socket_bind</b> (ENetSocket, const <a class="el" href="struct__ENetAddress.html">ENetAddress</a> *)</td></tr>
  225. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gad1ed276acc8e120bc353815d842c6b87"></a><!-- doxytag: member="enet.h::enet_socket_listen" ref="gad1ed276acc8e120bc353815d842c6b87" args="(ENetSocket, int)" -->
  226. ENET_API int&nbsp;</td><td class="memItemRight" valign="bottom"><b>enet_socket_listen</b> (ENetSocket, int)</td></tr>
  227. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaaf0f06f15ce99ba362250d6c5768866e"></a><!-- doxytag: member="enet.h::enet_socket_accept" ref="gaaf0f06f15ce99ba362250d6c5768866e" args="(ENetSocket, ENetAddress *)" -->
  228. ENET_API ENetSocket&nbsp;</td><td class="memItemRight" valign="bottom"><b>enet_socket_accept</b> (ENetSocket, <a class="el" href="struct__ENetAddress.html">ENetAddress</a> *)</td></tr>
  229. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gac657e370f1585ce2e0f42b35f28b0d29"></a><!-- doxytag: member="enet.h::enet_socket_connect" ref="gac657e370f1585ce2e0f42b35f28b0d29" args="(ENetSocket, const ENetAddress *)" -->
  230. ENET_API int&nbsp;</td><td class="memItemRight" valign="bottom"><b>enet_socket_connect</b> (ENetSocket, const <a class="el" href="struct__ENetAddress.html">ENetAddress</a> *)</td></tr>
  231. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga7b31df6015f1f2b4850dfbf63ccc10ac"></a><!-- doxytag: member="enet.h::enet_socket_send" ref="ga7b31df6015f1f2b4850dfbf63ccc10ac" args="(ENetSocket, const ENetAddress *, const ENetBuffer *, size_t)" -->
  232. ENET_API int&nbsp;</td><td class="memItemRight" valign="bottom"><b>enet_socket_send</b> (ENetSocket, const <a class="el" href="struct__ENetAddress.html">ENetAddress</a> *, const <a class="el" href="structENetBuffer.html">ENetBuffer</a> *, size_t)</td></tr>
  233. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga119dba4de09aca16bd936953c8bc9853"></a><!-- doxytag: member="enet.h::enet_socket_receive" ref="ga119dba4de09aca16bd936953c8bc9853" args="(ENetSocket, ENetAddress *, ENetBuffer *, size_t)" -->
  234. ENET_API int&nbsp;</td><td class="memItemRight" valign="bottom"><b>enet_socket_receive</b> (ENetSocket, <a class="el" href="struct__ENetAddress.html">ENetAddress</a> *, <a class="el" href="structENetBuffer.html">ENetBuffer</a> *, size_t)</td></tr>
  235. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga06158e2adcfa90f18c9fdd13b7101231"></a><!-- doxytag: member="enet.h::enet_socket_wait" ref="ga06158e2adcfa90f18c9fdd13b7101231" args="(ENetSocket, enet_uint32 *, enet_uint32)" -->
  236. ENET_API int&nbsp;</td><td class="memItemRight" valign="bottom"><b>enet_socket_wait</b> (ENetSocket, <a class="el" href="types_8h.html#a5273659ca3c664b8550452732e9e4ae3">enet_uint32</a> *, <a class="el" href="types_8h.html#a5273659ca3c664b8550452732e9e4ae3">enet_uint32</a>)</td></tr>
  237. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga6fcb9b55e15648bd9aeed81ab9187ad7"></a><!-- doxytag: member="enet.h::enet_socket_set_option" ref="ga6fcb9b55e15648bd9aeed81ab9187ad7" args="(ENetSocket, ENetSocketOption, int)" -->
  238. ENET_API int&nbsp;</td><td class="memItemRight" valign="bottom"><b>enet_socket_set_option</b> (ENetSocket, ENetSocketOption, int)</td></tr>
  239. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga7b4933cda2967776397c23538cacadea"></a><!-- doxytag: member="enet.h::enet_socket_destroy" ref="ga7b4933cda2967776397c23538cacadea" args="(ENetSocket)" -->
  240. ENET_API void&nbsp;</td><td class="memItemRight" valign="bottom"><b>enet_socket_destroy</b> (ENetSocket)</td></tr>
  241. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga5ff9e22bd329293141a2d6c1f71279cc"></a><!-- doxytag: member="enet.h::enet_socketset_select" ref="ga5ff9e22bd329293141a2d6c1f71279cc" args="(ENetSocket, ENetSocketSet *, ENetSocketSet *, enet_uint32)" -->
  242. ENET_API int&nbsp;</td><td class="memItemRight" valign="bottom"><b>enet_socketset_select</b> (ENetSocket, ENetSocketSet *, ENetSocketSet *, <a class="el" href="types_8h.html#a5273659ca3c664b8550452732e9e4ae3">enet_uint32</a>)</td></tr>
  243. <tr><td class="memItemLeft" align="right" valign="top">ENET_API int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Address.html#ga32a6ae1ed3d7704858f237688e7384ee">enet_address_set_host</a> (<a class="el" href="struct__ENetAddress.html">ENetAddress</a> *address, const char *hostName)</td></tr>
  244. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Attempts to resolve the host named by the parameter hostName and sets the host field in the address parameter if successful. <a href="group__Address.html#ga32a6ae1ed3d7704858f237688e7384ee"></a><br/></td></tr>
  245. <tr><td class="memItemLeft" align="right" valign="top">ENET_API int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Address.html#ga770507a74d2e98334eebdadd9c681f69">enet_address_get_host_ip</a> (const <a class="el" href="struct__ENetAddress.html">ENetAddress</a> *address, char *hostName, size_t nameLength)</td></tr>
  246. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gives the printable form of the ip address specified in the address parameter. <a href="group__Address.html#ga770507a74d2e98334eebdadd9c681f69"></a><br/></td></tr>
  247. <tr><td class="memItemLeft" align="right" valign="top">ENET_API int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Address.html#ga55282b3074cb409544f6aa72a67582ab">enet_address_get_host</a> (const <a class="el" href="struct__ENetAddress.html">ENetAddress</a> *address, char *hostName, size_t nameLength)</td></tr>
  248. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Attempts to do a reverse lookup of the host field in the address parameter. <a href="group__Address.html#ga55282b3074cb409544f6aa72a67582ab"></a><br/></td></tr>
  249. <tr><td class="memItemLeft" align="right" valign="top">ENET_API <a class="el" href="struct__ENetPacket.html">ENetPacket</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Packet.html#gaac61b251aebbf9f5e5e313eca51339ea">enet_packet_create</a> (const void *, size_t, <a class="el" href="types_8h.html#a5273659ca3c664b8550452732e9e4ae3">enet_uint32</a>)</td></tr>
  250. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates a packet that may be sent to a peer. <a href="group__Packet.html#gaac61b251aebbf9f5e5e313eca51339ea"></a><br/></td></tr>
  251. <tr><td class="memItemLeft" align="right" valign="top">ENET_API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Packet.html#gab58895376ee4ade8f4e13761a44ba263">enet_packet_destroy</a> (<a class="el" href="struct__ENetPacket.html">ENetPacket</a> *)</td></tr>
  252. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destroys the packet and deallocates its data. <a href="group__Packet.html#gab58895376ee4ade8f4e13761a44ba263"></a><br/></td></tr>
  253. <tr><td class="memItemLeft" align="right" valign="top">ENET_API int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Packet.html#ga0aee7f8c7e2d2c4b64f6d68d930155a8">enet_packet_resize</a> (<a class="el" href="struct__ENetPacket.html">ENetPacket</a> *, size_t)</td></tr>
  254. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Attempts to resize the data in the packet to length specified in the dataLength parameter. <a href="group__Packet.html#ga0aee7f8c7e2d2c4b64f6d68d930155a8"></a><br/></td></tr>
  255. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga015ce0307049901852c54dd2def532e2"></a><!-- doxytag: member="enet.h::enet_crc32" ref="ga015ce0307049901852c54dd2def532e2" args="(const ENetBuffer *, size_t)" -->
  256. <a class="el" href="types_8h.html#a5273659ca3c664b8550452732e9e4ae3">enet_uint32</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>enet_crc32</b> (const <a class="el" href="structENetBuffer.html">ENetBuffer</a> *, size_t)</td></tr>
  257. <tr><td class="memItemLeft" align="right" valign="top">ENET_API <a class="el" href="struct__ENetHost.html">ENetHost</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__host.html#ga5567a95d7a45521dc9cba93a9066c940">enet_host_create</a> (const <a class="el" href="struct__ENetAddress.html">ENetAddress</a> *, size_t, size_t, <a class="el" href="types_8h.html#a5273659ca3c664b8550452732e9e4ae3">enet_uint32</a>, <a class="el" href="types_8h.html#a5273659ca3c664b8550452732e9e4ae3">enet_uint32</a>)</td></tr>
  258. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates a host for communicating to peers. <a href="group__host.html#ga5567a95d7a45521dc9cba93a9066c940"></a><br/></td></tr>
  259. <tr><td class="memItemLeft" align="right" valign="top">ENET_API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__host.html#gacec1e9a0b528c1f9ce30544d2d5b5b79">enet_host_destroy</a> (<a class="el" href="struct__ENetHost.html">ENetHost</a> *)</td></tr>
  260. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destroys the host and all resources associated with it. <a href="group__host.html#gacec1e9a0b528c1f9ce30544d2d5b5b79"></a><br/></td></tr>
  261. <tr><td class="memItemLeft" align="right" valign="top">ENET_API <a class="el" href="struct__ENetPeer.html">ENetPeer</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__host.html#ga23b3ac206326b84f42fa91673f12fca9">enet_host_connect</a> (<a class="el" href="struct__ENetHost.html">ENetHost</a> *, const <a class="el" href="struct__ENetAddress.html">ENetAddress</a> *, size_t, <a class="el" href="types_8h.html#a5273659ca3c664b8550452732e9e4ae3">enet_uint32</a>)</td></tr>
  262. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initiates a connection to a foreign host. <a href="group__host.html#ga23b3ac206326b84f42fa91673f12fca9"></a><br/></td></tr>
  263. <tr><td class="memItemLeft" align="right" valign="top">ENET_API int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__host.html#gabf2383e4a5ed864c56a50dc67b901fe9">enet_host_check_events</a> (<a class="el" href="struct__ENetHost.html">ENetHost</a> *, <a class="el" href="struct__ENetEvent.html">ENetEvent</a> *)</td></tr>
  264. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Checks for any queued events on the host and dispatches one if available. <a href="group__host.html#gabf2383e4a5ed864c56a50dc67b901fe9"></a><br/></td></tr>
  265. <tr><td class="memItemLeft" align="right" valign="top">ENET_API int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__host.html#ga6ba501b3ee576e5578c8e6d1694ebd49">enet_host_service</a> (<a class="el" href="struct__ENetHost.html">ENetHost</a> *, <a class="el" href="struct__ENetEvent.html">ENetEvent</a> *, <a class="el" href="types_8h.html#a5273659ca3c664b8550452732e9e4ae3">enet_uint32</a>)</td></tr>
  266. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Waits for events on the host specified and shuttles packets between the host and its peers. <a href="group__host.html#ga6ba501b3ee576e5578c8e6d1694ebd49"></a><br/></td></tr>
  267. <tr><td class="memItemLeft" align="right" valign="top">ENET_API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__host.html#gac8f53bcdbd540043f87e7d59048559fa">enet_host_flush</a> (<a class="el" href="struct__ENetHost.html">ENetHost</a> *)</td></tr>
  268. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sends any queued packets on the host specified to its designated peers. <a href="group__host.html#gac8f53bcdbd540043f87e7d59048559fa"></a><br/></td></tr>
  269. <tr><td class="memItemLeft" align="right" valign="top">ENET_API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__host.html#ga5190a63f78eb0c15bd96cda44bf423c6">enet_host_broadcast</a> (<a class="el" href="struct__ENetHost.html">ENetHost</a> *, <a class="el" href="types_8h.html#a34ce80c65abc6389fe0121a83d757f07">enet_uint8</a>, <a class="el" href="struct__ENetPacket.html">ENetPacket</a> *)</td></tr>
  270. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Queues a packet to be sent to all peers associated with the host. <a href="group__host.html#ga5190a63f78eb0c15bd96cda44bf423c6"></a><br/></td></tr>
  271. <tr><td class="memItemLeft" align="right" valign="top">ENET_API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__host.html#gae9e23efdfc718dedaa349891dddf529b">enet_host_compress</a> (<a class="el" href="struct__ENetHost.html">ENetHost</a> *, const <a class="el" href="struct__ENetCompressor.html">ENetCompressor</a> *)</td></tr>
  272. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the packet compressor the host should use to compress and decompress packets. <a href="group__host.html#gae9e23efdfc718dedaa349891dddf529b"></a><br/></td></tr>
  273. <tr><td class="memItemLeft" align="right" valign="top">ENET_API int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__host.html#ga444b74e7b70d97e2abd02328419be3f4">enet_host_compress_with_range_coder</a> (<a class="el" href="struct__ENetHost.html">ENetHost</a> *host)</td></tr>
  274. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the packet compressor the host should use to the default range coder. <a href="group__host.html#ga444b74e7b70d97e2abd02328419be3f4"></a><br/></td></tr>
  275. <tr><td class="memItemLeft" align="right" valign="top">ENET_API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__host.html#gaa3c04d1a1a41f46a2db274f29a8d0ffd">enet_host_channel_limit</a> (<a class="el" href="struct__ENetHost.html">ENetHost</a> *, size_t)</td></tr>
  276. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Limits the maximum allowed channels of future incoming connections. <a href="group__host.html#gaa3c04d1a1a41f46a2db274f29a8d0ffd"></a><br/></td></tr>
  277. <tr><td class="memItemLeft" align="right" valign="top">ENET_API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__host.html#ga83c5fa02a3ba6ab829856302e54929fe">enet_host_bandwidth_limit</a> (<a class="el" href="struct__ENetHost.html">ENetHost</a> *, <a class="el" href="types_8h.html#a5273659ca3c664b8550452732e9e4ae3">enet_uint32</a>, <a class="el" href="types_8h.html#a5273659ca3c664b8550452732e9e4ae3">enet_uint32</a>)</td></tr>
  278. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Adjusts the bandwidth limits of a host. <a href="group__host.html#ga83c5fa02a3ba6ab829856302e54929fe"></a><br/></td></tr>
  279. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gac76acd47fd07c27e5b85ecb63b192dd1"></a><!-- doxytag: member="enet.h::enet_host_bandwidth_throttle" ref="gac76acd47fd07c27e5b85ecb63b192dd1" args="(ENetHost *)" -->
  280. void&nbsp;</td><td class="memItemRight" valign="bottom"><b>enet_host_bandwidth_throttle</b> (<a class="el" href="struct__ENetHost.html">ENetHost</a> *)</td></tr>
  281. <tr><td class="memItemLeft" align="right" valign="top">ENET_API int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__peer.html#gaf082a0ae58d9c435bed75c7325cf7290">enet_peer_send</a> (<a class="el" href="struct__ENetPeer.html">ENetPeer</a> *, <a class="el" href="types_8h.html#a34ce80c65abc6389fe0121a83d757f07">enet_uint8</a>, <a class="el" href="struct__ENetPacket.html">ENetPacket</a> *)</td></tr>
  282. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Queues a packet to be sent. <a href="group__peer.html#gaf082a0ae58d9c435bed75c7325cf7290"></a><br/></td></tr>
  283. <tr><td class="memItemLeft" align="right" valign="top">ENET_API <a class="el" href="struct__ENetPacket.html">ENetPacket</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__peer.html#ga6493c7807f5381395305c9c48913a46c">enet_peer_receive</a> (<a class="el" href="struct__ENetPeer.html">ENetPeer</a> *, <a class="el" href="types_8h.html#a34ce80c65abc6389fe0121a83d757f07">enet_uint8</a> *channelID)</td></tr>
  284. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Attempts to dequeue any incoming queued packet. <a href="group__peer.html#ga6493c7807f5381395305c9c48913a46c"></a><br/></td></tr>
  285. <tr><td class="memItemLeft" align="right" valign="top">ENET_API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__peer.html#ga5c0708ddaf340aa42e7754a91ce456b6">enet_peer_ping</a> (<a class="el" href="struct__ENetPeer.html">ENetPeer</a> *)</td></tr>
  286. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sends a ping request to a peer. <a href="group__peer.html#ga5c0708ddaf340aa42e7754a91ce456b6"></a><br/></td></tr>
  287. <tr><td class="memItemLeft" align="right" valign="top">ENET_API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__peer.html#ga9444dfff9574a7d21dbbdd34385a7d4d">enet_peer_reset</a> (<a class="el" href="struct__ENetPeer.html">ENetPeer</a> *)</td></tr>
  288. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Forcefully disconnects a peer. <a href="group__peer.html#ga9444dfff9574a7d21dbbdd34385a7d4d"></a><br/></td></tr>
  289. <tr><td class="memItemLeft" align="right" valign="top">ENET_API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__peer.html#ga0e807704b6ecace5004c2cdcfbf813c2">enet_peer_disconnect</a> (<a class="el" href="struct__ENetPeer.html">ENetPeer</a> *, <a class="el" href="types_8h.html#a5273659ca3c664b8550452732e9e4ae3">enet_uint32</a>)</td></tr>
  290. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Request a disconnection from a peer. <a href="group__peer.html#ga0e807704b6ecace5004c2cdcfbf813c2"></a><br/></td></tr>
  291. <tr><td class="memItemLeft" align="right" valign="top">ENET_API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__peer.html#ga636cc45f52461b567d6daffe4ab8f4e9">enet_peer_disconnect_now</a> (<a class="el" href="struct__ENetPeer.html">ENetPeer</a> *, <a class="el" href="types_8h.html#a5273659ca3c664b8550452732e9e4ae3">enet_uint32</a>)</td></tr>
  292. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Force an immediate disconnection from a peer. <a href="group__peer.html#ga636cc45f52461b567d6daffe4ab8f4e9"></a><br/></td></tr>
  293. <tr><td class="memItemLeft" align="right" valign="top">ENET_API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__peer.html#ga759270d8cccec70f76274e93b49e5ac5">enet_peer_disconnect_later</a> (<a class="el" href="struct__ENetPeer.html">ENetPeer</a> *, <a class="el" href="types_8h.html#a5273659ca3c664b8550452732e9e4ae3">enet_uint32</a>)</td></tr>
  294. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Request a disconnection from a peer, but only after all queued outgoing packets are sent. <a href="group__peer.html#ga759270d8cccec70f76274e93b49e5ac5"></a><br/></td></tr>
  295. <tr><td class="memItemLeft" align="right" valign="top">ENET_API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__peer.html#gab35807c848b6c88af12ce8476dffbc84">enet_peer_throttle_configure</a> (<a class="el" href="struct__ENetPeer.html">ENetPeer</a> *, <a class="el" href="types_8h.html#a5273659ca3c664b8550452732e9e4ae3">enet_uint32</a>, <a class="el" href="types_8h.html#a5273659ca3c664b8550452732e9e4ae3">enet_uint32</a>, <a class="el" href="types_8h.html#a5273659ca3c664b8550452732e9e4ae3">enet_uint32</a>)</td></tr>
  296. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Configures throttle parameter for a peer. <a href="group__peer.html#gab35807c848b6c88af12ce8476dffbc84"></a><br/></td></tr>
  297. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga52c5c6b1bbd807466298b2d7ed12fdd6"></a><!-- doxytag: member="enet.h::enet_peer_throttle" ref="ga52c5c6b1bbd807466298b2d7ed12fdd6" args="(ENetPeer *, enet_uint32)" -->
  298. int&nbsp;</td><td class="memItemRight" valign="bottom"><b>enet_peer_throttle</b> (<a class="el" href="struct__ENetPeer.html">ENetPeer</a> *, <a class="el" href="types_8h.html#a5273659ca3c664b8550452732e9e4ae3">enet_uint32</a>)</td></tr>
  299. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga9a8da1e258f10bbef173abd598534f09"></a><!-- doxytag: member="enet.h::enet_peer_reset_queues" ref="ga9a8da1e258f10bbef173abd598534f09" args="(ENetPeer *)" -->
  300. void&nbsp;</td><td class="memItemRight" valign="bottom"><b>enet_peer_reset_queues</b> (<a class="el" href="struct__ENetPeer.html">ENetPeer</a> *)</td></tr>
  301. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga67b9b1aceaffe1efe08c9a62de2a9be6"></a><!-- doxytag: member="enet.h::enet_peer_setup_outgoing_command" ref="ga67b9b1aceaffe1efe08c9a62de2a9be6" args="(ENetPeer *, ENetOutgoingCommand *)" -->
  302. void&nbsp;</td><td class="memItemRight" valign="bottom"><b>enet_peer_setup_outgoing_command</b> (<a class="el" href="struct__ENetPeer.html">ENetPeer</a> *, <a class="el" href="struct__ENetOutgoingCommand.html">ENetOutgoingCommand</a> *)</td></tr>
  303. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga0dff073e7882de81bdf46ae8e1bc3883"></a><!-- doxytag: member="enet.h::enet_peer_queue_outgoing_command" ref="ga0dff073e7882de81bdf46ae8e1bc3883" args="(ENetPeer *, const ENetProtocol *, ENetPacket *, enet_uint32, enet_uint16)" -->
  304. <a class="el" href="struct__ENetOutgoingCommand.html">ENetOutgoingCommand</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>enet_peer_queue_outgoing_command</b> (<a class="el" href="struct__ENetPeer.html">ENetPeer</a> *, const <a class="el" href="union__ENetProtocol.html">ENetProtocol</a> *, <a class="el" href="struct__ENetPacket.html">ENetPacket</a> *, <a class="el" href="types_8h.html#a5273659ca3c664b8550452732e9e4ae3">enet_uint32</a>, <a class="el" href="types_8h.html#a245102585fdf31bdf208639ef47bec5d">enet_uint16</a>)</td></tr>
  305. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gad48f786cc1fa1b2453a1da9274c7427b"></a><!-- doxytag: member="enet.h::enet_peer_queue_incoming_command" ref="gad48f786cc1fa1b2453a1da9274c7427b" args="(ENetPeer *, const ENetProtocol *, ENetPacket *, enet_uint32)" -->
  306. <a class="el" href="struct__ENetIncomingCommand.html">ENetIncomingCommand</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>enet_peer_queue_incoming_command</b> (<a class="el" href="struct__ENetPeer.html">ENetPeer</a> *, const <a class="el" href="union__ENetProtocol.html">ENetProtocol</a> *, <a class="el" href="struct__ENetPacket.html">ENetPacket</a> *, <a class="el" href="types_8h.html#a5273659ca3c664b8550452732e9e4ae3">enet_uint32</a>)</td></tr>
  307. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga6f8ab6421d3455b7b12b14f477ea83aa"></a><!-- doxytag: member="enet.h::enet_peer_queue_acknowledgement" ref="ga6f8ab6421d3455b7b12b14f477ea83aa" args="(ENetPeer *, const ENetProtocol *, enet_uint16)" -->
  308. <a class="el" href="struct__ENetAcknowledgement.html">ENetAcknowledgement</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>enet_peer_queue_acknowledgement</b> (<a class="el" href="struct__ENetPeer.html">ENetPeer</a> *, const <a class="el" href="union__ENetProtocol.html">ENetProtocol</a> *, <a class="el" href="types_8h.html#a245102585fdf31bdf208639ef47bec5d">enet_uint16</a>)</td></tr>
  309. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga9e5635d76d32276d211d655d6570bfd5"></a><!-- doxytag: member="enet.h::enet_peer_dispatch_incoming_unreliable_commands" ref="ga9e5635d76d32276d211d655d6570bfd5" args="(ENetPeer *, ENetChannel *)" -->
  310. void&nbsp;</td><td class="memItemRight" valign="bottom"><b>enet_peer_dispatch_incoming_unreliable_commands</b> (<a class="el" href="struct__ENetPeer.html">ENetPeer</a> *, <a class="el" href="struct__ENetChannel.html">ENetChannel</a> *)</td></tr>
  311. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga8b260c7d620fa30772db1426daf15ad0"></a><!-- doxytag: member="enet.h::enet_peer_dispatch_incoming_reliable_commands" ref="ga8b260c7d620fa30772db1426daf15ad0" args="(ENetPeer *, ENetChannel *)" -->
  312. void&nbsp;</td><td class="memItemRight" valign="bottom"><b>enet_peer_dispatch_incoming_reliable_commands</b> (<a class="el" href="struct__ENetPeer.html">ENetPeer</a> *, <a class="el" href="struct__ENetChannel.html">ENetChannel</a> *)</td></tr>
  313. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac6170868084619c475060ca7ea0ed0a8"></a><!-- doxytag: member="enet.h::enet_range_coder_create" ref="ac6170868084619c475060ca7ea0ed0a8" args="(void)" -->
  314. ENET_API void *&nbsp;</td><td class="memItemRight" valign="bottom"><b>enet_range_coder_create</b> (void)</td></tr>
  315. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a49ad1b144f773181769534dac97b8c5c"></a><!-- doxytag: member="enet.h::enet_range_coder_destroy" ref="a49ad1b144f773181769534dac97b8c5c" args="(void *)" -->
  316. ENET_API void&nbsp;</td><td class="memItemRight" valign="bottom"><b>enet_range_coder_destroy</b> (void *)</td></tr>
  317. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a87a9da3b82c97b3714987bf63e91d2dc"></a><!-- doxytag: member="enet.h::enet_range_coder_compress" ref="a87a9da3b82c97b3714987bf63e91d2dc" args="(void *, const ENetBuffer *, size_t, size_t, enet_uint8 *, size_t)" -->
  318. ENET_API size_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>enet_range_coder_compress</b> (void *, const <a class="el" href="structENetBuffer.html">ENetBuffer</a> *, size_t, size_t, <a class="el" href="types_8h.html#a34ce80c65abc6389fe0121a83d757f07">enet_uint8</a> *, size_t)</td></tr>
  319. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac8df00b374e20687f232fae29aa7859e"></a><!-- doxytag: member="enet.h::enet_range_coder_decompress" ref="ac8df00b374e20687f232fae29aa7859e" args="(void *, const enet_uint8 *, size_t, enet_uint8 *, size_t)" -->
  320. ENET_API size_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>enet_range_coder_decompress</b> (void *, const <a class="el" href="types_8h.html#a34ce80c65abc6389fe0121a83d757f07">enet_uint8</a> *, size_t, <a class="el" href="types_8h.html#a34ce80c65abc6389fe0121a83d757f07">enet_uint8</a> *, size_t)</td></tr>
  321. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aea0520a5cc4fc91f40690eebbdc1ff90"></a><!-- doxytag: member="enet.h::enet_protocol_command_size" ref="aea0520a5cc4fc91f40690eebbdc1ff90" args="(enet_uint8)" -->
  322. size_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>enet_protocol_command_size</b> (<a class="el" href="types_8h.html#a34ce80c65abc6389fe0121a83d757f07">enet_uint8</a>)</td></tr>
  323. </table>
  324. <hr/><a name="_details"></a><h2>Detailed Description</h2>
  325. <hr/><h2>Typedef Documentation</h2>
  326. <a class="anchor" id="ac056c795b58ec874a9eb91259fb20198"></a><!-- doxytag: member="enet.h::ENetAddress" ref="ac056c795b58ec874a9eb91259fb20198" args="" -->
  327. <div class="memitem">
  328. <div class="memproto">
  329. <table class="memname">
  330. <tr>
  331. <td class="memname">typedef struct <a class="el" href="struct__ENetAddress.html">_ENetAddress</a> <a class="el" href="struct__ENetAddress.html">ENetAddress</a></td>
  332. </tr>
  333. </table>
  334. </div>
  335. <div class="memdoc">
  336. <p>The host must be specified in network byte-order, and the port must be in host byte-order. The constant ENET_HOST_ANY may be used to specify the default server host. The constant ENET_HOST_BROADCAST may be used to specify the broadcast address (255.255.255.255). This makes sense for enet_host_connect, but not for enet_host_create. Once a server responds to a broadcast, the address is updated from ENET_HOST_BROADCAST to the server's actual IP address. </p>
  337. </div>
  338. </div>
  339. <a class="anchor" id="a1ed78ad8f38bfa9055feab2f957718bd"></a><!-- doxytag: member="enet.h::ENetEvent" ref="a1ed78ad8f38bfa9055feab2f957718bd" args="" -->
  340. <div class="memitem">
  341. <div class="memproto">
  342. <table class="memname">
  343. <tr>
  344. <td class="memname">typedef struct <a class="el" href="struct__ENetEvent.html">_ENetEvent</a> <a class="el" href="struct__ENetEvent.html">ENetEvent</a></td>
  345. </tr>
  346. </table>
  347. </div>
  348. <div class="memdoc">
  349. <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__host.html#ga6ba501b3ee576e5578c8e6d1694ebd49" title="Waits for events on the host specified and shuttles packets between the host and its peers...">enet_host_service</a> </dd></dl>
  350. </div>
  351. </div>
  352. <a class="anchor" id="a258d786d5940288970898ac827bf2a68"></a><!-- doxytag: member="enet.h::ENetHost" ref="a258d786d5940288970898ac827bf2a68" args="" -->
  353. <div class="memitem">
  354. <div class="memproto">
  355. <table class="memname">
  356. <tr>
  357. <td class="memname">typedef struct <a class="el" href="struct__ENetHost.html">_ENetHost</a> <a class="el" href="struct__ENetHost.html">ENetHost</a></td>
  358. </tr>
  359. </table>
  360. </div>
  361. <div class="memdoc">
  362. <p>No fields should be modified unless otherwise stated.</p>
  363. <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__host.html#ga5567a95d7a45521dc9cba93a9066c940" title="Creates a host for communicating to peers.">enet_host_create()</a> </dd>
  364. <dd>
  365. <a class="el" href="group__host.html#gacec1e9a0b528c1f9ce30544d2d5b5b79" title="Destroys the host and all resources associated with it.">enet_host_destroy()</a> </dd>
  366. <dd>
  367. <a class="el" href="group__host.html#ga23b3ac206326b84f42fa91673f12fca9" title="Initiates a connection to a foreign host.">enet_host_connect()</a> </dd>
  368. <dd>
  369. <a class="el" href="group__host.html#ga6ba501b3ee576e5578c8e6d1694ebd49" title="Waits for events on the host specified and shuttles packets between the host and its peers...">enet_host_service()</a> </dd>
  370. <dd>
  371. <a class="el" href="group__host.html#gac8f53bcdbd540043f87e7d59048559fa" title="Sends any queued packets on the host specified to its designated peers.">enet_host_flush()</a> </dd>
  372. <dd>
  373. <a class="el" href="group__host.html#ga5190a63f78eb0c15bd96cda44bf423c6" title="Queues a packet to be sent to all peers associated with the host.">enet_host_broadcast()</a> </dd>
  374. <dd>
  375. <a class="el" href="group__host.html#gae9e23efdfc718dedaa349891dddf529b" title="Sets the packet compressor the host should use to compress and decompress packets.">enet_host_compress()</a> </dd>
  376. <dd>
  377. <a class="el" href="group__host.html#ga444b74e7b70d97e2abd02328419be3f4" title="Sets the packet compressor the host should use to the default range coder.">enet_host_compress_with_range_coder()</a> </dd>
  378. <dd>
  379. <a class="el" href="group__host.html#gaa3c04d1a1a41f46a2db274f29a8d0ffd" title="Limits the maximum allowed channels of future incoming connections.">enet_host_channel_limit()</a> </dd>
  380. <dd>
  381. <a class="el" href="group__host.html#ga83c5fa02a3ba6ab829856302e54929fe" title="Adjusts the bandwidth limits of a host.">enet_host_bandwidth_limit()</a> </dd>
  382. <dd>
  383. enet_host_bandwidth_throttle() </dd></dl>
  384. </div>
  385. </div>
  386. <a class="anchor" id="afc931483a08e39defe4fbac06945626c"></a><!-- doxytag: member="enet.h::ENetPacket" ref="afc931483a08e39defe4fbac06945626c" args="" -->
  387. <div class="memitem">
  388. <div class="memproto">
  389. <table class="memname">
  390. <tr>
  391. <td class="memname">typedef struct <a class="el" href="struct__ENetPacket.html">_ENetPacket</a> <a class="el" href="struct__ENetPacket.html">ENetPacket</a></td>
  392. </tr>
  393. </table>
  394. </div>
  395. <div class="memdoc">
  396. <p>An ENet data packet that may be sent to or received from a peer. The shown fields should only be read and never modified. The data field contains the allocated data for the packet. The dataLength fields specifies the length of the allocated data. The flags field is either 0 (specifying no flags), or a bitwise-or of any combination of the following flags:</p>
  397. <p>ENET_PACKET_FLAG_RELIABLE - packet must be received by the target peer and resend attempts should be made until the packet is delivered</p>
  398. <p>ENET_PACKET_FLAG_UNSEQUENCED - packet will not be sequenced with other packets (not supported for reliable packets)</p>
  399. <p>ENET_PACKET_FLAG_NO_ALLOCATE - packet will not allocate data, and user must supply it instead</p>
  400. <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="enet_8h.html#a8441ed0d3b01899c4b7c6e9c5d72aa41" title="Packet flag bit constants.">ENetPacketFlag</a> </dd></dl>
  401. </div>
  402. </div>
  403. <a class="anchor" id="a8441ed0d3b01899c4b7c6e9c5d72aa41"></a><!-- doxytag: member="enet.h::ENetPacketFlag" ref="a8441ed0d3b01899c4b7c6e9c5d72aa41" args="" -->
  404. <div class="memitem">
  405. <div class="memproto">
  406. <table class="memname">
  407. <tr>
  408. <td class="memname">typedef enum <a class="el" href="enet_8h.html#a9d1fc0ce6da0a057f18bd8b9c762003d">_ENetPacketFlag</a> <a class="el" href="enet_8h.html#a8441ed0d3b01899c4b7c6e9c5d72aa41">ENetPacketFlag</a></td>
  409. </tr>
  410. </table>
  411. </div>
  412. <div class="memdoc">
  413. <p>The host must be specified in network byte-order, and the port must be in host byte-order. The constant ENET_HOST_ANY may be used to specify the default server host.</p>
  414. <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="enet_8h.html#afc931483a08e39defe4fbac06945626c" title="ENet packet structure.">ENetPacket</a> </dd></dl>
  415. </div>
  416. </div>
  417. <a class="anchor" id="ae879b330cb0d2ade08cef4231423eaa7"></a><!-- doxytag: member="enet.h::ENetPeer" ref="ae879b330cb0d2ade08cef4231423eaa7" args="" -->
  418. <div class="memitem">
  419. <div class="memproto">
  420. <table class="memname">
  421. <tr>
  422. <td class="memname">typedef struct <a class="el" href="struct__ENetPeer.html">_ENetPeer</a> <a class="el" href="struct__ENetPeer.html">ENetPeer</a></td>
  423. </tr>
  424. </table>
  425. </div>
  426. <div class="memdoc">
  427. <p>No fields should be modified unless otherwise specified. </p>
  428. </div>
  429. </div>
  430. <hr/><h2>Enumeration Type Documentation</h2>
  431. <a class="anchor" id="adf764cbdea00d65edcd07bb9953ad2b7"></a><!-- doxytag: member="enet.h::@1" ref="adf764cbdea00d65edcd07bb9953ad2b7" args="" -->
  432. <div class="memitem">
  433. <div class="memproto">
  434. <table class="memname">
  435. <tr>
  436. <td class="memname">anonymous enum</td>
  437. </tr>
  438. </table>
  439. </div>
  440. <div class="memdoc">
  441. <dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
  442. <tr><td valign="top"><em><a class="anchor" id="adf764cbdea00d65edcd07bb9953ad2b7a3d8d24eeb6e426826e88540d7c87d036"></a><!-- doxytag: member="ENET_HOST_ANY" ref="adf764cbdea00d65edcd07bb9953ad2b7a3d8d24eeb6e426826e88540d7c87d036" args="" -->ENET_HOST_ANY</em>&nbsp;</td><td>
  443. <p>specifies the default server host </p>
  444. </td></tr>
  445. <tr><td valign="top"><em><a class="anchor" id="adf764cbdea00d65edcd07bb9953ad2b7af40f3e48e3f87859c06d62023601eb57"></a><!-- doxytag: member="ENET_HOST_BROADCAST" ref="adf764cbdea00d65edcd07bb9953ad2b7af40f3e48e3f87859c06d62023601eb57" args="" -->ENET_HOST_BROADCAST</em>&nbsp;</td><td>
  446. <p>specifies a subnet-wide broadcast </p>
  447. </td></tr>
  448. <tr><td valign="top"><em><a class="anchor" id="adf764cbdea00d65edcd07bb9953ad2b7a851f798e15c7f68c29a5755ac7d7cce4"></a><!-- doxytag: member="ENET_PORT_ANY" ref="adf764cbdea00d65edcd07bb9953ad2b7a851f798e15c7f68c29a5755ac7d7cce4" args="" -->ENET_PORT_ANY</em>&nbsp;</td><td>
  449. <p>specifies that a port should be automatically chosen </p>
  450. </td></tr>
  451. </table>
  452. </dd>
  453. </dl>
  454. </div>
  455. </div>
  456. <a class="anchor" id="a3cf937b5cf72510493e0a7a2b71d3755"></a><!-- doxytag: member="enet.h::_ENetEventType" ref="a3cf937b5cf72510493e0a7a2b71d3755" args="" -->
  457. <div class="memitem">
  458. <div class="memproto">
  459. <table class="memname">
  460. <tr>
  461. <td class="memname">enum <a class="el" href="enet_8h.html#a3cf937b5cf72510493e0a7a2b71d3755">_ENetEventType</a></td>
  462. </tr>
  463. </table>
  464. </div>
  465. <div class="memdoc">
  466. <dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
  467. <tr><td valign="top"><em><a class="anchor" id="a3cf937b5cf72510493e0a7a2b71d3755ad76c1d9192a5c6ac60a3820e3d7379c5"></a><!-- doxytag: member="ENET_EVENT_TYPE_NONE" ref="a3cf937b5cf72510493e0a7a2b71d3755ad76c1d9192a5c6ac60a3820e3d7379c5" args="" -->ENET_EVENT_TYPE_NONE</em>&nbsp;</td><td>
  468. <p>no event occurred within the specified time limit </p>
  469. </td></tr>
  470. <tr><td valign="top"><em><a class="anchor" id="a3cf937b5cf72510493e0a7a2b71d3755aefd9fa36297e41ca4c1cbcfdeb7e4a9d"></a><!-- doxytag: member="ENET_EVENT_TYPE_CONNECT" ref="a3cf937b5cf72510493e0a7a2b71d3755aefd9fa36297e41ca4c1cbcfdeb7e4a9d" args="" -->ENET_EVENT_TYPE_CONNECT</em>&nbsp;</td><td>
  471. <p>a connection request initiated by enet_host_connect has completed. </p>
  472. <p>The peer field contains the peer which successfully connected. </p>
  473. </td></tr>
  474. <tr><td valign="top"><em><a class="anchor" id="a3cf937b5cf72510493e0a7a2b71d3755a4fa47af84cf901810510aeba077a1c2f"></a><!-- doxytag: member="ENET_EVENT_TYPE_DISCONNECT" ref="a3cf937b5cf72510493e0a7a2b71d3755a4fa47af84cf901810510aeba077a1c2f" args="" -->ENET_EVENT_TYPE_DISCONNECT</em>&nbsp;</td><td>
  475. <p>a peer has disconnected. </p>
  476. <p>This event is generated on a successful completion of a disconnect initiated by enet_pper_disconnect, if a peer has timed out, or if a connection request intialized by enet_host_connect has timed out. The peer field contains the peer which disconnected. The data field contains user supplied data describing the disconnection, or 0, if none is available. </p>
  477. </td></tr>
  478. <tr><td valign="top"><em><a class="anchor" id="a3cf937b5cf72510493e0a7a2b71d3755a67d928ca38b289db53ec9f56c91c5d9d"></a><!-- doxytag: member="ENET_EVENT_TYPE_RECEIVE" ref="a3cf937b5cf72510493e0a7a2b71d3755a67d928ca38b289db53ec9f56c91c5d9d" args="" -->ENET_EVENT_TYPE_RECEIVE</em>&nbsp;</td><td>
  479. <p>a packet has been received from a peer. </p>
  480. <p>The peer field specifies the peer which sent the packet. The channelID field specifies the channel number upon which the packet was received. The packet field contains the packet that was received; this packet must be destroyed with enet_packet_destroy after use. </p>
  481. </td></tr>
  482. </table>
  483. </dd>
  484. </dl>
  485. </div>
  486. </div>
  487. <a class="anchor" id="a9d1fc0ce6da0a057f18bd8b9c762003d"></a><!-- doxytag: member="enet.h::_ENetPacketFlag" ref="a9d1fc0ce6da0a057f18bd8b9c762003d" args="" -->
  488. <div class="memitem">
  489. <div class="memproto">
  490. <table class="memname">
  491. <tr>
  492. <td class="memname">enum <a class="el" href="enet_8h.html#a9d1fc0ce6da0a057f18bd8b9c762003d">_ENetPacketFlag</a></td>
  493. </tr>
  494. </table>
  495. </div>
  496. <div class="memdoc">
  497. <p>The host must be specified in network byte-order, and the port must be in host byte-order. The constant ENET_HOST_ANY may be used to specify the default server host.</p>
  498. <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="enet_8h.html#afc931483a08e39defe4fbac06945626c" title="ENet packet structure.">ENetPacket</a> </dd></dl>
  499. <dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
  500. <tr><td valign="top"><em><a class="anchor" id="a9d1fc0ce6da0a057f18bd8b9c762003daab20e7088245ab2ddb7f11dcc9433738"></a><!-- doxytag: member="ENET_PACKET_FLAG_RELIABLE" ref="a9d1fc0ce6da0a057f18bd8b9c762003daab20e7088245ab2ddb7f11dcc9433738" args="" -->ENET_PACKET_FLAG_RELIABLE</em>&nbsp;</td><td>
  501. <p>packet must be received by the target peer and resend attempts should be made until the packet is delivered </p>
  502. </td></tr>
  503. <tr><td valign="top"><em><a class="anchor" id="a9d1fc0ce6da0a057f18bd8b9c762003dad230cc769ef9cc4c7c582b28f9c443fe"></a><!-- doxytag: member="ENET_PACKET_FLAG_UNSEQUENCED" ref="a9d1fc0ce6da0a057f18bd8b9c762003dad230cc769ef9cc4c7c582b28f9c443fe" args="" -->ENET_PACKET_FLAG_UNSEQUENCED</em>&nbsp;</td><td>
  504. <p>packet will not be sequenced with other packets not supported for reliable packets </p>
  505. </td></tr>
  506. <tr><td valign="top"><em><a class="anchor" id="a9d1fc0ce6da0a057f18bd8b9c762003daa6ce462752c36aad22e68ebefac3df8c"></a><!-- doxytag: member="ENET_PACKET_FLAG_NO_ALLOCATE" ref="a9d1fc0ce6da0a057f18bd8b9c762003daa6ce462752c36aad22e68ebefac3df8c" args="" -->ENET_PACKET_FLAG_NO_ALLOCATE</em>&nbsp;</td><td>
  507. <p>packet will not allocate data, and user must supply it instead </p>
  508. </td></tr>
  509. </table>
  510. </dd>
  511. </dl>
  512. </div>
  513. </div>
  514. <hr/><h2>Function Documentation</h2>
  515. <a class="anchor" id="a3d60275f78985d9aaba12c2fad13c37f"></a><!-- doxytag: member="enet.h::enet_time_get" ref="a3d60275f78985d9aaba12c2fad13c37f" args="(void)" -->
  516. <div class="memitem">
  517. <div class="memproto">
  518. <table class="memname">
  519. <tr>
  520. <td class="memname">ENET_API <a class="el" href="types_8h.html#a5273659ca3c664b8550452732e9e4ae3">enet_uint32</a> enet_time_get </td>
  521. <td>(</td>
  522. <td class="paramtype">void&nbsp;</td>
  523. <td class="paramname"></td>
  524. <td>&nbsp;)&nbsp;</td>
  525. <td></td>
  526. </tr>
  527. </table>
  528. </div>
  529. <div class="memdoc">
  530. <p>Its initial value is unspecified unless otherwise set. </p>
  531. <p>Referenced by <a class="el" href="group__host.html#gac8f53bcdbd540043f87e7d59048559fa">enet_host_flush()</a>, and <a class="el" href="group__host.html#ga6ba501b3ee576e5578c8e6d1694ebd49">enet_host_service()</a>.</p>
  532. </div>
  533. </div>
  534. </div>
  535. <hr class="footer"/><address class="footer"><small>Generated on Wed Feb 9 2011 21:31:05 for enet by&nbsp;
  536. <a href="http://www.doxygen.org/index.html">
  537. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
  538. </body>
  539. </html>