/src/middleware/enet/docs/struct__ENetHost.html

https://bitbucket.org/vivkin/gam3b00bs/ · HTML · 147 lines · 144 code · 1 blank · 2 comment · 0 complexity · 4733ba99770a71282a2fde1ebc68bc98 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: _ENetHost Struct 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 class="current"><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
    18. 

  18.       <li><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="annotated.html"><span>Data&nbsp;Structures</span></a></li>
    24. 

  24.       <li><a href="classes.html"><span>Data&nbsp;Structure&nbsp;Index</span></a></li>
    25. 

  25.       <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
    26. 

  26.     </ul>
    27. 

  27.   </div>
    28. 

  28. </div>
    29. 

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

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

  31. <a href="#pub-attribs">Data Fields</a>  </div>
    32. 

  32.   <div class="headertitle">
    33. 

  33. <h1>_ENetHost Struct Reference</h1>  </div>
    34. 

  34. </div>
    35. 

  35. <div class="contents">
    36. 

  36. <!-- doxytag: class="_ENetHost" -->
    37. 

  37. <p>An ENet host for communicating with peers.  
    38. 

  38. <a href="#_details">More...</a></p>
    39. 

  39. 

  40. <p><code>#include &lt;<a class="el" href="enet_8h_source.html">enet.h</a>&gt;</code></p>
    41. 

  41. <table class="memberdecls">
    42. 

  42. <tr><td colspan="2"><h2><a name="pub-attribs"></a>
    43. 

  43. Data Fields</h2></td></tr>
    44. 

  44. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a622ee79689ac482af56786f665288011"></a><!-- doxytag: member="_ENetHost::socket" ref="a622ee79689ac482af56786f665288011" args="" -->
    45. 

  45. ENetSocket&nbsp;</td><td class="memItemRight" valign="bottom"><b>socket</b></td></tr>
    46. 

  46. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="add2825b56199fbeae1c21401829bde7f"></a><!-- doxytag: member="_ENetHost::address" ref="add2825b56199fbeae1c21401829bde7f" args="" -->
    47. 

  47. <a class="el" href="struct__ENetAddress.html">ENetAddress</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetHost.html#add2825b56199fbeae1c21401829bde7f">address</a></td></tr>
    48. 

  48. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Internet address of the host. <br/></td></tr>
    49. 

  49. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aba842c157f1edbd616b0879c0560f018"></a><!-- doxytag: member="_ENetHost::incomingBandwidth" ref="aba842c157f1edbd616b0879c0560f018" args="" -->
    50. 

  50. <a class="el" href="types_8h.html#a5273659ca3c664b8550452732e9e4ae3">enet_uint32</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetHost.html#aba842c157f1edbd616b0879c0560f018">incomingBandwidth</a></td></tr>
    51. 

  51. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">downstream bandwidth of the host <br/></td></tr>
    52. 

  52. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afb9425727abfafd13dc44fec124c9834"></a><!-- doxytag: member="_ENetHost::outgoingBandwidth" ref="afb9425727abfafd13dc44fec124c9834" args="" -->
    53. 

  53. <a class="el" href="types_8h.html#a5273659ca3c664b8550452732e9e4ae3">enet_uint32</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetHost.html#afb9425727abfafd13dc44fec124c9834">outgoingBandwidth</a></td></tr>
    54. 

  54. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">upstream bandwidth of the host <br/></td></tr>
    55. 

  55. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a693392d522ae9825f46ae2f90bc2cd89"></a><!-- doxytag: member="_ENetHost::bandwidthThrottleEpoch" ref="a693392d522ae9825f46ae2f90bc2cd89" args="" -->
    56. 

  56. <a class="el" href="types_8h.html#a5273659ca3c664b8550452732e9e4ae3">enet_uint32</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>bandwidthThrottleEpoch</b></td></tr>
    57. 

  57. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a78784ad8e214b097c0e11c26dfea0c81"></a><!-- doxytag: member="_ENetHost::mtu" ref="a78784ad8e214b097c0e11c26dfea0c81" args="" -->
    58. 

  58. <a class="el" href="types_8h.html#a5273659ca3c664b8550452732e9e4ae3">enet_uint32</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>mtu</b></td></tr>
    59. 

  59. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad530be58071425c362355a094d012b6f"></a><!-- doxytag: member="_ENetHost::randomSeed" ref="ad530be58071425c362355a094d012b6f" args="" -->
    60. 

  60. <a class="el" href="types_8h.html#a5273659ca3c664b8550452732e9e4ae3">enet_uint32</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>randomSeed</b></td></tr>
    61. 

  61. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab145ff71d5a8210a17e0d6bde4e0ffac"></a><!-- doxytag: member="_ENetHost::recalculateBandwidthLimits" ref="ab145ff71d5a8210a17e0d6bde4e0ffac" args="" -->
    62. 

  62. int&nbsp;</td><td class="memItemRight" valign="bottom"><b>recalculateBandwidthLimits</b></td></tr>
    63. 

  63. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afe5102e5cb5df101a763806f50a20ca5"></a><!-- doxytag: member="_ENetHost::peers" ref="afe5102e5cb5df101a763806f50a20ca5" args="" -->
    64. 

  64. <a class="el" href="struct__ENetPeer.html">ENetPeer</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetHost.html#afe5102e5cb5df101a763806f50a20ca5">peers</a></td></tr>
    65. 

  65. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">array of peers allocated for this host <br/></td></tr>
    66. 

  66. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a91f7d21a235270a7e81b640ca4d224e1"></a><!-- doxytag: member="_ENetHost::peerCount" ref="a91f7d21a235270a7e81b640ca4d224e1" args="" -->
    67. 

  67. size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetHost.html#a91f7d21a235270a7e81b640ca4d224e1">peerCount</a></td></tr>
    68. 

  68. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">number of peers allocated for this host <br/></td></tr>
    69. 

  69. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4d6a3cbb04707139fbb0b5eddfa2d0c7"></a><!-- doxytag: member="_ENetHost::channelLimit" ref="a4d6a3cbb04707139fbb0b5eddfa2d0c7" args="" -->
    70. 

  70. size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetHost.html#a4d6a3cbb04707139fbb0b5eddfa2d0c7">channelLimit</a></td></tr>
    71. 

  71. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">maximum number of channels allowed for connected peers <br/></td></tr>
    72. 

  72. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a73acfee7cdf444e6f49e5669470a76fc"></a><!-- doxytag: member="_ENetHost::serviceTime" ref="a73acfee7cdf444e6f49e5669470a76fc" args="" -->
    73. 

  73. <a class="el" href="types_8h.html#a5273659ca3c664b8550452732e9e4ae3">enet_uint32</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>serviceTime</b></td></tr>
    74. 

  74. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9074d61e251a465858cbfbec0b8a633d"></a><!-- doxytag: member="_ENetHost::dispatchQueue" ref="a9074d61e251a465858cbfbec0b8a633d" args="" -->
    75. 

  75. <a class="el" href="struct__ENetList.html">ENetList</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>dispatchQueue</b></td></tr>
    76. 

  76. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a20d5f51a1427c0fb12791617261233d1"></a><!-- doxytag: member="_ENetHost::continueSending" ref="a20d5f51a1427c0fb12791617261233d1" args="" -->
    77. 

  77. int&nbsp;</td><td class="memItemRight" valign="bottom"><b>continueSending</b></td></tr>
    78. 

  78. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a57744ff319c76eb6f0132f4a06b99818"></a><!-- doxytag: member="_ENetHost::packetSize" ref="a57744ff319c76eb6f0132f4a06b99818" args="" -->
    79. 

  79. size_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>packetSize</b></td></tr>
    80. 

  80. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a923ef434c3f23254d5c94d1acbd16859"></a><!-- doxytag: member="_ENetHost::headerFlags" ref="a923ef434c3f23254d5c94d1acbd16859" args="" -->
    81. 

  81. <a class="el" href="types_8h.html#a245102585fdf31bdf208639ef47bec5d">enet_uint16</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>headerFlags</b></td></tr>
    82. 

  82. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a668f2c3c1c66a29dcfffb5ea982ceca5"></a><!-- doxytag: member="_ENetHost::commands" ref="a668f2c3c1c66a29dcfffb5ea982ceca5" args="[ENET_PROTOCOL_MAXIMUM_PACKET_COMMANDS]" -->
    83. 

  83. <a class="el" href="union__ENetProtocol.html">ENetProtocol</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>commands</b> [ENET_PROTOCOL_MAXIMUM_PACKET_COMMANDS]</td></tr>
    84. 

  84. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac8aa71f4b8bfc6801ac3d9488d204d24"></a><!-- doxytag: member="_ENetHost::commandCount" ref="ac8aa71f4b8bfc6801ac3d9488d204d24" args="" -->
    85. 

  85. size_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>commandCount</b></td></tr>
    86. 

  86. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7440c2d34ce9fa7db32d0e07f4fc2c65"></a><!-- doxytag: member="_ENetHost::buffers" ref="a7440c2d34ce9fa7db32d0e07f4fc2c65" args="[ENET_BUFFER_MAXIMUM]" -->
    87. 

  87. <a class="el" href="structENetBuffer.html">ENetBuffer</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>buffers</b> [ENET_BUFFER_MAXIMUM]</td></tr>
    88. 

  88. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0c57ae01770e2fd80b405647ae8db1f8"></a><!-- doxytag: member="_ENetHost::bufferCount" ref="a0c57ae01770e2fd80b405647ae8db1f8" args="" -->
    89. 

  89. size_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>bufferCount</b></td></tr>
    90. 

  90. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8540e8bb32c1af0099791f86a06b6b69"></a><!-- doxytag: member="_ENetHost::checksum" ref="a8540e8bb32c1af0099791f86a06b6b69" args="" -->
    91. 

  91. ENetChecksumCallback&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetHost.html#a8540e8bb32c1af0099791f86a06b6b69">checksum</a></td></tr>
    92. 

  92. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">callback the user can set to enable packet checksums for this host <br/></td></tr>
    93. 

  93. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a54eed34e15bb9d0d110cd0649a229c90"></a><!-- doxytag: member="_ENetHost::compressor" ref="a54eed34e15bb9d0d110cd0649a229c90" args="" -->
    94. 

  94. <a class="el" href="struct__ENetCompressor.html">ENetCompressor</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>compressor</b></td></tr>
    95. 

  95. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ada16be25058f0410d15bbd6c1156735d"></a><!-- doxytag: member="_ENetHost::packetData" ref="ada16be25058f0410d15bbd6c1156735d" args="[2][ENET_PROTOCOL_MAXIMUM_MTU]" -->
    96. 

  96. <a class="el" href="types_8h.html#a34ce80c65abc6389fe0121a83d757f07">enet_uint8</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>packetData</b> [2][ENET_PROTOCOL_MAXIMUM_MTU]</td></tr>
    97. 

  97. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2dff34c33a7af14a3bd9f03301473c46"></a><!-- doxytag: member="_ENetHost::receivedAddress" ref="a2dff34c33a7af14a3bd9f03301473c46" args="" -->
    98. 

  98. <a class="el" href="struct__ENetAddress.html">ENetAddress</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>receivedAddress</b></td></tr>
    99. 

  99. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab6fc3f15be64a2fe224a7dd13c22d870"></a><!-- doxytag: member="_ENetHost::receivedData" ref="ab6fc3f15be64a2fe224a7dd13c22d870" args="" -->
    100. 

  100. <a class="el" href="types_8h.html#a34ce80c65abc6389fe0121a83d757f07">enet_uint8</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>receivedData</b></td></tr>
    101. 

  101. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afa8f1545462ceede8dd91c0a7bd538ca"></a><!-- doxytag: member="_ENetHost::receivedDataLength" ref="afa8f1545462ceede8dd91c0a7bd538ca" args="" -->
    102. 

  102. size_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>receivedDataLength</b></td></tr>
    103. 

  103. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a689cd80fdcebebde7a23b8d90ce256ad"></a><!-- doxytag: member="_ENetHost::totalSentData" ref="a689cd80fdcebebde7a23b8d90ce256ad" args="" -->
    104. 

  104. <a class="el" href="types_8h.html#a5273659ca3c664b8550452732e9e4ae3">enet_uint32</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetHost.html#a689cd80fdcebebde7a23b8d90ce256ad">totalSentData</a></td></tr>
    105. 

  105. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">total data sent, user should reset to 0 as needed to prevent overflow <br/></td></tr>
    106. 

  106. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a091427500ee4ef3e334391d946c3fd4e"></a><!-- doxytag: member="_ENetHost::totalSentPackets" ref="a091427500ee4ef3e334391d946c3fd4e" args="" -->
    107. 

  107. <a class="el" href="types_8h.html#a5273659ca3c664b8550452732e9e4ae3">enet_uint32</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetHost.html#a091427500ee4ef3e334391d946c3fd4e">totalSentPackets</a></td></tr>
    108. 

  108. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">total UDP packets sent, user should reset to 0 as needed to prevent overflow <br/></td></tr>
    109. 

  109. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2f64a35db39c2d63faac1307cda04e72"></a><!-- doxytag: member="_ENetHost::totalReceivedData" ref="a2f64a35db39c2d63faac1307cda04e72" args="" -->
    110. 

  110. <a class="el" href="types_8h.html#a5273659ca3c664b8550452732e9e4ae3">enet_uint32</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetHost.html#a2f64a35db39c2d63faac1307cda04e72">totalReceivedData</a></td></tr>
    111. 

  111. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">total data received, user should reset to 0 as needed to prevent overflow <br/></td></tr>
    112. 

  112. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af3dbafc09cdc17fc4e931eb2eb0c5680"></a><!-- doxytag: member="_ENetHost::totalReceivedPackets" ref="af3dbafc09cdc17fc4e931eb2eb0c5680" args="" -->
    113. 

  113. <a class="el" href="types_8h.html#a5273659ca3c664b8550452732e9e4ae3">enet_uint32</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetHost.html#af3dbafc09cdc17fc4e931eb2eb0c5680">totalReceivedPackets</a></td></tr>
    114. 

  114. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">total UDP packets received, user should reset to 0 as needed to prevent overflow <br/></td></tr>
    115. 

  115. </table>
    116. 

  116. <hr/><a name="_details"></a><h2>Detailed Description</h2>
    117. 

  117. <p>No fields should be modified unless otherwise stated.</p>
    118. 

  118. <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>
    119. 

  119. <dd>
    120. 

  120. <a class="el" href="group__host.html#gacec1e9a0b528c1f9ce30544d2d5b5b79" title="Destroys the host and all resources associated with it.">enet_host_destroy()</a> </dd>
    121. 

  121. <dd>
    122. 

  122. <a class="el" href="group__host.html#ga23b3ac206326b84f42fa91673f12fca9" title="Initiates a connection to a foreign host.">enet_host_connect()</a> </dd>
    123. 

  123. <dd>
    124. 

  124. <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>
    125. 

  125. <dd>
    126. 

  126. <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>
    127. 

  127. <dd>
    128. 

  128. <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>
    129. 

  129. <dd>
    130. 

  130. <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>
    131. 

  131. <dd>
    132. 

  132. <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>
    133. 

  133. <dd>
    134. 

  134. <a class="el" href="group__host.html#gaa3c04d1a1a41f46a2db274f29a8d0ffd" title="Limits the maximum allowed channels of future incoming connections.">enet_host_channel_limit()</a> </dd>
    135. 

  135. <dd>
    136. 

  136. <a class="el" href="group__host.html#ga83c5fa02a3ba6ab829856302e54929fe" title="Adjusts the bandwidth limits of a host.">enet_host_bandwidth_limit()</a> </dd>
    137. 

  137. <dd>
    138. 

  138. enet_host_bandwidth_throttle() </dd></dl>
    139. 

  139. <hr/>The documentation for this struct was generated from the following file:<ul>
    140. 

  140. <li><a class="el" href="enet_8h_source.html">enet.h</a></li>
    141. 

  141. </ul>
    142. 

  142. </div>
    143. 

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

  144. <a href="http://www.doxygen.org/index.html">
    145. 

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

  146. </body>
    147. 

  147. </html>
    148.