enet
enet.h
Go to the documentation of this file.
1 
5 #ifndef __ENET_ENET_H__
6 #define __ENET_ENET_H__
7 
8 #ifdef __cplusplus
9 extern "C"
10 {
11 #endif
12 
13 #include <stdlib.h>
14 
15 #ifdef WIN32
16 #include "enet/win32.h"
17 #else
18 #include "enet/unix.h"
19 #endif
20 
21 #include "enet/types.h"
22 #include "enet/protocol.h"
23 #include "enet/list.h"
24 #include "enet/callbacks.h"
25 
26 #define ENET_VERSION_MAJOR 1
27 #define ENET_VERSION_MINOR 3
28 #define ENET_VERSION_PATCH 3
29 #define ENET_VERSION_CREATE(major, minor, patch) (((major)<<16) | ((minor)<<8) | (patch))
30 #define ENET_VERSION ENET_VERSION_CREATE(ENET_VERSION_MAJOR, ENET_VERSION_MINOR, ENET_VERSION_PATCH)
31 
32 typedef enet_uint32 ENetVersion;
33 
34 typedef enum _ENetSocketType
35 {
36  ENET_SOCKET_TYPE_STREAM = 1,
37  ENET_SOCKET_TYPE_DATAGRAM = 2
38 } ENetSocketType;
39 
40 typedef enum _ENetSocketWait
41 {
42  ENET_SOCKET_WAIT_NONE = 0,
43  ENET_SOCKET_WAIT_SEND = (1 << 0),
44  ENET_SOCKET_WAIT_RECEIVE = (1 << 1)
45 } ENetSocketWait;
46 
47 typedef enum _ENetSocketOption
48 {
49  ENET_SOCKOPT_NONBLOCK = 1,
50  ENET_SOCKOPT_BROADCAST = 2,
51  ENET_SOCKOPT_RCVBUF = 3,
52  ENET_SOCKOPT_SNDBUF = 4,
53  ENET_SOCKOPT_REUSEADDR = 5
54 } ENetSocketOption;
55 
56 enum
57 {
59  ENET_HOST_BROADCAST = 0xFFFFFFFF,
62 };
63 
74 typedef struct _ENetAddress
75 {
76  enet_uint32 host;
77  enet_uint16 port;
78 } ENetAddress;
79 
89 typedef enum _ENetPacketFlag
90 {
104 
105 struct _ENetPacket;
106 typedef void (ENET_CALLBACK * ENetPacketFreeCallback) (struct _ENetPacket *);
107 
127 typedef struct _ENetPacket
128 {
129  size_t referenceCount;
132  size_t dataLength;
133  ENetPacketFreeCallback freeCallback;
134 } ENetPacket;
135 
136 typedef struct _ENetAcknowledgement
137 {
138  ENetListNode acknowledgementList;
139  enet_uint32 sentTime;
140  ENetProtocol command;
142 
143 typedef struct _ENetOutgoingCommand
144 {
145  ENetListNode outgoingCommandList;
146  enet_uint16 reliableSequenceNumber;
147  enet_uint16 unreliableSequenceNumber;
148  enet_uint32 sentTime;
149  enet_uint32 roundTripTimeout;
150  enet_uint32 roundTripTimeoutLimit;
151  enet_uint32 fragmentOffset;
152  enet_uint16 fragmentLength;
153  enet_uint16 sendAttempts;
154  ENetProtocol command;
155  ENetPacket * packet;
157 
158 typedef struct _ENetIncomingCommand
159 {
160  ENetListNode incomingCommandList;
161  enet_uint16 reliableSequenceNumber;
162  enet_uint16 unreliableSequenceNumber;
163  ENetProtocol command;
164  enet_uint32 fragmentCount;
165  enet_uint32 fragmentsRemaining;
166  enet_uint32 * fragments;
167  ENetPacket * packet;
169 
170 typedef enum _ENetPeerState
171 {
172  ENET_PEER_STATE_DISCONNECTED = 0,
173  ENET_PEER_STATE_CONNECTING = 1,
174  ENET_PEER_STATE_ACKNOWLEDGING_CONNECT = 2,
175  ENET_PEER_STATE_CONNECTION_PENDING = 3,
176  ENET_PEER_STATE_CONNECTION_SUCCEEDED = 4,
177  ENET_PEER_STATE_CONNECTED = 5,
178  ENET_PEER_STATE_DISCONNECT_LATER = 6,
179  ENET_PEER_STATE_DISCONNECTING = 7,
180  ENET_PEER_STATE_ACKNOWLEDGING_DISCONNECT = 8,
181  ENET_PEER_STATE_ZOMBIE = 9
182 } ENetPeerState;
183 
184 #ifndef ENET_BUFFER_MAXIMUM
185 #define ENET_BUFFER_MAXIMUM (1 + 2 * ENET_PROTOCOL_MAXIMUM_PACKET_COMMANDS)
186 #endif
187 
188 enum
189 {
190  ENET_HOST_RECEIVE_BUFFER_SIZE = 256 * 1024,
191  ENET_HOST_SEND_BUFFER_SIZE = 256 * 1024,
192  ENET_HOST_BANDWIDTH_THROTTLE_INTERVAL = 1000,
193  ENET_HOST_DEFAULT_MTU = 1400,
194 
195  ENET_PEER_DEFAULT_ROUND_TRIP_TIME = 500,
196  ENET_PEER_DEFAULT_PACKET_THROTTLE = 32,
197  ENET_PEER_PACKET_THROTTLE_SCALE = 32,
198  ENET_PEER_PACKET_THROTTLE_COUNTER = 7,
199  ENET_PEER_PACKET_THROTTLE_ACCELERATION = 2,
200  ENET_PEER_PACKET_THROTTLE_DECELERATION = 2,
201  ENET_PEER_PACKET_THROTTLE_INTERVAL = 5000,
202  ENET_PEER_PACKET_LOSS_SCALE = (1 << 16),
203  ENET_PEER_PACKET_LOSS_INTERVAL = 10000,
204  ENET_PEER_WINDOW_SIZE_SCALE = 64 * 1024,
205  ENET_PEER_TIMEOUT_LIMIT = 32,
206  ENET_PEER_TIMEOUT_MINIMUM = 5000,
207  ENET_PEER_TIMEOUT_MAXIMUM = 30000,
208  ENET_PEER_PING_INTERVAL = 500,
209  ENET_PEER_UNSEQUENCED_WINDOWS = 64,
210  ENET_PEER_UNSEQUENCED_WINDOW_SIZE = 1024,
211  ENET_PEER_FREE_UNSEQUENCED_WINDOWS = 32,
212  ENET_PEER_RELIABLE_WINDOWS = 16,
213  ENET_PEER_RELIABLE_WINDOW_SIZE = 0x1000,
214  ENET_PEER_FREE_RELIABLE_WINDOWS = 8
215 };
216 
217 typedef struct _ENetChannel
218 {
219  enet_uint16 outgoingReliableSequenceNumber;
220  enet_uint16 outgoingUnreliableSequenceNumber;
221  enet_uint16 usedReliableWindows;
222  enet_uint16 reliableWindows [ENET_PEER_RELIABLE_WINDOWS];
223  enet_uint16 incomingReliableSequenceNumber;
224  enet_uint16 incomingUnreliableSequenceNumber;
225  ENetList incomingReliableCommands;
226  ENetList incomingUnreliableCommands;
227 } ENetChannel;
228 
234 typedef struct _ENetPeer
235 {
236  ENetListNode dispatchList;
237  struct _ENetHost * host;
238  enet_uint16 outgoingPeerID;
239  enet_uint16 incomingPeerID;
240  enet_uint32 connectID;
241  enet_uint8 outgoingSessionID;
242  enet_uint8 incomingSessionID;
244  void * data;
245  ENetPeerState state;
246  ENetChannel * channels;
247  size_t channelCount;
250  enet_uint32 incomingBandwidthThrottleEpoch;
251  enet_uint32 outgoingBandwidthThrottleEpoch;
252  enet_uint32 incomingDataTotal;
253  enet_uint32 outgoingDataTotal;
254  enet_uint32 lastSendTime;
255  enet_uint32 lastReceiveTime;
256  enet_uint32 nextTimeout;
257  enet_uint32 earliestTimeout;
258  enet_uint32 packetLossEpoch;
259  enet_uint32 packetsSent;
260  enet_uint32 packetsLost;
262  enet_uint32 packetLossVariance;
263  enet_uint32 packetThrottle;
264  enet_uint32 packetThrottleLimit;
265  enet_uint32 packetThrottleCounter;
266  enet_uint32 packetThrottleEpoch;
267  enet_uint32 packetThrottleAcceleration;
268  enet_uint32 packetThrottleDeceleration;
269  enet_uint32 packetThrottleInterval;
270  enet_uint32 lastRoundTripTime;
271  enet_uint32 lowestRoundTripTime;
272  enet_uint32 lastRoundTripTimeVariance;
273  enet_uint32 highestRoundTripTimeVariance;
275  enet_uint32 roundTripTimeVariance;
276  enet_uint32 mtu;
277  enet_uint32 windowSize;
278  enet_uint32 reliableDataInTransit;
279  enet_uint16 outgoingReliableSequenceNumber;
280  ENetList acknowledgements;
281  ENetList sentReliableCommands;
282  ENetList sentUnreliableCommands;
283  ENetList outgoingReliableCommands;
284  ENetList outgoingUnreliableCommands;
285  ENetList dispatchedCommands;
286  int needsDispatch;
287  enet_uint16 incomingUnsequencedGroup;
288  enet_uint16 outgoingUnsequencedGroup;
289  enet_uint32 unsequencedWindow [ENET_PEER_UNSEQUENCED_WINDOW_SIZE / 32];
290  enet_uint32 eventData;
291 } ENetPeer;
292 
295 typedef struct _ENetCompressor
296 {
298  void * context;
300  size_t (ENET_CALLBACK * compress) (void * context, const ENetBuffer * inBuffers, size_t inBufferCount, size_t inLimit, enet_uint8 * outData, size_t outLimit);
302  size_t (ENET_CALLBACK * decompress) (void * context, const enet_uint8 * inData, size_t inLimit, enet_uint8 * outData, size_t outLimit);
304  void (ENET_CALLBACK * destroy) (void * context);
306 
308 typedef enet_uint32 (ENET_CALLBACK * ENetChecksumCallback) (const ENetBuffer * buffers, size_t bufferCount);
309 
326 typedef struct _ENetHost
327 {
328  ENetSocket socket;
332  enet_uint32 bandwidthThrottleEpoch;
333  enet_uint32 mtu;
334  enet_uint32 randomSeed;
335  int recalculateBandwidthLimits;
337  size_t peerCount;
338  size_t channelLimit;
339  enet_uint32 serviceTime;
340  ENetList dispatchQueue;
341  int continueSending;
342  size_t packetSize;
343  enet_uint16 headerFlags;
344  ENetProtocol commands [ENET_PROTOCOL_MAXIMUM_PACKET_COMMANDS];
345  size_t commandCount;
346  ENetBuffer buffers [ENET_BUFFER_MAXIMUM];
347  size_t bufferCount;
348  ENetChecksumCallback checksum;
349  ENetCompressor compressor;
350  enet_uint8 packetData [2][ENET_PROTOCOL_MAXIMUM_MTU];
351  ENetAddress receivedAddress;
352  enet_uint8 * receivedData;
353  size_t receivedDataLength;
358 } ENetHost;
359 
363 typedef enum _ENetEventType
364 {
367 
372 
381 
389 } ENetEventType;
390 
396 typedef struct _ENetEvent
397 {
403 } ENetEvent;
404 
414 ENET_API int enet_initialize (void);
415 
423 ENET_API int enet_initialize_with_callbacks (ENetVersion version, const ENetCallbacks * inits);
424 
429 ENET_API void enet_deinitialize (void);
430 
439 ENET_API enet_uint32 enet_time_get (void);
443 ENET_API void enet_time_set (enet_uint32);
444 
448 ENET_API ENetSocket enet_socket_create (ENetSocketType);
449 ENET_API int enet_socket_bind (ENetSocket, const ENetAddress *);
450 ENET_API int enet_socket_listen (ENetSocket, int);
451 ENET_API ENetSocket enet_socket_accept (ENetSocket, ENetAddress *);
452 ENET_API int enet_socket_connect (ENetSocket, const ENetAddress *);
453 ENET_API int enet_socket_send (ENetSocket, const ENetAddress *, const ENetBuffer *, size_t);
454 ENET_API int enet_socket_receive (ENetSocket, ENetAddress *, ENetBuffer *, size_t);
455 ENET_API int enet_socket_wait (ENetSocket, enet_uint32 *, enet_uint32);
456 ENET_API int enet_socket_set_option (ENetSocket, ENetSocketOption, int);
457 ENET_API void enet_socket_destroy (ENetSocket);
458 ENET_API int enet_socketset_select (ENetSocket, ENetSocketSet *, ENetSocketSet *, enet_uint32);
459 
473 ENET_API int enet_address_set_host (ENetAddress * address, const char * hostName);
474 
483 ENET_API int enet_address_get_host_ip (const ENetAddress * address, char * hostName, size_t nameLength);
484 
493 ENET_API int enet_address_get_host (const ENetAddress * address, char * hostName, size_t nameLength);
494 
497 ENET_API ENetPacket * enet_packet_create (const void *, size_t, enet_uint32);
498 ENET_API void enet_packet_destroy (ENetPacket *);
499 ENET_API int enet_packet_resize (ENetPacket *, size_t);
500 extern enet_uint32 enet_crc32 (const ENetBuffer *, size_t);
501 
502 ENET_API ENetHost * enet_host_create (const ENetAddress *, size_t, size_t, enet_uint32, enet_uint32);
503 ENET_API void enet_host_destroy (ENetHost *);
504 ENET_API ENetPeer * enet_host_connect (ENetHost *, const ENetAddress *, size_t, enet_uint32);
505 ENET_API int enet_host_check_events (ENetHost *, ENetEvent *);
506 ENET_API int enet_host_service (ENetHost *, ENetEvent *, enet_uint32);
507 ENET_API void enet_host_flush (ENetHost *);
508 ENET_API void enet_host_broadcast (ENetHost *, enet_uint8, ENetPacket *);
509 ENET_API void enet_host_compress (ENetHost *, const ENetCompressor *);
510 ENET_API int enet_host_compress_with_range_coder (ENetHost * host);
511 ENET_API void enet_host_channel_limit (ENetHost *, size_t);
513 extern void enet_host_bandwidth_throttle (ENetHost *);
514 
515 ENET_API int enet_peer_send (ENetPeer *, enet_uint8, ENetPacket *);
516 ENET_API ENetPacket * enet_peer_receive (ENetPeer *, enet_uint8 * channelID);
517 ENET_API void enet_peer_ping (ENetPeer *);
518 ENET_API void enet_peer_reset (ENetPeer *);
519 ENET_API void enet_peer_disconnect (ENetPeer *, enet_uint32);
523 extern int enet_peer_throttle (ENetPeer *, enet_uint32);
524 extern void enet_peer_reset_queues (ENetPeer *);
525 extern void enet_peer_setup_outgoing_command (ENetPeer *, ENetOutgoingCommand *);
526 extern ENetOutgoingCommand * enet_peer_queue_outgoing_command (ENetPeer *, const ENetProtocol *, ENetPacket *, enet_uint32, enet_uint16);
527 extern ENetIncomingCommand * enet_peer_queue_incoming_command (ENetPeer *, const ENetProtocol *, ENetPacket *, enet_uint32);
528 extern ENetAcknowledgement * enet_peer_queue_acknowledgement (ENetPeer *, const ENetProtocol *, enet_uint16);
529 extern void enet_peer_dispatch_incoming_unreliable_commands (ENetPeer *, ENetChannel *);
530 extern void enet_peer_dispatch_incoming_reliable_commands (ENetPeer *, ENetChannel *);
531 
532 ENET_API void * enet_range_coder_create (void);
533 ENET_API void enet_range_coder_destroy (void *);
534 ENET_API size_t enet_range_coder_compress (void *, const ENetBuffer *, size_t, size_t, enet_uint8 *, size_t);
535 ENET_API size_t enet_range_coder_decompress (void *, const enet_uint8 *, size_t, enet_uint8 *, size_t);
536 
537 extern size_t enet_protocol_command_size (enet_uint8);
538 
539 #ifdef __cplusplus
540 }
541 #endif
542 
543 #endif /* __ENET_ENET_H__ */
544