ENet public header file. More...

#include <stdlib.h>
#include "enet/unix.h"
#include "enet/types.h"
#include "enet/protocol.h"
#include "enet/list.h"
#include "enet/callbacks.h"

Classes
struct	_ENetAcknowledgement

struct	_ENetAddress
	Portable internet address structure. More...

struct	_ENetChannel

struct	_ENetCompressor
	An ENet packet compressor for compressing UDP packets before socket sends or receives. More...

struct	_ENetEvent
	An ENet event as returned by enet_host_service(). More...

struct	_ENetHost
	An ENet host for communicating with peers. More...

struct	_ENetHostAddress

struct	_ENetIncomingCommand

struct	_ENetOutgoingCommand

struct	_ENetPacket
	ENet packet structure. More...

struct	_ENetPeer
	An ENet peer which data packets may be sent or received from. More...

Macros
#define	ENET_BUFFER_MAXIMUM (1 + 2 * ENET_PROTOCOL_MAXIMUM_PACKET_COMMANDS)

#define	ENET_HOST_ANY_INIT { { 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0 } }
	specifies the default server host (macro for variable initialization) More...

#define	ENET_HOST_BROADCAST_INIT { { 0,0,0,0,0,0,0,0,0,0,0xff,0xff,0xff,0xff,0xff,0xff } }
	specifies a IPv4 subnet-wide broadcast (macro for variable initialization) More...

#define	ENET_IPV4MAPPED_PREFIX_INIT { { 0,0,0,0,0,0,0,0,0,0,0xff,0xff,0,0,0,0 } }
	specifies the IPv4-mapped IPv6 prefix (macro for variable initialization) More...

#define	ENET_VERSION ENET_VERSION_CREATE(ENET_VERSION_MAJOR, ENET_VERSION_MINOR, ENET_VERSION_PATCH)

#define	ENET_VERSION_CREATE(major, minor, patch) (((major)<<16) \| ((minor)<<8) \| (patch))

#define	ENET_VERSION_MAJOR 1

#define	ENET_VERSION_MINOR 3

#define	ENET_VERSION_PATCH 1

Typedefs
typedef size_t	bufferCount

typedef struct _ENetAcknowledgement	ENetAcknowledgement

typedef struct _ENetAddress	ENetAddress
	Portable internet address structure. More...

typedef enum _ENetAddressFamily	ENetAddressFamily
	The address family type. More...

typedef struct _ENetChannel	ENetChannel

typedef struct _ENetCompressor	ENetCompressor
	An ENet packet compressor for compressing UDP packets before socket sends or receives. More...

typedef struct _ENetEvent	ENetEvent
	An ENet event as returned by enet_host_service(). More...

typedef enum _ENetEventType	ENetEventType
	An ENet event type, as specified in ENetEvent. More...

typedef struct _ENetHost	ENetHost
	An ENet host for communicating with peers. More...

typedef struct _ENetHostAddress	ENetHostAddress

typedef struct _ENetIncomingCommand	ENetIncomingCommand

typedef struct _ENetOutgoingCommand	ENetOutgoingCommand

typedef struct _ENetPacket	ENetPacket
	ENet packet structure. More...

typedef enum _ENetPacketFlag	ENetPacketFlag
	Packet flag bit constants. More...

typedef struct _ENetPeer	ENetPeer
	An ENet peer which data packets may be sent or received from. More...

typedef enum _ENetPeerState	ENetPeerState

typedef enum _ENetSocketOption	ENetSocketOption

typedef enum _ENetSocketType	ENetSocketType

typedef enum _ENetSocketWait	ENetSocketWait

typedef enet_uint32	ENetVersion

Enumerations
enum	{ ENET_IPV4MAPPED_PREFIX_LEN = 12, ENET_PORT_ANY = 0 }

enum	{ ENET_HOST_RECEIVE_BUFFER_SIZE = 256 * 1024, ENET_HOST_SEND_BUFFER_SIZE = 256 * 1024, ENET_HOST_BANDWIDTH_THROTTLE_INTERVAL = 1000, ENET_HOST_DEFAULT_MTU = 1400, ENET_PEER_DEFAULT_ROUND_TRIP_TIME = 500, ENET_PEER_DEFAULT_PACKET_THROTTLE = 32, ENET_PEER_PACKET_THROTTLE_SCALE = 32, ENET_PEER_PACKET_THROTTLE_COUNTER = 7, ENET_PEER_PACKET_THROTTLE_ACCELERATION = 2, ENET_PEER_PACKET_THROTTLE_DECELERATION = 2, ENET_PEER_PACKET_THROTTLE_INTERVAL = 5000, ENET_PEER_PACKET_LOSS_SCALE = (1 << 16), ENET_PEER_PACKET_LOSS_INTERVAL = 10000, ENET_PEER_WINDOW_SIZE_SCALE = 64 * 1024, ENET_PEER_TIMEOUT_LIMIT = 32, ENET_PEER_TIMEOUT_MINIMUM = 5000, ENET_PEER_TIMEOUT_MAXIMUM = 30000, ENET_PEER_PING_INTERVAL = 500, ENET_PEER_UNSEQUENCED_WINDOWS = 64, ENET_PEER_UNSEQUENCED_WINDOW_SIZE = 1024, ENET_PEER_FREE_UNSEQUENCED_WINDOWS = 32, ENET_PEER_RELIABLE_WINDOWS = 16, ENET_PEER_RELIABLE_WINDOW_SIZE = 0x1000, ENET_PEER_FREE_RELIABLE_WINDOWS = 8 }

enum	_ENetAddressFamily { ENET_NO_ADDRESS_FAMILY = 0, ENET_IPV4 = (1 << 0), ENET_IPV6 = (1 << 1) }
	The address family type. More...

enum	_ENetEventType { ENET_EVENT_TYPE_NONE = 0, ENET_EVENT_TYPE_CONNECT = 1, ENET_EVENT_TYPE_DISCONNECT = 2, ENET_EVENT_TYPE_RECEIVE = 3 }
	An ENet event type, as specified in ENetEvent. More...

enum	_ENetPacketFlag { ENET_PACKET_FLAG_RELIABLE = (1 << 0), ENET_PACKET_FLAG_UNSEQUENCED = (1 << 1), ENET_PACKET_FLAG_NO_ALLOCATE = (1 << 2) }
	Packet flag bit constants. More...

enum	_ENetPeerState { ENET_PEER_STATE_DISCONNECTED = 0, ENET_PEER_STATE_CONNECTING = 1, ENET_PEER_STATE_ACKNOWLEDGING_CONNECT = 2, ENET_PEER_STATE_CONNECTION_PENDING = 3, ENET_PEER_STATE_CONNECTION_SUCCEEDED = 4, ENET_PEER_STATE_CONNECTED = 5, ENET_PEER_STATE_DISCONNECT_LATER = 6, ENET_PEER_STATE_DISCONNECTING = 7, ENET_PEER_STATE_ACKNOWLEDGING_DISCONNECT = 8, ENET_PEER_STATE_ZOMBIE = 9 }

enum	_ENetSocketOption { ENET_SOCKOPT_NONBLOCK = 1, ENET_SOCKOPT_BROADCAST = 2, ENET_SOCKOPT_RCVBUF = 3, ENET_SOCKOPT_SNDBUF = 4, ENET_SOCKOPT_REUSEADDR = 5 }

enum	_ENetSocketType { ENET_SOCKET_TYPE_STREAM = 1, ENET_SOCKET_TYPE_DATAGRAM = 2 }

enum	_ENetSocketWait { ENET_SOCKET_WAIT_NONE = 0, ENET_SOCKET_WAIT_SEND = (1 << 0), ENET_SOCKET_WAIT_RECEIVE = (1 << 1) }

Functions
ENET_API int	enet_address_get_host (const ENetAddress address, char hostName, size_t nameLength)
	Attempts to do a reverse lookup of the host field in the address parameter. More...

ENET_API int	enet_address_get_host_ip (const ENetAddress address, char hostName, size_t nameLength)
	Gives the printable form of the ip address specified in the address parameter. More...

ENET_API ENetHostAddress	enet_address_map4 (enet_uint32 address)
	Maps an IPv4 Address to an IPv6 address. More...

ENET_API int	enet_address_set_host (ENetAddress address, const char hostName)
	Attempts to resolve the host named by the parameter hostName and sets the host field in the address parameter if successful. More...

enet_uint32	enet_crc32 (const ENetBuffer *, size_t)

ENET_API void	enet_deinitialize (void)
	Shuts down ENet globally. More...

ENET_API ENetAddressFamily	enet_get_address_family (const ENetAddress *address)
	Returns the Address family of an (IPv4-mapped) IPv6 address. More...

ENET_API void	enet_host_bandwidth_limit (ENetHost *, enet_uint32, enet_uint32)
	Adjusts the bandwidth limits of a host. More...

void	enet_host_bandwidth_throttle (ENetHost *)

ENET_API void	enet_host_broadcast (ENetHost , enet_uint8, ENetPacket )
	Queues a packet to be sent to all peers associated with the host. More...

ENET_API void	enet_host_channel_limit (ENetHost *, size_t)
	Limits the maximum allowed channels of future incoming connections. More...

ENET_API int	enet_host_check_events (ENetHost , ENetEvent )
	Checks for any queued events on the host and dispatches one if available. More...

ENET_API void	enet_host_compress (ENetHost , const ENetCompressor )
	Sets the packet compressor the host should use to compress and decompress packets. More...

ENET_API int	enet_host_compress_with_range_coder (ENetHost *host)
	Sets the packet compressor the host should use to the default range coder. More...

ENET_API ENetPeer *	enet_host_connect (ENetHost , const ENetAddress , size_t, enet_uint32)
	Initiates a connection to a foreign host. More...

ENET_API ENetHost *	enet_host_create (const ENetAddress *, size_t, size_t, enet_uint32, enet_uint32)
	Creates a host for communicating to peers. More...

ENET_API void	enet_host_destroy (ENetHost *)
	Destroys the host and all resources associated with it. More...

ENET_API void	enet_host_flush (ENetHost *)
	Sends any queued packets on the host specified to its designated peers. More...

ENET_API int	enet_host_service (ENetHost , ENetEvent , enet_uint32)
	Waits for events on the host specified and shuttles packets between the host and its peers. More...

ENET_API int	enet_initialize (void)
	Initializes ENet globally. More...

ENET_API int	enet_initialize_with_callbacks (ENetVersion version, const ENetCallbacks *inits)
	Initializes ENet globally and supplies user-overridden callbacks. More...

ENET_API ENetPacket *	enet_packet_create (const void *, size_t, enet_uint32)
	Creates a packet that may be sent to a peer. More...

ENET_API void	enet_packet_destroy (ENetPacket *)
	Destroys the packet and deallocates its data. More...

ENET_API int	enet_packet_resize (ENetPacket *, size_t)
	Attempts to resize the data in the packet to length specified in the dataLength parameter. More...

ENET_API void	enet_peer_disconnect (ENetPeer *, enet_uint32)
	Request a disconnection from a peer. More...

ENET_API void	enet_peer_disconnect_later (ENetPeer *, enet_uint32)
	Request a disconnection from a peer, but only after all queued outgoing packets are sent. More...

ENET_API void	enet_peer_disconnect_now (ENetPeer *, enet_uint32)
	Force an immediate disconnection from a peer. More...

void	enet_peer_dispatch_incoming_reliable_commands (ENetPeer , ENetChannel )

void	enet_peer_dispatch_incoming_unreliable_commands (ENetPeer , ENetChannel )

ENET_API void	enet_peer_ping (ENetPeer *)
	Sends a ping request to a peer. More...

ENetAcknowledgement *	enet_peer_queue_acknowledgement (ENetPeer , const ENetProtocol , enet_uint16)

ENetIncomingCommand *	enet_peer_queue_incoming_command (ENetPeer , const ENetProtocol , ENetPacket *, enet_uint32)

ENetOutgoingCommand *	enet_peer_queue_outgoing_command (ENetPeer , const ENetProtocol , ENetPacket *, enet_uint32, enet_uint16)

ENET_API ENetPacket *	enet_peer_receive (ENetPeer , enet_uint8 channelID)
	Attempts to dequeue any incoming queued packet. More...

ENET_API void	enet_peer_reset (ENetPeer *)
	Forcefully disconnects a peer. More...

void	enet_peer_reset_queues (ENetPeer *)

ENET_API int	enet_peer_send (ENetPeer , enet_uint8, ENetPacket )
	Queues a packet to be sent. More...

void	enet_peer_setup_outgoing_command (ENetPeer , ENetOutgoingCommand )

int	enet_peer_throttle (ENetPeer *, enet_uint32)

ENET_API void	enet_peer_throttle_configure (ENetPeer *, enet_uint32, enet_uint32, enet_uint32)
	Configures throttle parameter for a peer. More...

size_t	enet_protocol_command_size (enet_uint8)

ENET_API size_t	enet_range_coder_compress (void , const ENetBuffer , size_t, size_t, enet_uint8 *, size_t)

ENET_API void *	enet_range_coder_create (void)

ENET_API size_t	enet_range_coder_decompress (void , const enet_uint8 , size_t, enet_uint8 *, size_t)

ENET_API void	enet_range_coder_destroy (void *)

ENET_API ENetSocket	enet_socket_accept (ENetSocket, ENetAddress *, ENetAddressFamily)

ENET_API int	enet_socket_bind (ENetSocket, const ENetAddress *, ENetAddressFamily)

ENET_API int	enet_socket_connect (ENetSocket, const ENetAddress *, ENetAddressFamily)

ENET_API ENetSocket	enet_socket_create (ENetSocketType, ENetAddressFamily)

ENET_API void	enet_socket_destroy (ENetSocket)

ENET_API int	enet_socket_listen (ENetSocket, int)

ENET_API int	enet_socket_receive (ENetSocket, ENetAddress , ENetBuffer , size_t, ENetAddressFamily)

ENET_API int	enet_socket_send (ENetSocket, const ENetAddress , const ENetBuffer , size_t, ENetAddressFamily)

ENET_API int	enet_socket_set_option (ENetSocket, ENetSocketOption, int)

ENET_API int	enet_socket_wait (ENetSocket, ENetSocket, enet_uint32 *, enet_uint32)

ENET_API int	enet_socketset_select (ENetSocket, ENetSocketSet , ENetSocketSet , enet_uint32)

ENET_API enet_uint32	enet_time_get (void)
	Returns the wall-time in milliseconds. More...

ENET_API void	enet_time_set (enet_uint32)
	Sets the current wall-time in milliseconds. More...

typedef	enet_uint32 (ENET_CALLBACK ENetChecksumCallback)(const ENetBuffer buffers
	Callback that computes the checksum of the data held in buffers[0:bufferCount-1]. More...

typedef	void (ENET_CALLBACK ENetPacketFreeCallback)(struct _ENetPacket )

Variables
static const ENetHostAddress	ENET_HOST_ANY = ENET_HOST_ANY_INIT
	specifies the default server host (global constant variable) More...

static const ENetHostAddress	ENET_HOST_BROADCAST = ENET_HOST_BROADCAST_INIT
	specifies a IPv4 subnet-wide broadcast (global constant variable) More...

static const ENetHostAddress	ENET_IPV4MAPPED_PREFIX = ENET_IPV4MAPPED_PREFIX_INIT
	specifies the IPv4-mapped IPv6 prefix (global constant variable) More...

Detailed Description

ENet public header file.

Macro Definition Documentation

#define ENET_BUFFER_MAXIMUM (1 + 2 * ENET_PROTOCOL_MAXIMUM_PACKET_COMMANDS)

#define ENET_HOST_ANY_INIT { { 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0 } }

specifies the default server host (macro for variable initialization)

#define ENET_HOST_BROADCAST_INIT { { 0,0,0,0,0,0,0,0,0,0,0xff,0xff,0xff,0xff,0xff,0xff } }

specifies a IPv4 subnet-wide broadcast (macro for variable initialization)

#define ENET_IPV4MAPPED_PREFIX_INIT { { 0,0,0,0,0,0,0,0,0,0,0xff,0xff,0,0,0,0 } }

specifies the IPv4-mapped IPv6 prefix (macro for variable initialization)

#define ENET_VERSION ENET_VERSION_CREATE(ENET_VERSION_MAJOR, ENET_VERSION_MINOR, ENET_VERSION_PATCH)

#define ENET_VERSION_CREATE	(	major,
		minor,
		patch
	)	(((major)<<16) \| ((minor)<<8) \| (patch))

#define ENET_VERSION_MAJOR 1

#define ENET_VERSION_MINOR 3

#define ENET_VERSION_PATCH 1

Typedef Documentation

typedef size_t bufferCount

typedef struct _ENetAcknowledgement ENetAcknowledgement

typedef struct _ENetAddress ENetAddress

Portable internet address structure.

The 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.

typedef enum _ENetAddressFamily ENetAddressFamily

The address family type.

typedef struct _ENetChannel ENetChannel

typedef struct _ENetCompressor ENetCompressor

An ENet packet compressor for compressing UDP packets before socket sends or receives.

typedef struct _ENetEvent ENetEvent

An ENet event as returned by enet_host_service().

See also: enet_host_service

typedef enum _ENetEventType ENetEventType

An ENet event type, as specified in ENetEvent.

typedef struct _ENetHost ENetHost

An ENet host for communicating with peers.

No fields should be modified unless otherwise stated.

See also: enet_host_create(); enet_host_destroy(); enet_host_connect(); enet_host_service(); enet_host_flush(); enet_host_broadcast(); enet_host_compress(); enet_host_compress_with_range_coder(); enet_host_channel_limit(); enet_host_bandwidth_limit(); enet_host_bandwidth_throttle()

typedef struct _ENetHostAddress ENetHostAddress

typedef struct _ENetIncomingCommand ENetIncomingCommand

typedef struct _ENetOutgoingCommand ENetOutgoingCommand

typedef struct _ENetPacket ENetPacket

ENet packet structure.

An 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:

ENET_PACKET_FLAG_RELIABLE - packet must be received by the target peer and resend attempts should be made until the packet is delivered

ENET_PACKET_FLAG_UNSEQUENCED - packet will not be sequenced with other packets (not supported for reliable packets)

ENET_PACKET_FLAG_NO_ALLOCATE - packet will not allocate data, and user must supply it instead

See also: ENetPacketFlag

typedef enum _ENetPacketFlag ENetPacketFlag

Packet flag bit constants.

The 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.

See also: ENetPacket

typedef struct _ENetPeer ENetPeer

An ENet peer which data packets may be sent or received from.

No fields should be modified unless otherwise specified.

typedef enum _ENetPeerState ENetPeerState

typedef enum _ENetSocketOption ENetSocketOption

typedef enum _ENetSocketType ENetSocketType

typedef enum _ENetSocketWait ENetSocketWait

typedef enet_uint32 ENetVersion

Enumeration Type Documentation

anonymous enum

Enumerator
ENET_IPV4MAPPED_PREFIX_LEN	specifies the length of the IPv4-mapped IPv6 prefix
ENET_PORT_ANY	specifies that a port should be automatically chosen

anonymous enum

Enumerator
ENET_HOST_RECEIVE_BUFFER_SIZE
ENET_HOST_SEND_BUFFER_SIZE
ENET_HOST_BANDWIDTH_THROTTLE_INTERVAL
ENET_HOST_DEFAULT_MTU
ENET_PEER_DEFAULT_ROUND_TRIP_TIME
ENET_PEER_DEFAULT_PACKET_THROTTLE
ENET_PEER_PACKET_THROTTLE_SCALE
ENET_PEER_PACKET_THROTTLE_COUNTER
ENET_PEER_PACKET_THROTTLE_ACCELERATION
ENET_PEER_PACKET_THROTTLE_DECELERATION
ENET_PEER_PACKET_THROTTLE_INTERVAL
ENET_PEER_PACKET_LOSS_SCALE
ENET_PEER_PACKET_LOSS_INTERVAL
ENET_PEER_WINDOW_SIZE_SCALE
ENET_PEER_TIMEOUT_LIMIT
ENET_PEER_TIMEOUT_MINIMUM
ENET_PEER_TIMEOUT_MAXIMUM
ENET_PEER_PING_INTERVAL
ENET_PEER_UNSEQUENCED_WINDOWS
ENET_PEER_UNSEQUENCED_WINDOW_SIZE
ENET_PEER_FREE_UNSEQUENCED_WINDOWS
ENET_PEER_RELIABLE_WINDOWS
ENET_PEER_RELIABLE_WINDOW_SIZE
ENET_PEER_FREE_RELIABLE_WINDOWS

enum _ENetAddressFamily

The address family type.

Enumerator
ENET_NO_ADDRESS_FAMILY
ENET_IPV4
ENET_IPV6

enum _ENetEventType

An ENet event type, as specified in ENetEvent.

Enumerator
ENET_EVENT_TYPE_NONE	no event occurred within the specified time limit
ENET_EVENT_TYPE_CONNECT	a connection request initiated by enet_host_connect has completed. The peer field contains the peer which successfully connected.
ENET_EVENT_TYPE_DISCONNECT	a peer has disconnected. This 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.
ENET_EVENT_TYPE_RECEIVE	a packet has been received from a peer. The 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.

enum _ENetPacketFlag

Packet flag bit constants.

The 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.

See also: ENetPacket

Enumerator
ENET_PACKET_FLAG_RELIABLE	packet must be received by the target peer and resend attempts should be made until the packet is delivered
ENET_PACKET_FLAG_UNSEQUENCED	packet will not be sequenced with other packets not supported for reliable packets
ENET_PACKET_FLAG_NO_ALLOCATE	packet will not allocate data, and user must supply it instead

enum _ENetPeerState

Enumerator
ENET_PEER_STATE_DISCONNECTED
ENET_PEER_STATE_CONNECTING
ENET_PEER_STATE_ACKNOWLEDGING_CONNECT
ENET_PEER_STATE_CONNECTION_PENDING
ENET_PEER_STATE_CONNECTION_SUCCEEDED
ENET_PEER_STATE_CONNECTED
ENET_PEER_STATE_DISCONNECT_LATER
ENET_PEER_STATE_DISCONNECTING
ENET_PEER_STATE_ACKNOWLEDGING_DISCONNECT
ENET_PEER_STATE_ZOMBIE