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 7
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 struct _ENetHost;
35 struct _ENetEvent;
36 struct _ENetPacket;
37 
38 typedef enum _ENetSocketType
39 {
40  ENET_SOCKET_TYPE_STREAM = 1,
41  ENET_SOCKET_TYPE_DATAGRAM = 2
42 } ENetSocketType;
43 
44 typedef enum _ENetSocketWait
45 {
46  ENET_SOCKET_WAIT_NONE = 0,
47  ENET_SOCKET_WAIT_SEND = (1 << 0),
48  ENET_SOCKET_WAIT_RECEIVE = (1 << 1)
49 } ENetSocketWait;
50 
51 typedef enum _ENetSocketOption
52 {
53  ENET_SOCKOPT_NONBLOCK = 1,
54  ENET_SOCKOPT_BROADCAST = 2,
55  ENET_SOCKOPT_RCVBUF = 3,
56  ENET_SOCKOPT_SNDBUF = 4,
57  ENET_SOCKOPT_REUSEADDR = 5,
58  ENET_SOCKOPT_RCVTIMEO = 6,
59  ENET_SOCKOPT_SNDTIMEO = 7
60 } ENetSocketOption;
61 
62 typedef enum _ENetSocketShutdown
63 {
64  ENET_SOCKET_SHUTDOWN_READ = 0,
65  ENET_SOCKET_SHUTDOWN_WRITE = 1,
66  ENET_SOCKET_SHUTDOWN_READ_WRITE = 2
67 } ENetSocketShutdown;
68 
69 enum
70 {
72  ENET_HOST_BROADCAST = 0xFFFFFFFF,
75 };
76 
87 typedef struct _ENetAddress
88 {
89  enet_uint32 host;
90  enet_uint16 port;
91 } ENetAddress;
92 
102 typedef enum _ENetPacketFlag
103 {
116 
120 
121 typedef void (ENET_CALLBACK * ENetPacketFreeCallback) (struct _ENetPacket *);
122 
142 typedef struct _ENetPacket
143 {
144  size_t referenceCount;
147  size_t dataLength;
148  ENetPacketFreeCallback freeCallback;
149  void * userData;
150 } ENetPacket;
151 
152 typedef struct _ENetAcknowledgement
153 {
154  ENetListNode acknowledgementList;
155  enet_uint32 sentTime;
156  ENetProtocol command;
158 
159 typedef struct _ENetOutgoingCommand
160 {
161  ENetListNode outgoingCommandList;
162  enet_uint16 reliableSequenceNumber;
163  enet_uint16 unreliableSequenceNumber;
164  enet_uint32 sentTime;
165  enet_uint32 roundTripTimeout;
166  enet_uint32 roundTripTimeoutLimit;
167  enet_uint32 fragmentOffset;
168  enet_uint16 fragmentLength;
169  enet_uint16 sendAttempts;
170  ENetProtocol command;
171  ENetPacket * packet;
173 
174 typedef struct _ENetIncomingCommand
175 {
176  ENetListNode incomingCommandList;
177  enet_uint16 reliableSequenceNumber;
178  enet_uint16 unreliableSequenceNumber;
179  ENetProtocol command;
180  enet_uint32 fragmentCount;
181  enet_uint32 fragmentsRemaining;
182  enet_uint32 * fragments;
183  ENetPacket * packet;
185 
186 typedef enum _ENetPeerState
187 {
188  ENET_PEER_STATE_DISCONNECTED = 0,
189  ENET_PEER_STATE_CONNECTING = 1,
190  ENET_PEER_STATE_ACKNOWLEDGING_CONNECT = 2,
191  ENET_PEER_STATE_CONNECTION_PENDING = 3,
192  ENET_PEER_STATE_CONNECTION_SUCCEEDED = 4,
193  ENET_PEER_STATE_CONNECTED = 5,
194  ENET_PEER_STATE_DISCONNECT_LATER = 6,
195  ENET_PEER_STATE_DISCONNECTING = 7,
196  ENET_PEER_STATE_ACKNOWLEDGING_DISCONNECT = 8,
197  ENET_PEER_STATE_ZOMBIE = 9
198 } ENetPeerState;
199 
200 #ifndef ENET_BUFFER_MAXIMUM
201 #define ENET_BUFFER_MAXIMUM (1 + 2 * ENET_PROTOCOL_MAXIMUM_PACKET_COMMANDS)
202 #endif
203 
204 enum
205 {
206  ENET_HOST_RECEIVE_BUFFER_SIZE = 256 * 1024,
207  ENET_HOST_SEND_BUFFER_SIZE = 256 * 1024,
208  ENET_HOST_BANDWIDTH_THROTTLE_INTERVAL = 1000,
209  ENET_HOST_DEFAULT_MTU = 1400,
210 
211  ENET_PEER_DEFAULT_ROUND_TRIP_TIME = 500,
212  ENET_PEER_DEFAULT_PACKET_THROTTLE = 32,
213  ENET_PEER_PACKET_THROTTLE_SCALE = 32,
214  ENET_PEER_PACKET_THROTTLE_COUNTER = 7,
215  ENET_PEER_PACKET_THROTTLE_ACCELERATION = 2,
216  ENET_PEER_PACKET_THROTTLE_DECELERATION = 2,
217  ENET_PEER_PACKET_THROTTLE_INTERVAL = 5000,
218  ENET_PEER_PACKET_LOSS_SCALE = (1 << 16),
219  ENET_PEER_PACKET_LOSS_INTERVAL = 10000,
220  ENET_PEER_WINDOW_SIZE_SCALE = 64 * 1024,
221  ENET_PEER_TIMEOUT_LIMIT = 32,
222  ENET_PEER_TIMEOUT_MINIMUM = 5000,
223  ENET_PEER_TIMEOUT_MAXIMUM = 30000,
224  ENET_PEER_PING_INTERVAL = 500,
225  ENET_PEER_UNSEQUENCED_WINDOWS = 64,
226  ENET_PEER_UNSEQUENCED_WINDOW_SIZE = 1024,
227  ENET_PEER_FREE_UNSEQUENCED_WINDOWS = 32,
228  ENET_PEER_RELIABLE_WINDOWS = 16,
229  ENET_PEER_RELIABLE_WINDOW_SIZE = 0x1000,
230  ENET_PEER_FREE_RELIABLE_WINDOWS = 8
231 };
232 
233 typedef struct _ENetChannel
234 {
235  enet_uint16 outgoingReliableSequenceNumber;
236  enet_uint16 outgoingUnreliableSequenceNumber;
237  enet_uint16 usedReliableWindows;
238  enet_uint16 reliableWindows [ENET_PEER_RELIABLE_WINDOWS];
239  enet_uint16 incomingReliableSequenceNumber;
240  enet_uint16 incomingUnreliableSequenceNumber;
241  ENetList incomingReliableCommands;
242  ENetList incomingUnreliableCommands;
243 } ENetChannel;
244 
250 typedef struct _ENetPeer
251 {
252  ENetListNode dispatchList;
253  struct _ENetHost * host;
254  enet_uint16 outgoingPeerID;
255  enet_uint16 incomingPeerID;
256  enet_uint32 connectID;
257  enet_uint8 outgoingSessionID;
258  enet_uint8 incomingSessionID;
260  void * data;
261  ENetPeerState state;
262  ENetChannel * channels;
263  size_t channelCount;
266  enet_uint32 incomingBandwidthThrottleEpoch;
267  enet_uint32 outgoingBandwidthThrottleEpoch;
268  enet_uint32 incomingDataTotal;
269  enet_uint32 outgoingDataTotal;
270  enet_uint32 lastSendTime;
271  enet_uint32 lastReceiveTime;
272  enet_uint32 nextTimeout;
273  enet_uint32 earliestTimeout;
274  enet_uint32 packetLossEpoch;
275  enet_uint32 packetsSent;
276  enet_uint32 packetsLost;
278  enet_uint32 packetLossVariance;
279  enet_uint32 packetThrottle;
280  enet_uint32 packetThrottleLimit;
281  enet_uint32 packetThrottleCounter;
282  enet_uint32 packetThrottleEpoch;
283  enet_uint32 packetThrottleAcceleration;
284  enet_uint32 packetThrottleDeceleration;
285  enet_uint32 packetThrottleInterval;
286  enet_uint32 pingInterval;
287  enet_uint32 timeoutLimit;
288  enet_uint32 timeoutMinimum;
289  enet_uint32 timeoutMaximum;
290  enet_uint32 lastRoundTripTime;
291  enet_uint32 lowestRoundTripTime;
292  enet_uint32 lastRoundTripTimeVariance;
293  enet_uint32 highestRoundTripTimeVariance;
295  enet_uint32 roundTripTimeVariance;
296  enet_uint32 mtu;
297  enet_uint32 windowSize;
298  enet_uint32 reliableDataInTransit;
299  enet_uint16 outgoingReliableSequenceNumber;
300  ENetList acknowledgements;
301  ENetList sentReliableCommands;
302  ENetList sentUnreliableCommands;
303  ENetList outgoingReliableCommands;
304  ENetList outgoingUnreliableCommands;
305  ENetList dispatchedCommands;
306  int needsDispatch;
307  enet_uint16 incomingUnsequencedGroup;
308  enet_uint16 outgoingUnsequencedGroup;
309  enet_uint32 unsequencedWindow [ENET_PEER_UNSEQUENCED_WINDOW_SIZE / 32];
310  enet_uint32 eventData;
311 } ENetPeer;
312 
315 typedef struct _ENetCompressor
316 {
318  void * context;
320  size_t (ENET_CALLBACK * compress) (void * context, const ENetBuffer * inBuffers, size_t inBufferCount, size_t inLimit, enet_uint8 * outData, size_t outLimit);
322  size_t (ENET_CALLBACK * decompress) (void * context, const enet_uint8 * inData, size_t inLimit, enet_uint8 * outData, size_t outLimit);
324  void (ENET_CALLBACK * destroy) (void * context);
326 
328 typedef enet_uint32 (ENET_CALLBACK * ENetChecksumCallback) (const ENetBuffer * buffers, size_t bufferCount);
329 
331 typedef int (ENET_CALLBACK * ENetInterceptCallback) (struct _ENetHost * host, struct _ENetEvent * event);
332 
349 typedef struct _ENetHost
350 {
351  ENetSocket socket;
355  enet_uint32 bandwidthThrottleEpoch;
356  enet_uint32 mtu;
357  enet_uint32 randomSeed;
358  int recalculateBandwidthLimits;
360  size_t peerCount;
361  size_t channelLimit;
362  enet_uint32 serviceTime;
363  ENetList dispatchQueue;
364  int continueSending;
365  size_t packetSize;
366  enet_uint16 headerFlags;
367  ENetProtocol commands [ENET_PROTOCOL_MAXIMUM_PACKET_COMMANDS];
368  size_t commandCount;
369  ENetBuffer buffers [ENET_BUFFER_MAXIMUM];
370  size_t bufferCount;
371  ENetChecksumCallback checksum;
372  ENetCompressor compressor;
373  enet_uint8 packetData [2][ENET_PROTOCOL_MAXIMUM_MTU];
374  ENetAddress receivedAddress;
375  enet_uint8 * receivedData;
376  size_t receivedDataLength;
381  ENetInterceptCallback intercept;
382 } ENetHost;
383 
387 typedef enum _ENetEventType
388 {
391 
396 
405 
413 } ENetEventType;
414 
420 typedef struct _ENetEvent
421 {
427 } ENetEvent;
428 
438 ENET_API int enet_initialize (void);
439 
447 ENET_API int enet_initialize_with_callbacks (ENetVersion version, const ENetCallbacks * inits);
448 
453 ENET_API void enet_deinitialize (void);
454 
463 ENET_API enet_uint32 enet_time_get (void);
467 ENET_API void enet_time_set (enet_uint32);
468 
472 ENET_API ENetSocket enet_socket_create (ENetSocketType);
473 ENET_API int enet_socket_bind (ENetSocket, const ENetAddress *);
474 ENET_API int enet_socket_listen (ENetSocket, int);
475 ENET_API ENetSocket enet_socket_accept (ENetSocket, ENetAddress *);
476 ENET_API int enet_socket_connect (ENetSocket, const ENetAddress *);
477 ENET_API int enet_socket_send (ENetSocket, const ENetAddress *, const ENetBuffer *, size_t);
478 ENET_API int enet_socket_receive (ENetSocket, ENetAddress *, ENetBuffer *, size_t);
479 ENET_API int enet_socket_wait (ENetSocket, enet_uint32 *, enet_uint32);
480 ENET_API int enet_socket_set_option (ENetSocket, ENetSocketOption, int);
481 ENET_API int enet_socket_shutdown (ENetSocket, ENetSocketShutdown);
482 ENET_API void enet_socket_destroy (ENetSocket);
483 ENET_API int enet_socketset_select (ENetSocket, ENetSocketSet *, ENetSocketSet *, enet_uint32);
484 
498 ENET_API int enet_address_set_host (ENetAddress * address, const char * hostName);
499 
508 ENET_API int enet_address_get_host_ip (const ENetAddress * address, char * hostName, size_t nameLength);
509 
518 ENET_API int enet_address_get_host (const ENetAddress * address, char * hostName, size_t nameLength);
519 
522 ENET_API ENetPacket * enet_packet_create (const void *, size_t, enet_uint32);
523 ENET_API void enet_packet_destroy (ENetPacket *);
524 ENET_API int enet_packet_resize (ENetPacket *, size_t);
525 ENET_API enet_uint32 enet_crc32 (const ENetBuffer *, size_t);
526 
527 ENET_API ENetHost * enet_host_create (const ENetAddress *, size_t, size_t, enet_uint32, enet_uint32);
528 ENET_API void enet_host_destroy (ENetHost *);
529 ENET_API ENetPeer * enet_host_connect (ENetHost *, const ENetAddress *, size_t, enet_uint32);
530 ENET_API int enet_host_check_events (ENetHost *, ENetEvent *);
531 ENET_API int enet_host_service (ENetHost *, ENetEvent *, enet_uint32);
532 ENET_API void enet_host_flush (ENetHost *);
533 ENET_API void enet_host_broadcast (ENetHost *, enet_uint8, ENetPacket *);
534 ENET_API void enet_host_compress (ENetHost *, const ENetCompressor *);
535 ENET_API int enet_host_compress_with_range_coder (ENetHost * host);
536 ENET_API void enet_host_channel_limit (ENetHost *, size_t);
538 extern void enet_host_bandwidth_throttle (ENetHost *);
539 
540 ENET_API int enet_peer_send (ENetPeer *, enet_uint8, ENetPacket *);
541 ENET_API ENetPacket * enet_peer_receive (ENetPeer *, enet_uint8 * channelID);
542 ENET_API void enet_peer_ping (ENetPeer *);
543 ENET_API void enet_peer_ping_interval (ENetPeer *, enet_uint32);
545 ENET_API void enet_peer_reset (ENetPeer *);
546 ENET_API void enet_peer_disconnect (ENetPeer *, enet_uint32);
550 extern int enet_peer_throttle (ENetPeer *, enet_uint32);
551 extern void enet_peer_reset_queues (ENetPeer *);
552 extern void enet_peer_setup_outgoing_command (ENetPeer *, ENetOutgoingCommand *);
553 extern ENetOutgoingCommand * enet_peer_queue_outgoing_command (ENetPeer *, const ENetProtocol *, ENetPacket *, enet_uint32, enet_uint16);
554 extern ENetIncomingCommand * enet_peer_queue_incoming_command (ENetPeer *, const ENetProtocol *, ENetPacket *, enet_uint32);
555 extern ENetAcknowledgement * enet_peer_queue_acknowledgement (ENetPeer *, const ENetProtocol *, enet_uint16);
556 extern void enet_peer_dispatch_incoming_unreliable_commands (ENetPeer *, ENetChannel *);
557 extern void enet_peer_dispatch_incoming_reliable_commands (ENetPeer *, ENetChannel *);
558 
559 ENET_API void * enet_range_coder_create (void);
560 ENET_API void enet_range_coder_destroy (void *);
561 ENET_API size_t enet_range_coder_compress (void *, const ENetBuffer *, size_t, size_t, enet_uint8 *, size_t);
562 ENET_API size_t enet_range_coder_decompress (void *, const enet_uint8 *, size_t, enet_uint8 *, size_t);
563 
564 extern size_t enet_protocol_command_size (enet_uint8);
565 
566 #ifdef __cplusplus
567 }
568 #endif
569 
570 #endif /* __ENET_ENET_H__ */
571