1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>enet: _ENetHost Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<h1>_ENetHost Struct Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="_ENetHost" -->
<p>An ENet host for communicating with peers.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="enet_8h_source.html">enet.h</a>></code></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a622ee79689ac482af56786f665288011"></a><!-- doxytag: member="_ENetHost::socket" ref="a622ee79689ac482af56786f665288011" args="" -->
ENetSocket </td><td class="memItemRight" valign="bottom"><b>socket</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="add2825b56199fbeae1c21401829bde7f"></a><!-- doxytag: member="_ENetHost::address" ref="add2825b56199fbeae1c21401829bde7f" args="" -->
<a class="el" href="struct__ENetAddress.html">ENetAddress</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetHost.html#add2825b56199fbeae1c21401829bde7f">address</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Internet address of the host. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aba842c157f1edbd616b0879c0560f018"></a><!-- doxytag: member="_ENetHost::incomingBandwidth" ref="aba842c157f1edbd616b0879c0560f018" args="" -->
<a class="el" href="types_8h.html#a5273659ca3c664b8550452732e9e4ae3">enet_uint32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetHost.html#aba842c157f1edbd616b0879c0560f018">incomingBandwidth</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">downstream bandwidth of the host <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afb9425727abfafd13dc44fec124c9834"></a><!-- doxytag: member="_ENetHost::outgoingBandwidth" ref="afb9425727abfafd13dc44fec124c9834" args="" -->
<a class="el" href="types_8h.html#a5273659ca3c664b8550452732e9e4ae3">enet_uint32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetHost.html#afb9425727abfafd13dc44fec124c9834">outgoingBandwidth</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">upstream bandwidth of the host <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a693392d522ae9825f46ae2f90bc2cd89"></a><!-- doxytag: member="_ENetHost::bandwidthThrottleEpoch" ref="a693392d522ae9825f46ae2f90bc2cd89" args="" -->
<a class="el" href="types_8h.html#a5273659ca3c664b8550452732e9e4ae3">enet_uint32</a> </td><td class="memItemRight" valign="bottom"><b>bandwidthThrottleEpoch</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a78784ad8e214b097c0e11c26dfea0c81"></a><!-- doxytag: member="_ENetHost::mtu" ref="a78784ad8e214b097c0e11c26dfea0c81" args="" -->
<a class="el" href="types_8h.html#a5273659ca3c664b8550452732e9e4ae3">enet_uint32</a> </td><td class="memItemRight" valign="bottom"><b>mtu</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad530be58071425c362355a094d012b6f"></a><!-- doxytag: member="_ENetHost::randomSeed" ref="ad530be58071425c362355a094d012b6f" args="" -->
<a class="el" href="types_8h.html#a5273659ca3c664b8550452732e9e4ae3">enet_uint32</a> </td><td class="memItemRight" valign="bottom"><b>randomSeed</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab145ff71d5a8210a17e0d6bde4e0ffac"></a><!-- doxytag: member="_ENetHost::recalculateBandwidthLimits" ref="ab145ff71d5a8210a17e0d6bde4e0ffac" args="" -->
int </td><td class="memItemRight" valign="bottom"><b>recalculateBandwidthLimits</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afe5102e5cb5df101a763806f50a20ca5"></a><!-- doxytag: member="_ENetHost::peers" ref="afe5102e5cb5df101a763806f50a20ca5" args="" -->
<a class="el" href="struct__ENetPeer.html">ENetPeer</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetHost.html#afe5102e5cb5df101a763806f50a20ca5">peers</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">array of peers allocated for this host <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a91f7d21a235270a7e81b640ca4d224e1"></a><!-- doxytag: member="_ENetHost::peerCount" ref="a91f7d21a235270a7e81b640ca4d224e1" args="" -->
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetHost.html#a91f7d21a235270a7e81b640ca4d224e1">peerCount</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">number of peers allocated for this host <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4d6a3cbb04707139fbb0b5eddfa2d0c7"></a><!-- doxytag: member="_ENetHost::channelLimit" ref="a4d6a3cbb04707139fbb0b5eddfa2d0c7" args="" -->
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetHost.html#a4d6a3cbb04707139fbb0b5eddfa2d0c7">channelLimit</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">maximum number of channels allowed for connected peers <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a73acfee7cdf444e6f49e5669470a76fc"></a><!-- doxytag: member="_ENetHost::serviceTime" ref="a73acfee7cdf444e6f49e5669470a76fc" args="" -->
<a class="el" href="types_8h.html#a5273659ca3c664b8550452732e9e4ae3">enet_uint32</a> </td><td class="memItemRight" valign="bottom"><b>serviceTime</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9074d61e251a465858cbfbec0b8a633d"></a><!-- doxytag: member="_ENetHost::dispatchQueue" ref="a9074d61e251a465858cbfbec0b8a633d" args="" -->
<a class="el" href="struct__ENetList.html">ENetList</a> </td><td class="memItemRight" valign="bottom"><b>dispatchQueue</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a20d5f51a1427c0fb12791617261233d1"></a><!-- doxytag: member="_ENetHost::continueSending" ref="a20d5f51a1427c0fb12791617261233d1" args="" -->
int </td><td class="memItemRight" valign="bottom"><b>continueSending</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a57744ff319c76eb6f0132f4a06b99818"></a><!-- doxytag: member="_ENetHost::packetSize" ref="a57744ff319c76eb6f0132f4a06b99818" args="" -->
size_t </td><td class="memItemRight" valign="bottom"><b>packetSize</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a923ef434c3f23254d5c94d1acbd16859"></a><!-- doxytag: member="_ENetHost::headerFlags" ref="a923ef434c3f23254d5c94d1acbd16859" args="" -->
<a class="el" href="types_8h.html#a245102585fdf31bdf208639ef47bec5d">enet_uint16</a> </td><td class="memItemRight" valign="bottom"><b>headerFlags</b></td></tr>
<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]" -->
<a class="el" href="union__ENetProtocol.html">ENetProtocol</a> </td><td class="memItemRight" valign="bottom"><b>commands</b> [ENET_PROTOCOL_MAXIMUM_PACKET_COMMANDS]</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac8aa71f4b8bfc6801ac3d9488d204d24"></a><!-- doxytag: member="_ENetHost::commandCount" ref="ac8aa71f4b8bfc6801ac3d9488d204d24" args="" -->
size_t </td><td class="memItemRight" valign="bottom"><b>commandCount</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7440c2d34ce9fa7db32d0e07f4fc2c65"></a><!-- doxytag: member="_ENetHost::buffers" ref="a7440c2d34ce9fa7db32d0e07f4fc2c65" args="[ENET_BUFFER_MAXIMUM]" -->
<a class="el" href="structENetBuffer.html">ENetBuffer</a> </td><td class="memItemRight" valign="bottom"><b>buffers</b> [ENET_BUFFER_MAXIMUM]</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0c57ae01770e2fd80b405647ae8db1f8"></a><!-- doxytag: member="_ENetHost::bufferCount" ref="a0c57ae01770e2fd80b405647ae8db1f8" args="" -->
size_t </td><td class="memItemRight" valign="bottom"><b>bufferCount</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8540e8bb32c1af0099791f86a06b6b69"></a><!-- doxytag: member="_ENetHost::checksum" ref="a8540e8bb32c1af0099791f86a06b6b69" args="" -->
ENetChecksumCallback </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetHost.html#a8540e8bb32c1af0099791f86a06b6b69">checksum</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">callback the user can set to enable packet checksums for this host <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a54eed34e15bb9d0d110cd0649a229c90"></a><!-- doxytag: member="_ENetHost::compressor" ref="a54eed34e15bb9d0d110cd0649a229c90" args="" -->
<a class="el" href="struct__ENetCompressor.html">ENetCompressor</a> </td><td class="memItemRight" valign="bottom"><b>compressor</b></td></tr>
<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]" -->
<a class="el" href="types_8h.html#a34ce80c65abc6389fe0121a83d757f07">enet_uint8</a> </td><td class="memItemRight" valign="bottom"><b>packetData</b> [2][ENET_PROTOCOL_MAXIMUM_MTU]</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2dff34c33a7af14a3bd9f03301473c46"></a><!-- doxytag: member="_ENetHost::receivedAddress" ref="a2dff34c33a7af14a3bd9f03301473c46" args="" -->
<a class="el" href="struct__ENetAddress.html">ENetAddress</a> </td><td class="memItemRight" valign="bottom"><b>receivedAddress</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab6fc3f15be64a2fe224a7dd13c22d870"></a><!-- doxytag: member="_ENetHost::receivedData" ref="ab6fc3f15be64a2fe224a7dd13c22d870" args="" -->
<a class="el" href="types_8h.html#a34ce80c65abc6389fe0121a83d757f07">enet_uint8</a> * </td><td class="memItemRight" valign="bottom"><b>receivedData</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afa8f1545462ceede8dd91c0a7bd538ca"></a><!-- doxytag: member="_ENetHost::receivedDataLength" ref="afa8f1545462ceede8dd91c0a7bd538ca" args="" -->
size_t </td><td class="memItemRight" valign="bottom"><b>receivedDataLength</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a689cd80fdcebebde7a23b8d90ce256ad"></a><!-- doxytag: member="_ENetHost::totalSentData" ref="a689cd80fdcebebde7a23b8d90ce256ad" args="" -->
<a class="el" href="types_8h.html#a5273659ca3c664b8550452732e9e4ae3">enet_uint32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetHost.html#a689cd80fdcebebde7a23b8d90ce256ad">totalSentData</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">total data sent, user should reset to 0 as needed to prevent overflow <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a091427500ee4ef3e334391d946c3fd4e"></a><!-- doxytag: member="_ENetHost::totalSentPackets" ref="a091427500ee4ef3e334391d946c3fd4e" args="" -->
<a class="el" href="types_8h.html#a5273659ca3c664b8550452732e9e4ae3">enet_uint32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetHost.html#a091427500ee4ef3e334391d946c3fd4e">totalSentPackets</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">total UDP packets sent, user should reset to 0 as needed to prevent overflow <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2f64a35db39c2d63faac1307cda04e72"></a><!-- doxytag: member="_ENetHost::totalReceivedData" ref="a2f64a35db39c2d63faac1307cda04e72" args="" -->
<a class="el" href="types_8h.html#a5273659ca3c664b8550452732e9e4ae3">enet_uint32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetHost.html#a2f64a35db39c2d63faac1307cda04e72">totalReceivedData</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">total data received, user should reset to 0 as needed to prevent overflow <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af3dbafc09cdc17fc4e931eb2eb0c5680"></a><!-- doxytag: member="_ENetHost::totalReceivedPackets" ref="af3dbafc09cdc17fc4e931eb2eb0c5680" args="" -->
<a class="el" href="types_8h.html#a5273659ca3c664b8550452732e9e4ae3">enet_uint32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetHost.html#af3dbafc09cdc17fc4e931eb2eb0c5680">totalReceivedPackets</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">total UDP packets received, user should reset to 0 as needed to prevent overflow <br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>No fields should be modified unless otherwise stated.</p>
<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>
<dd>
<a class="el" href="group__host.html#gacec1e9a0b528c1f9ce30544d2d5b5b79" title="Destroys the host and all resources associated with it.">enet_host_destroy()</a> </dd>
<dd>
<a class="el" href="group__host.html#ga23b3ac206326b84f42fa91673f12fca9" title="Initiates a connection to a foreign host.">enet_host_connect()</a> </dd>
<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>
<dd>
<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>
<dd>
<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>
<dd>
<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>
<dd>
<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>
<dd>
<a class="el" href="group__host.html#gaa3c04d1a1a41f46a2db274f29a8d0ffd" title="Limits the maximum allowed channels of future incoming connections.">enet_host_channel_limit()</a> </dd>
<dd>
<a class="el" href="group__host.html#ga83c5fa02a3ba6ab829856302e54929fe" title="Adjusts the bandwidth limits of a host.">enet_host_bandwidth_limit()</a> </dd>
<dd>
enet_host_bandwidth_throttle() </dd></dl>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="enet_8h_source.html">enet.h</a></li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Tue May 31 2011 03:26:47 for enet by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
</html>
|
