Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: downloads/enet-1.1/docs/html/enet_8h.html @ 13

Last change on this file since 13 was 13, checked in by landauf, 16 years ago

added enet
File size: 47.0 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3<title>enet: enet.h File Reference</title>
4<link href="doxygen.css" rel="stylesheet" type="text/css">
5<link href="tabs.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.5.1 -->
8<div class="tabs">
9  <ul>
10    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
11    <li><a href="modules.html"><span>Modules</span></a></li>
12    <li><a href="classes.html"><span>Data&nbsp;Structures</span></a></li>
13    <li id="current"><a href="files.html"><span>Files</span></a></li>
14    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
15  </ul></div>
16<div class="tabs">
17  <ul>
18    <li><a href="files.html"><span>File&nbsp;List</span></a></li>
19    <li><a href="globals.html"><span>Globals</span></a></li>
20  </ul></div>
21<h1>enet.h File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
22
23<p>
24<code>#include &lt;stdlib.h&gt;</code><br>
25<code>#include &quot;<a class="el" href="unix_8h-source.html">enet/unix.h</a>&quot;</code><br>
26<code>#include &quot;<a class="el" href="types_8h-source.html">enet/types.h</a>&quot;</code><br>
27<code>#include &quot;<a class="el" href="protocol_8h-source.html">enet/protocol.h</a>&quot;</code><br>
28<code>#include &quot;<a class="el" href="list_8h-source.html">enet/list.h</a>&quot;</code><br>
29<code>#include &quot;<a class="el" href="callbacks_8h-source.html">enet/callbacks.h</a>&quot;</code><br>
30
31<p>
32<a href="enet_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
33<tr><td></td></tr>
34<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr>
35<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetAddress.html">_ENetAddress</a></td></tr>
36
37<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Portable internet address structure.  <a href="struct__ENetAddress.html#_details">More...</a><br></td></tr>
38<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetPacket.html">_ENetPacket</a></td></tr>
39
40<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">ENet packet structure.  <a href="struct__ENetPacket.html#_details">More...</a><br></td></tr>
41<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><b>_ENetAcknowledgement</b></td></tr>
42
43<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><b>_ENetOutgoingCommand</b></td></tr>
44
45<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><b>_ENetIncomingCommand</b></td></tr>
46
47<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><b>_ENetChannel</b></td></tr>
48
49<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetPeer.html">_ENetPeer</a></td></tr>
50
51<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>
52<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetHost.html">_ENetHost</a></td></tr>
53
54<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>
55<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetEvent.html">_ENetEvent</a></td></tr>
56
57<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">An ENet event as returned by <a class="el" href="group__host.html#g6ba501b3ee576e5578c8e6d1694ebd49">enet_host_service()</a>.  <a href="struct__ENetEvent.html#_details">More...</a><br></td></tr>
58<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
59<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4e71003e6043d745c1d69d0b35a76c1d"></a><!-- doxytag: member="enet.h::ENET_BUFFER_MAXIMUM" ref="4e71003e6043d745c1d69d0b35a76c1d" args="" -->
60#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>
61
62<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
63<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="struct__ENetAddress.html">_ENetAddress</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="enet_8h.html#c056c795b58ec874a9eb91259fb20198">ENetAddress</a></td></tr>
64
65<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Portable internet address structure.  <a href="#c056c795b58ec874a9eb91259fb20198"></a><br></td></tr>
66<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="struct__ENetPacket.html">_ENetPacket</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="enet_8h.html#fc931483a08e39defe4fbac06945626c">ENetPacket</a></td></tr>
67
68<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">ENet packet structure.  <a href="#fc931483a08e39defe4fbac06945626c"></a><br></td></tr>
69<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c28ad4a7aa8411543d22746e97477565"></a><!-- doxytag: member="enet.h::ENetAcknowledgement" ref="c28ad4a7aa8411543d22746e97477565" args="" -->
70typedef _ENetAcknowledgement&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetAcknowledgement</b></td></tr>
71
72<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="809548e645fd0008b76381d2b1b879bb"></a><!-- doxytag: member="enet.h::ENetOutgoingCommand" ref="809548e645fd0008b76381d2b1b879bb" args="" -->
73typedef _ENetOutgoingCommand&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetOutgoingCommand</b></td></tr>
74
75<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d60d5b8d20e536abc78f6009592b4008"></a><!-- doxytag: member="enet.h::ENetIncomingCommand" ref="d60d5b8d20e536abc78f6009592b4008" args="" -->
76typedef _ENetIncomingCommand&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetIncomingCommand</b></td></tr>
77
78<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9fccff454cb933c4a26ea1e4a8995b74"></a><!-- doxytag: member="enet.h::ENetChannel" ref="9fccff454cb933c4a26ea1e4a8995b74" args="" -->
79typedef _ENetChannel&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetChannel</b></td></tr>
80
81<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="struct__ENetPeer.html">_ENetPeer</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="enet_8h.html#e879b330cb0d2ade08cef4231423eaa7">ENetPeer</a></td></tr>
82
83<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">An ENet peer which data packets may be sent or received from.  <a href="#e879b330cb0d2ade08cef4231423eaa7"></a><br></td></tr>
84<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="struct__ENetHost.html">_ENetHost</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="enet_8h.html#258d786d5940288970898ac827bf2a68">ENetHost</a></td></tr>
85
86<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">An ENet host for communicating with peers.  <a href="#258d786d5940288970898ac827bf2a68"></a><br></td></tr>
87<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="struct__ENetEvent.html">_ENetEvent</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="enet_8h.html#1ed78ad8f38bfa9055feab2f957718bd">ENetEvent</a></td></tr>
88
89<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">An ENet event as returned by <a class="el" href="group__host.html#g6ba501b3ee576e5578c8e6d1694ebd49">enet_host_service()</a>.  <a href="#1ed78ad8f38bfa9055feab2f957718bd"></a><br></td></tr>
90<tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
91<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetVersion</b> { <b>ENET_VERSION</b> =  1
92 }</td></tr>
93
94<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetSocketType</b> { <b>ENET_SOCKET_TYPE_STREAM</b> =  1,
95<b>ENET_SOCKET_TYPE_DATAGRAM</b> =  2
96 }</td></tr>
97
98<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetSocketWait</b> { <b>ENET_SOCKET_WAIT_NONE</b> =  0,
99<b>ENET_SOCKET_WAIT_SEND</b> =  (1 &lt;&lt; 0),
100<b>ENET_SOCKET_WAIT_RECEIVE</b> =  (1 &lt;&lt; 1)
101 }</td></tr>
102
103<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom">{ <a class="el" href="enet_8h.html#06fc87d81c62e9abb8790b6e5713c55b3d8d24eeb6e426826e88540d7c87d036">ENET_HOST_ANY</a> =  0,
104<a class="el" href="enet_8h.html#06fc87d81c62e9abb8790b6e5713c55bf40f3e48e3f87859c06d62023601eb57">ENET_HOST_BROADCAST</a> =  0xFFFFFFFF,
105<a class="el" href="enet_8h.html#06fc87d81c62e9abb8790b6e5713c55b851f798e15c7f68c29a5755ac7d7cce4">ENET_PORT_ANY</a> =  0
106 }</td></tr>
107
108<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="enet_8h.html#38c59a481ed607b07d63b7bc3e88ca98">ENetPacketFlag</a> { <a class="el" href="enet_8h.html#38c59a481ed607b07d63b7bc3e88ca98ab20e7088245ab2ddb7f11dcc9433738">ENET_PACKET_FLAG_RELIABLE</a> =  (1 &lt;&lt; 0),
109<a class="el" href="enet_8h.html#38c59a481ed607b07d63b7bc3e88ca98d230cc769ef9cc4c7c582b28f9c443fe">ENET_PACKET_FLAG_UNSEQUENCED</a> =  (1 &lt;&lt; 1),
110<a class="el" href="enet_8h.html#38c59a481ed607b07d63b7bc3e88ca98a6ce462752c36aad22e68ebefac3df8c">ENET_PACKET_FLAG_NO_ALLOCATE</a> =  (1 &lt;&lt; 2)
111 }</td></tr>
112
113<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Packet flag bit constants.  <a href="enet_8h.html#38c59a481ed607b07d63b7bc3e88ca98">More...</a><br></td></tr>
114<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetPeerState</b> { <br>
115&nbsp;&nbsp;<b>ENET_PEER_STATE_DISCONNECTED</b> =  0,
116<b>ENET_PEER_STATE_CONNECTING</b> =  1,
117<b>ENET_PEER_STATE_ACKNOWLEDGING_CONNECT</b> =  2,
118<b>ENET_PEER_STATE_CONNECTION_PENDING</b> =  3,
119<br>
120&nbsp;&nbsp;<b>ENET_PEER_STATE_CONNECTION_SUCCEEDED</b> =  4,
121<b>ENET_PEER_STATE_CONNECTED</b> =  5,
122<b>ENET_PEER_STATE_DISCONNECT_LATER</b> =  6,
123<b>ENET_PEER_STATE_DISCONNECTING</b> =  7,
124<br>
125&nbsp;&nbsp;<b>ENET_PEER_STATE_ACKNOWLEDGING_DISCONNECT</b> =  8,
126<b>ENET_PEER_STATE_ZOMBIE</b> =  9
127<br>
128 }</td></tr>
129
130<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom">{ <br>
131&nbsp;&nbsp;<b>ENET_HOST_RECEIVE_BUFFER_SIZE</b> =  256 * 1024,
132<b>ENET_HOST_SEND_BUFFER_SIZE</b> =  256 * 1024,
133<b>ENET_HOST_BANDWIDTH_THROTTLE_INTERVAL</b> =  1000,
134<b>ENET_HOST_DEFAULT_MTU</b> =  1400,
135<br>
136&nbsp;&nbsp;<b>ENET_PEER_DEFAULT_ROUND_TRIP_TIME</b> =  500,
137<b>ENET_PEER_DEFAULT_PACKET_THROTTLE</b> =  32,
138<b>ENET_PEER_PACKET_THROTTLE_SCALE</b> =  32,
139<b>ENET_PEER_PACKET_THROTTLE_COUNTER</b> =  7,
140<br>
141&nbsp;&nbsp;<b>ENET_PEER_PACKET_THROTTLE_ACCELERATION</b> =  2,
142<b>ENET_PEER_PACKET_THROTTLE_DECELERATION</b> =  2,
143<b>ENET_PEER_PACKET_THROTTLE_INTERVAL</b> =  5000,
144<b>ENET_PEER_PACKET_LOSS_SCALE</b> =  (1 &lt;&lt; 16),
145<br>
146&nbsp;&nbsp;<b>ENET_PEER_PACKET_LOSS_INTERVAL</b> =  10000,
147<b>ENET_PEER_WINDOW_SIZE_SCALE</b> =  64 * 1024,
148<b>ENET_PEER_TIMEOUT_LIMIT</b> =  32,
149<b>ENET_PEER_TIMEOUT_MINIMUM</b> =  5000,
150<br>
151&nbsp;&nbsp;<b>ENET_PEER_TIMEOUT_MAXIMUM</b> =  30000,
152<b>ENET_PEER_PING_INTERVAL</b> =  500,
153<b>ENET_PEER_UNSEQUENCED_WINDOW_SIZE</b> =  4 * 32
154<br>
155 }</td></tr>
156
157<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="enet_8h.html#dc5336f0698d4336b587f083d89df414">ENetEventType</a> { <a class="el" href="enet_8h.html#dc5336f0698d4336b587f083d89df414d76c1d9192a5c6ac60a3820e3d7379c5">ENET_EVENT_TYPE_NONE</a> =  0,
158<a class="el" href="enet_8h.html#dc5336f0698d4336b587f083d89df414efd9fa36297e41ca4c1cbcfdeb7e4a9d">ENET_EVENT_TYPE_CONNECT</a> =  1,
159<a class="el" href="enet_8h.html#dc5336f0698d4336b587f083d89df4144fa47af84cf901810510aeba077a1c2f">ENET_EVENT_TYPE_DISCONNECT</a> =  2,
160<a class="el" href="enet_8h.html#dc5336f0698d4336b587f083d89df41467d928ca38b289db53ec9f56c91c5d9d">ENET_EVENT_TYPE_RECEIVE</a> =  3
161 }</td></tr>
162
163<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">An ENet event type, as specified in <a class="el" href="enet_8h.html#1ed78ad8f38bfa9055feab2f957718bd">ENetEvent</a>.  <a href="enet_8h.html#dc5336f0698d4336b587f083d89df414">More...</a><br></td></tr>
164<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
165<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3a2d26a32098450edee8054a39d71906"></a><!-- doxytag: member="enet.h::void" ref="3a2d26a32098450edee8054a39d71906" args="(ENET_CALLBACK *ENetPacketFreeCallback)(struct _ENetPacket *)" -->
166typedef&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>
167
168<tr><td class="memItemLeft" nowrap align="right" valign="top">ENET_API int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__global.html#g67fa85c46a1dc91f968f25fc0637c897">enet_initialize</a> (void)</td></tr>
169
170<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initializes ENet globally.  <a href="group__global.html#g67fa85c46a1dc91f968f25fc0637c897"></a><br></td></tr>
171<tr><td class="memItemLeft" nowrap align="right" valign="top">ENET_API int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__global.html#gef1e7849f3ddde18c6a30f32783c899d">enet_initialize_with_callbacks</a> (ENetVersion version, const ENetCallbacks *inits)</td></tr>
172
173<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initializes ENet globally and supplies user-overridden callbacks.  <a href="group__global.html#gef1e7849f3ddde18c6a30f32783c899d"></a><br></td></tr>
174<tr><td class="memItemLeft" nowrap align="right" valign="top">ENET_API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__global.html#gd62cf417e08a2b98d48572a336f7db25">enet_deinitialize</a> (void)</td></tr>
175
176<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Shuts down ENet globally.  <a href="group__global.html#gd62cf417e08a2b98d48572a336f7db25"></a><br></td></tr>
177<tr><td class="memItemLeft" nowrap align="right" valign="top">ENET_API <a class="el" href="types_8h.html#5273659ca3c664b8550452732e9e4ae3">enet_uint32</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="enet_8h.html#3d60275f78985d9aaba12c2fad13c37f">enet_time_get</a> (void)</td></tr>
178
179<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the wall-time in milliseconds.  <a href="#3d60275f78985d9aaba12c2fad13c37f"></a><br></td></tr>
180<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="820cd12062e6fabcbfd3c24c4759e8ca"></a><!-- doxytag: member="enet.h::enet_time_set" ref="820cd12062e6fabcbfd3c24c4759e8ca" args="(enet_uint32)" -->
181ENET_API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="enet_8h.html#820cd12062e6fabcbfd3c24c4759e8ca">enet_time_set</a> (<a class="el" href="types_8h.html#5273659ca3c664b8550452732e9e4ae3">enet_uint32</a>)</td></tr>
182
183<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the current wall-time in milliseconds. <br></td></tr>
184<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g77ebdc22775e513b9d555865deb9abb7"></a><!-- doxytag: member="enet.h::enet_socket_create" ref="g77ebdc22775e513b9d555865deb9abb7" args="(ENetSocketType, const ENetAddress *)" -->
185ENET_API ENetSocket&nbsp;</td><td class="memItemRight" valign="bottom"><b>enet_socket_create</b> (ENetSocketType, const <a class="el" href="struct__ENetAddress.html">ENetAddress</a> *)</td></tr>
186
187<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gaf0f06f15ce99ba362250d6c5768866e"></a><!-- doxytag: member="enet.h::enet_socket_accept" ref="gaf0f06f15ce99ba362250d6c5768866e" args="(ENetSocket, ENetAddress *)" -->
188ENET_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>
189
190<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gc657e370f1585ce2e0f42b35f28b0d29"></a><!-- doxytag: member="enet.h::enet_socket_connect" ref="gc657e370f1585ce2e0f42b35f28b0d29" args="(ENetSocket, const ENetAddress *)" -->
191ENET_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>
192
193<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g7b31df6015f1f2b4850dfbf63ccc10ac"></a><!-- doxytag: member="enet.h::enet_socket_send" ref="g7b31df6015f1f2b4850dfbf63ccc10ac" args="(ENetSocket, const ENetAddress *, const ENetBuffer *, size_t)" -->
194ENET_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 ENetBuffer *, size_t)</td></tr>
195
196<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g119dba4de09aca16bd936953c8bc9853"></a><!-- doxytag: member="enet.h::enet_socket_receive" ref="g119dba4de09aca16bd936953c8bc9853" args="(ENetSocket, ENetAddress *, ENetBuffer *, size_t)" -->
197ENET_API int&nbsp;</td><td class="memItemRight" valign="bottom"><b>enet_socket_receive</b> (ENetSocket, <a class="el" href="struct__ENetAddress.html">ENetAddress</a> *, ENetBuffer *, size_t)</td></tr>
198
199<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g06158e2adcfa90f18c9fdd13b7101231"></a><!-- doxytag: member="enet.h::enet_socket_wait" ref="g06158e2adcfa90f18c9fdd13b7101231" args="(ENetSocket, enet_uint32 *, enet_uint32)" -->
200ENET_API int&nbsp;</td><td class="memItemRight" valign="bottom"><b>enet_socket_wait</b> (ENetSocket, <a class="el" href="types_8h.html#5273659ca3c664b8550452732e9e4ae3">enet_uint32</a> *, <a class="el" href="types_8h.html#5273659ca3c664b8550452732e9e4ae3">enet_uint32</a>)</td></tr>
201
202<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g7b4933cda2967776397c23538cacadea"></a><!-- doxytag: member="enet.h::enet_socket_destroy" ref="g7b4933cda2967776397c23538cacadea" args="(ENetSocket)" -->
203ENET_API void&nbsp;</td><td class="memItemRight" valign="bottom"><b>enet_socket_destroy</b> (ENetSocket)</td></tr>
204
205<tr><td class="memItemLeft" nowrap align="right" valign="top">ENET_API int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Address.html#g32a6ae1ed3d7704858f237688e7384ee">enet_address_set_host</a> (<a class="el" href="struct__ENetAddress.html">ENetAddress</a> *address, const char *hostName)</td></tr>
206
207<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#g32a6ae1ed3d7704858f237688e7384ee"></a><br></td></tr>
208<tr><td class="memItemLeft" nowrap align="right" valign="top">ENET_API int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Address.html#g770507a74d2e98334eebdadd9c681f69">enet_address_get_host_ip</a> (const <a class="el" href="struct__ENetAddress.html">ENetAddress</a> *address, char *hostName, size_t nameLength)</td></tr>
209
210<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#g770507a74d2e98334eebdadd9c681f69"></a><br></td></tr>
211<tr><td class="memItemLeft" nowrap align="right" valign="top">ENET_API int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Address.html#g55282b3074cb409544f6aa72a67582ab">enet_address_get_host</a> (const <a class="el" href="struct__ENetAddress.html">ENetAddress</a> *address, char *hostName, size_t nameLength)</td></tr>
212
213<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#g55282b3074cb409544f6aa72a67582ab"></a><br></td></tr>
214<tr><td class="memItemLeft" nowrap 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#gac61b251aebbf9f5e5e313eca51339ea">enet_packet_create</a> (const void *, size_t, <a class="el" href="types_8h.html#5273659ca3c664b8550452732e9e4ae3">enet_uint32</a>)</td></tr>
215
216<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates a packet that may be sent to a peer.  <a href="group__Packet.html#gac61b251aebbf9f5e5e313eca51339ea"></a><br></td></tr>
217<tr><td class="memItemLeft" nowrap align="right" valign="top">ENET_API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Packet.html#gb58895376ee4ade8f4e13761a44ba263">enet_packet_destroy</a> (<a class="el" href="struct__ENetPacket.html">ENetPacket</a> *)</td></tr>
218
219<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destroys the packet and deallocates its data.  <a href="group__Packet.html#gb58895376ee4ade8f4e13761a44ba263"></a><br></td></tr>
220<tr><td class="memItemLeft" nowrap align="right" valign="top">ENET_API int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Packet.html#g0aee7f8c7e2d2c4b64f6d68d930155a8">enet_packet_resize</a> (<a class="el" href="struct__ENetPacket.html">ENetPacket</a> *, size_t)</td></tr>
221
222<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#g0aee7f8c7e2d2c4b64f6d68d930155a8"></a><br></td></tr>
223<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g015ce0307049901852c54dd2def532e2"></a><!-- doxytag: member="enet.h::enet_crc32" ref="g015ce0307049901852c54dd2def532e2" args="(const ENetBuffer *, size_t)" -->
224<a class="el" href="types_8h.html#5273659ca3c664b8550452732e9e4ae3">enet_uint32</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>enet_crc32</b> (const ENetBuffer *, size_t)</td></tr>
225
226<tr><td class="memItemLeft" nowrap 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#g929df1baa1662e1eb0ae89af9ee3b339">enet_host_create</a> (const <a class="el" href="struct__ENetAddress.html">ENetAddress</a> *, size_t, <a class="el" href="types_8h.html#5273659ca3c664b8550452732e9e4ae3">enet_uint32</a>, <a class="el" href="types_8h.html#5273659ca3c664b8550452732e9e4ae3">enet_uint32</a>)</td></tr>
227
228<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates a host for communicating to peers.  <a href="group__host.html#g929df1baa1662e1eb0ae89af9ee3b339"></a><br></td></tr>
229<tr><td class="memItemLeft" nowrap align="right" valign="top">ENET_API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__host.html#gcec1e9a0b528c1f9ce30544d2d5b5b79">enet_host_destroy</a> (<a class="el" href="struct__ENetHost.html">ENetHost</a> *)</td></tr>
230
231<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destroys the host and all resources associated with it.  <a href="group__host.html#gcec1e9a0b528c1f9ce30544d2d5b5b79"></a><br></td></tr>
232<tr><td class="memItemLeft" nowrap 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#g04f234142512c08dd86a22b05020bd88">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)</td></tr>
233
234<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initiates a connection to a foreign host.  <a href="group__host.html#g04f234142512c08dd86a22b05020bd88"></a><br></td></tr>
235<tr><td class="memItemLeft" nowrap align="right" valign="top">ENET_API int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__host.html#g6ba501b3ee576e5578c8e6d1694ebd49">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#5273659ca3c664b8550452732e9e4ae3">enet_uint32</a>)</td></tr>
236
237<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#g6ba501b3ee576e5578c8e6d1694ebd49"></a><br></td></tr>
238<tr><td class="memItemLeft" nowrap align="right" valign="top">ENET_API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__host.html#gc8f53bcdbd540043f87e7d59048559fa">enet_host_flush</a> (<a class="el" href="struct__ENetHost.html">ENetHost</a> *)</td></tr>
239
240<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#gc8f53bcdbd540043f87e7d59048559fa"></a><br></td></tr>
241<tr><td class="memItemLeft" nowrap align="right" valign="top">ENET_API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__host.html#g5190a63f78eb0c15bd96cda44bf423c6">enet_host_broadcast</a> (<a class="el" href="struct__ENetHost.html">ENetHost</a> *, <a class="el" href="types_8h.html#34ce80c65abc6389fe0121a83d757f07">enet_uint8</a>, <a class="el" href="struct__ENetPacket.html">ENetPacket</a> *)</td></tr>
242
243<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#g5190a63f78eb0c15bd96cda44bf423c6"></a><br></td></tr>
244<tr><td class="memItemLeft" nowrap align="right" valign="top">ENET_API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__host.html#g83c5fa02a3ba6ab829856302e54929fe">enet_host_bandwidth_limit</a> (<a class="el" href="struct__ENetHost.html">ENetHost</a> *, <a class="el" href="types_8h.html#5273659ca3c664b8550452732e9e4ae3">enet_uint32</a>, <a class="el" href="types_8h.html#5273659ca3c664b8550452732e9e4ae3">enet_uint32</a>)</td></tr>
245
246<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Adjusts the bandwidth limits of a host.  <a href="group__host.html#g83c5fa02a3ba6ab829856302e54929fe"></a><br></td></tr>
247<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gc76acd47fd07c27e5b85ecb63b192dd1"></a><!-- doxytag: member="enet.h::enet_host_bandwidth_throttle" ref="gc76acd47fd07c27e5b85ecb63b192dd1" args="(ENetHost *)" -->
248void&nbsp;</td><td class="memItemRight" valign="bottom"><b>enet_host_bandwidth_throttle</b> (<a class="el" href="struct__ENetHost.html">ENetHost</a> *)</td></tr>
249
250<tr><td class="memItemLeft" nowrap align="right" valign="top">ENET_API int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__peer.html#gf082a0ae58d9c435bed75c7325cf7290">enet_peer_send</a> (<a class="el" href="struct__ENetPeer.html">ENetPeer</a> *, <a class="el" href="types_8h.html#34ce80c65abc6389fe0121a83d757f07">enet_uint8</a>, <a class="el" href="struct__ENetPacket.html">ENetPacket</a> *)</td></tr>
251
252<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Queues a packet to be sent.  <a href="group__peer.html#gf082a0ae58d9c435bed75c7325cf7290"></a><br></td></tr>
253<tr><td class="memItemLeft" nowrap 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#g8dc63196f44a3b7a31fd23d8f856d80f">enet_peer_receive</a> (<a class="el" href="struct__ENetPeer.html">ENetPeer</a> *, <a class="el" href="types_8h.html#34ce80c65abc6389fe0121a83d757f07">enet_uint8</a>)</td></tr>
254
255<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Attempts to dequeue any incoming queued packet.  <a href="group__peer.html#g8dc63196f44a3b7a31fd23d8f856d80f"></a><br></td></tr>
256<tr><td class="memItemLeft" nowrap align="right" valign="top">ENET_API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__peer.html#g5c0708ddaf340aa42e7754a91ce456b6">enet_peer_ping</a> (<a class="el" href="struct__ENetPeer.html">ENetPeer</a> *)</td></tr>
257
258<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sends a ping request to a peer.  <a href="group__peer.html#g5c0708ddaf340aa42e7754a91ce456b6"></a><br></td></tr>
259<tr><td class="memItemLeft" nowrap align="right" valign="top">ENET_API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__peer.html#g9444dfff9574a7d21dbbdd34385a7d4d">enet_peer_reset</a> (<a class="el" href="struct__ENetPeer.html">ENetPeer</a> *)</td></tr>
260
261<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Forcefully disconnects a peer.  <a href="group__peer.html#g9444dfff9574a7d21dbbdd34385a7d4d"></a><br></td></tr>
262<tr><td class="memItemLeft" nowrap align="right" valign="top">ENET_API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__peer.html#g0e807704b6ecace5004c2cdcfbf813c2">enet_peer_disconnect</a> (<a class="el" href="struct__ENetPeer.html">ENetPeer</a> *, <a class="el" href="types_8h.html#5273659ca3c664b8550452732e9e4ae3">enet_uint32</a>)</td></tr>
263
264<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Request a disconnection from a peer.  <a href="group__peer.html#g0e807704b6ecace5004c2cdcfbf813c2"></a><br></td></tr>
265<tr><td class="memItemLeft" nowrap align="right" valign="top">ENET_API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__peer.html#g636cc45f52461b567d6daffe4ab8f4e9">enet_peer_disconnect_now</a> (<a class="el" href="struct__ENetPeer.html">ENetPeer</a> *, <a class="el" href="types_8h.html#5273659ca3c664b8550452732e9e4ae3">enet_uint32</a>)</td></tr>
266
267<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Force an immediate disconnection from a peer.  <a href="group__peer.html#g636cc45f52461b567d6daffe4ab8f4e9"></a><br></td></tr>
268<tr><td class="memItemLeft" nowrap align="right" valign="top">ENET_API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__peer.html#g759270d8cccec70f76274e93b49e5ac5">enet_peer_disconnect_later</a> (<a class="el" href="struct__ENetPeer.html">ENetPeer</a> *, <a class="el" href="types_8h.html#5273659ca3c664b8550452732e9e4ae3">enet_uint32</a>)</td></tr>
269
270<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#g759270d8cccec70f76274e93b49e5ac5"></a><br></td></tr>
271<tr><td class="memItemLeft" nowrap align="right" valign="top">ENET_API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__peer.html#gb35807c848b6c88af12ce8476dffbc84">enet_peer_throttle_configure</a> (<a class="el" href="struct__ENetPeer.html">ENetPeer</a> *, <a class="el" href="types_8h.html#5273659ca3c664b8550452732e9e4ae3">enet_uint32</a>, <a class="el" href="types_8h.html#5273659ca3c664b8550452732e9e4ae3">enet_uint32</a>, <a class="el" href="types_8h.html#5273659ca3c664b8550452732e9e4ae3">enet_uint32</a>)</td></tr>
272
273<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Configures throttle parameter for a peer.  <a href="group__peer.html#gb35807c848b6c88af12ce8476dffbc84"></a><br></td></tr>
274<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g52c5c6b1bbd807466298b2d7ed12fdd6"></a><!-- doxytag: member="enet.h::enet_peer_throttle" ref="g52c5c6b1bbd807466298b2d7ed12fdd6" args="(ENetPeer *, enet_uint32)" -->
275int&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#5273659ca3c664b8550452732e9e4ae3">enet_uint32</a>)</td></tr>
276
277<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g9a8da1e258f10bbef173abd598534f09"></a><!-- doxytag: member="enet.h::enet_peer_reset_queues" ref="g9a8da1e258f10bbef173abd598534f09" args="(ENetPeer *)" -->
278void&nbsp;</td><td class="memItemRight" valign="bottom"><b>enet_peer_reset_queues</b> (<a class="el" href="struct__ENetPeer.html">ENetPeer</a> *)</td></tr>
279
280<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g0dff073e7882de81bdf46ae8e1bc3883"></a><!-- doxytag: member="enet.h::enet_peer_queue_outgoing_command" ref="g0dff073e7882de81bdf46ae8e1bc3883" args="(ENetPeer *, const ENetProtocol *, ENetPacket *, enet_uint32, enet_uint16)" -->
281ENetOutgoingCommand *&nbsp;</td><td class="memItemRight" valign="bottom"><b>enet_peer_queue_outgoing_command</b> (<a class="el" href="struct__ENetPeer.html">ENetPeer</a> *, const ENetProtocol *, <a class="el" href="struct__ENetPacket.html">ENetPacket</a> *, <a class="el" href="types_8h.html#5273659ca3c664b8550452732e9e4ae3">enet_uint32</a>, <a class="el" href="types_8h.html#245102585fdf31bdf208639ef47bec5d">enet_uint16</a>)</td></tr>
282
283<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gd48f786cc1fa1b2453a1da9274c7427b"></a><!-- doxytag: member="enet.h::enet_peer_queue_incoming_command" ref="gd48f786cc1fa1b2453a1da9274c7427b" args="(ENetPeer *, const ENetProtocol *, ENetPacket *, enet_uint32)" -->
284ENetIncomingCommand *&nbsp;</td><td class="memItemRight" valign="bottom"><b>enet_peer_queue_incoming_command</b> (<a class="el" href="struct__ENetPeer.html">ENetPeer</a> *, const ENetProtocol *, <a class="el" href="struct__ENetPacket.html">ENetPacket</a> *, <a class="el" href="types_8h.html#5273659ca3c664b8550452732e9e4ae3">enet_uint32</a>)</td></tr>
285
286<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g6f8ab6421d3455b7b12b14f477ea83aa"></a><!-- doxytag: member="enet.h::enet_peer_queue_acknowledgement" ref="g6f8ab6421d3455b7b12b14f477ea83aa" args="(ENetPeer *, const ENetProtocol *, enet_uint16)" -->
287ENetAcknowledgement *&nbsp;</td><td class="memItemRight" valign="bottom"><b>enet_peer_queue_acknowledgement</b> (<a class="el" href="struct__ENetPeer.html">ENetPeer</a> *, const ENetProtocol *, <a class="el" href="types_8h.html#245102585fdf31bdf208639ef47bec5d">enet_uint16</a>)</td></tr>
288
289<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ea0520a5cc4fc91f40690eebbdc1ff90"></a><!-- doxytag: member="enet.h::enet_protocol_command_size" ref="ea0520a5cc4fc91f40690eebbdc1ff90" args="(enet_uint8)" -->
290size_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>enet_protocol_command_size</b> (<a class="el" href="types_8h.html#34ce80c65abc6389fe0121a83d757f07">enet_uint8</a>)</td></tr>
291
292</table>
293<hr><h2>Typedef Documentation</h2>
294<a class="anchor" name="c056c795b58ec874a9eb91259fb20198"></a><!-- doxytag: member="enet.h::ENetAddress" ref="c056c795b58ec874a9eb91259fb20198" args="" -->
295<div class="memitem">
296<div class="memproto">
297      <table class="memname">
298        <tr>
299          <td class="memname">typedef struct <a class="el" href="struct__ENetAddress.html">_ENetAddress</a>  <a class="el" href="struct__ENetAddress.html">ENetAddress</a>          </td>
300        </tr>
301      </table>
302</div>
303<div class="memdoc">
304
305<p>
306The 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.
307</div>
308</div><p>
309<a class="anchor" name="1ed78ad8f38bfa9055feab2f957718bd"></a><!-- doxytag: member="enet.h::ENetEvent" ref="1ed78ad8f38bfa9055feab2f957718bd" args="" -->
310<div class="memitem">
311<div class="memproto">
312      <table class="memname">
313        <tr>
314          <td class="memname">typedef struct <a class="el" href="struct__ENetEvent.html">_ENetEvent</a>  <a class="el" href="struct__ENetEvent.html">ENetEvent</a>          </td>
315        </tr>
316      </table>
317</div>
318<div class="memdoc">
319
320<p>
321<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__host.html#g6ba501b3ee576e5578c8e6d1694ebd49">enet_host_service</a> </dd></dl>
322
323</div>
324</div><p>
325<a class="anchor" name="258d786d5940288970898ac827bf2a68"></a><!-- doxytag: member="enet.h::ENetHost" ref="258d786d5940288970898ac827bf2a68" args="" -->
326<div class="memitem">
327<div class="memproto">
328      <table class="memname">
329        <tr>
330          <td class="memname">typedef struct <a class="el" href="struct__ENetHost.html">_ENetHost</a>  <a class="el" href="struct__ENetHost.html">ENetHost</a>          </td>
331        </tr>
332      </table>
333</div>
334<div class="memdoc">
335
336<p>
337No fields should be modified.<p>
338<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__host.html#g929df1baa1662e1eb0ae89af9ee3b339">enet_host_create()</a> <p>
339<a class="el" href="group__host.html#gcec1e9a0b528c1f9ce30544d2d5b5b79">enet_host_destroy()</a> <p>
340<a class="el" href="group__host.html#g04f234142512c08dd86a22b05020bd88">enet_host_connect()</a> <p>
341<a class="el" href="group__host.html#g6ba501b3ee576e5578c8e6d1694ebd49">enet_host_service()</a> <p>
342<a class="el" href="group__host.html#gc8f53bcdbd540043f87e7d59048559fa">enet_host_flush()</a> <p>
343<a class="el" href="group__host.html#g5190a63f78eb0c15bd96cda44bf423c6">enet_host_broadcast()</a> <p>
344<a class="el" href="group__host.html#g83c5fa02a3ba6ab829856302e54929fe">enet_host_bandwidth_limit()</a> <p>
345enet_host_bandwidth_throttle() </dd></dl>
346
347</div>
348</div><p>
349<a class="anchor" name="fc931483a08e39defe4fbac06945626c"></a><!-- doxytag: member="enet.h::ENetPacket" ref="fc931483a08e39defe4fbac06945626c" args="" -->
350<div class="memitem">
351<div class="memproto">
352      <table class="memname">
353        <tr>
354          <td class="memname">typedef struct <a class="el" href="struct__ENetPacket.html">_ENetPacket</a>  <a class="el" href="struct__ENetPacket.html">ENetPacket</a>          </td>
355        </tr>
356      </table>
357</div>
358<div class="memdoc">
359
360<p>
361An 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>
362ENET_PACKET_FLAG_RELIABLE - packet must be received by the target peer and resend attempts should be made until the packet is delivered<p>
363ENET_PACKET_FLAG_UNSEQUENCED - packet will not be sequenced with other packets (not supported for reliable packets)<p>
364ENET_PACKET_FLAG_NO_ALLOCATE - packet will not allocate data, and user must supply it instead<p>
365<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="enet_8h.html#38c59a481ed607b07d63b7bc3e88ca98">ENetPacketFlag</a> </dd></dl>
366
367</div>
368</div><p>
369<a class="anchor" name="e879b330cb0d2ade08cef4231423eaa7"></a><!-- doxytag: member="enet.h::ENetPeer" ref="e879b330cb0d2ade08cef4231423eaa7" args="" -->
370<div class="memitem">
371<div class="memproto">
372      <table class="memname">
373        <tr>
374          <td class="memname">typedef struct <a class="el" href="struct__ENetPeer.html">_ENetPeer</a>  <a class="el" href="struct__ENetPeer.html">ENetPeer</a>          </td>
375        </tr>
376      </table>
377</div>
378<div class="memdoc">
379
380<p>
381No fields should be modified unless otherwise specified.
382</div>
383</div><p>
384<hr><h2>Enumeration Type Documentation</h2>
385<a class="anchor" name="06fc87d81c62e9abb8790b6e5713c55b"></a><!-- doxytag: member="enet.h::@0" ref="06fc87d81c62e9abb8790b6e5713c55b" args="" -->
386<div class="memitem">
387<div class="memproto">
388      <table class="memname">
389        <tr>
390          <td class="memname">anonymous enum          </td>
391        </tr>
392      </table>
393</div>
394<div class="memdoc">
395
396<p>
397<dl compact><dt><b>Enumerator: </b></dt><dd>
398<table border="0" cellspacing="2" cellpadding="0">
399<tr><td valign="top"><em><a class="anchor" name="06fc87d81c62e9abb8790b6e5713c55b3d8d24eeb6e426826e88540d7c87d036"></a><!-- doxytag: member="ENET_HOST_ANY" ref="06fc87d81c62e9abb8790b6e5713c55b3d8d24eeb6e426826e88540d7c87d036" args="" -->ENET_HOST_ANY</em>&nbsp;</td><td>
400specifies the default server host </td></tr>
401<tr><td valign="top"><em><a class="anchor" name="06fc87d81c62e9abb8790b6e5713c55bf40f3e48e3f87859c06d62023601eb57"></a><!-- doxytag: member="ENET_HOST_BROADCAST" ref="06fc87d81c62e9abb8790b6e5713c55bf40f3e48e3f87859c06d62023601eb57" args="" -->ENET_HOST_BROADCAST</em>&nbsp;</td><td>
402specifies a subnet-wide broadcast </td></tr>
403<tr><td valign="top"><em><a class="anchor" name="06fc87d81c62e9abb8790b6e5713c55b851f798e15c7f68c29a5755ac7d7cce4"></a><!-- doxytag: member="ENET_PORT_ANY" ref="06fc87d81c62e9abb8790b6e5713c55b851f798e15c7f68c29a5755ac7d7cce4" args="" -->ENET_PORT_ANY</em>&nbsp;</td><td>
404specifies that a port should be automatically chosen </td></tr>
405</table>
406</dl>
407
408</div>
409</div><p>
410<a class="anchor" name="dc5336f0698d4336b587f083d89df414"></a><!-- doxytag: member="enet.h::ENetEventType" ref="dc5336f0698d4336b587f083d89df414" args="" -->
411<div class="memitem">
412<div class="memproto">
413      <table class="memname">
414        <tr>
415          <td class="memname">enum <a class="el" href="enet_8h.html#dc5336f0698d4336b587f083d89df414">ENetEventType</a>          </td>
416        </tr>
417      </table>
418</div>
419<div class="memdoc">
420
421<p>
422<dl compact><dt><b>Enumerator: </b></dt><dd>
423<table border="0" cellspacing="2" cellpadding="0">
424<tr><td valign="top"><em><a class="anchor" name="dc5336f0698d4336b587f083d89df414d76c1d9192a5c6ac60a3820e3d7379c5"></a><!-- doxytag: member="ENET_EVENT_TYPE_NONE" ref="dc5336f0698d4336b587f083d89df414d76c1d9192a5c6ac60a3820e3d7379c5" args="" -->ENET_EVENT_TYPE_NONE</em>&nbsp;</td><td>
425no event occurred within the specified time limit </td></tr>
426<tr><td valign="top"><em><a class="anchor" name="dc5336f0698d4336b587f083d89df414efd9fa36297e41ca4c1cbcfdeb7e4a9d"></a><!-- doxytag: member="ENET_EVENT_TYPE_CONNECT" ref="dc5336f0698d4336b587f083d89df414efd9fa36297e41ca4c1cbcfdeb7e4a9d" args="" -->ENET_EVENT_TYPE_CONNECT</em>&nbsp;</td><td>
427a connection request initiated by enet_host_connect has completed.
428<p>
429The peer field contains the peer which successfully connected. </td></tr>
430<tr><td valign="top"><em><a class="anchor" name="dc5336f0698d4336b587f083d89df4144fa47af84cf901810510aeba077a1c2f"></a><!-- doxytag: member="ENET_EVENT_TYPE_DISCONNECT" ref="dc5336f0698d4336b587f083d89df4144fa47af84cf901810510aeba077a1c2f" args="" -->ENET_EVENT_TYPE_DISCONNECT</em>&nbsp;</td><td>
431a peer has disconnected.
432<p>
433This 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. </td></tr>
434<tr><td valign="top"><em><a class="anchor" name="dc5336f0698d4336b587f083d89df41467d928ca38b289db53ec9f56c91c5d9d"></a><!-- doxytag: member="ENET_EVENT_TYPE_RECEIVE" ref="dc5336f0698d4336b587f083d89df41467d928ca38b289db53ec9f56c91c5d9d" args="" -->ENET_EVENT_TYPE_RECEIVE</em>&nbsp;</td><td>
435a packet has been received from a peer.
436<p>
437The 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. </td></tr>
438</table>
439</dl>
440
441</div>
442</div><p>
443<a class="anchor" name="38c59a481ed607b07d63b7bc3e88ca98"></a><!-- doxytag: member="enet.h::ENetPacketFlag" ref="38c59a481ed607b07d63b7bc3e88ca98" args="" -->
444<div class="memitem">
445<div class="memproto">
446      <table class="memname">
447        <tr>
448          <td class="memname">enum <a class="el" href="enet_8h.html#38c59a481ed607b07d63b7bc3e88ca98">ENetPacketFlag</a>          </td>
449        </tr>
450      </table>
451</div>
452<div class="memdoc">
453
454<p>
455The 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>
456<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="enet_8h.html#fc931483a08e39defe4fbac06945626c">ENetPacket</a> </dd></dl>
457<dl compact><dt><b>Enumerator: </b></dt><dd>
458<table border="0" cellspacing="2" cellpadding="0">
459<tr><td valign="top"><em><a class="anchor" name="38c59a481ed607b07d63b7bc3e88ca98ab20e7088245ab2ddb7f11dcc9433738"></a><!-- doxytag: member="ENET_PACKET_FLAG_RELIABLE" ref="38c59a481ed607b07d63b7bc3e88ca98ab20e7088245ab2ddb7f11dcc9433738" args="" -->ENET_PACKET_FLAG_RELIABLE</em>&nbsp;</td><td>
460packet must be received by the target peer and resend attempts should be made until the packet is delivered </td></tr>
461<tr><td valign="top"><em><a class="anchor" name="38c59a481ed607b07d63b7bc3e88ca98d230cc769ef9cc4c7c582b28f9c443fe"></a><!-- doxytag: member="ENET_PACKET_FLAG_UNSEQUENCED" ref="38c59a481ed607b07d63b7bc3e88ca98d230cc769ef9cc4c7c582b28f9c443fe" args="" -->ENET_PACKET_FLAG_UNSEQUENCED</em>&nbsp;</td><td>
462packet will not be sequenced with other packets not supported for reliable packets </td></tr>
463<tr><td valign="top"><em><a class="anchor" name="38c59a481ed607b07d63b7bc3e88ca98a6ce462752c36aad22e68ebefac3df8c"></a><!-- doxytag: member="ENET_PACKET_FLAG_NO_ALLOCATE" ref="38c59a481ed607b07d63b7bc3e88ca98a6ce462752c36aad22e68ebefac3df8c" args="" -->ENET_PACKET_FLAG_NO_ALLOCATE</em>&nbsp;</td><td>
464packet will not allocate data, and user must supply it instead </td></tr>
465</table>
466</dl>
467
468</div>
469</div><p>
470<hr><h2>Function Documentation</h2>
471<a class="anchor" name="3d60275f78985d9aaba12c2fad13c37f"></a><!-- doxytag: member="enet.h::enet_time_get" ref="3d60275f78985d9aaba12c2fad13c37f" args="(void)" -->
472<div class="memitem">
473<div class="memproto">
474      <table class="memname">
475        <tr>
476          <td class="memname">ENET_API <a class="el" href="types_8h.html#5273659ca3c664b8550452732e9e4ae3">enet_uint32</a> enet_time_get           </td>
477          <td>(</td>
478          <td class="paramtype">void&nbsp;</td>
479          <td class="paramname">          </td>
480          <td>&nbsp;)&nbsp;</td>
481          <td width="100%"></td>
482        </tr>
483      </table>
484</div>
485<div class="memdoc">
486
487<p>
488Its initial value is unspecified unless otherwise set.
489</div>
490</div><p>
491<hr size="1"><address style="align: right;"><small>Generated on Wed Jun 6 14:33:50 2007 for enet by&nbsp;
492<a href="http://www.doxygen.org/index.html">
493<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1 </small></address>
494</body>
495</html>
Note: See TracBrowser for help on using the repository browser.