parin.bindings.enet

The enet module provides access to the ENet networking library. These bindings match the ENet v1.3.18 release. The low level socket functions (enet_socket_*) are not included.

var ENET_BUFFER_MAXIMUM ENET_HOST_ANY ENET_HOST_BROADCAST ENET_PORT_ANY ENET_VERSION ENET_VERSION_MAJOR ENET_VERSION_MINOR ENET_VERSION_PATCH
alias enet_uint16 enet_uint32 enet_uint8 ENetChecksumCallback ENetEventType ENetInterceptCallback ENetPacketFlag ENetPacketFreeCallback ENetPeerFlag ENetPeerState ENetSocketOption ENetSocketShutdown ENetSocketType ENetSocketWait ENetVersion
struct ENetAddress ENetCallbacks ENetChannel ENetCompressor ENetEvent ENetHost ENetList ENetListNode ENetPacket ENetPeer ENetProtocol
fn enet_address_get_host enet_address_get_host_ip enet_address_set_host enet_address_set_host_ip enet_crc32 enet_deinitialize enet_host_bandwidth_limit enet_host_broadcast enet_host_channel_limit enet_host_check_events enet_host_compress enet_host_compress_with_range_coder enet_host_connect enet_host_create enet_host_destroy enet_host_flush enet_host_service enet_initialize enet_initialize_with_callbacks enet_linked_version enet_packet_create enet_packet_destroy enet_packet_resize enet_peer_disconnect enet_peer_disconnect_later enet_peer_disconnect_now enet_peer_ping enet_peer_ping_interval enet_peer_receive enet_peer_reset enet_peer_send enet_peer_throttle_configure enet_peer_timeout enet_range_coder_compress enet_range_coder_create enet_range_coder_decompress enet_range_coder_destroy enet_time_get enet_time_set

Types 26

aliasenet_uint8 = ubyte
aliasenet_uint16 = ushort
aliasenet_uint32 = uint
aliasENetVersion = enet_uint32
aliasENetSocketType = int
aliasENetSocketWait = int
aliasENetSocketOption = int
aliasENetSocketShutdown = int
aliasENetPacketFlag = int
aliasENetPeerState = int
aliasENetPeerFlag = int
aliasENetEventType = int
aliasENetPacketFreeCallback = void function(ENetPacket * packet)
aliasENetChecksumCallback = enet_uint32 function(const(ENetBuffer) * buffers, size_t bufferCount)
aliasENetInterceptCallback = int function(ENetHost * host, ENetEvent * event)
structENetAddress
Fields
enet_uint32 host
enet_uint16 port
structENetListNode
Fields
ENetListNode * next
ENetListNode * previous
structENetList
Fields
ENetListNode sentinel
structENetCallbacks
Fields
void * function(size_t size) malloc
void function(void * memory) free
void function() no_memory
structENetPacket
Fields
size_t referenceCount
enet_uint32 flags
enet_uint8 * data
size_t dataLength
ENetPacketFreeCallback freeCallback
void * userData
structENetProtocol

A packed protocol command. Only used internally, so its contents are not exposed.

Fields
enet_uint8[48] data
structENetChannel
Fields
enet_uint16 outgoingReliableSequenceNumber
enet_uint16 outgoingUnreliableSequenceNumber
enet_uint16 usedReliableWindows
enet_uint16[ENET_PEER_RELIABLE_WINDOWS] reliableWindows
enet_uint16 incomingReliableSequenceNumber
enet_uint16 incomingUnreliableSequenceNumber
ENetList incomingReliableCommands
ENetList incomingUnreliableCommands
structENetPeer
Fields
ENetListNode dispatchList
ENetHost * host
enet_uint16 outgoingPeerID
enet_uint16 incomingPeerID
enet_uint32 connectID
enet_uint8 outgoingSessionID
enet_uint8 incomingSessionID
ENetAddress address
void * data
ENetPeerState state
ENetChannel * channels
size_t channelCount
enet_uint32 incomingBandwidth
enet_uint32 outgoingBandwidth
enet_uint32 incomingBandwidthThrottleEpoch
enet_uint32 outgoingBandwidthThrottleEpoch
enet_uint32 incomingDataTotal
enet_uint32 outgoingDataTotal
enet_uint32 lastSendTime
enet_uint32 lastReceiveTime
enet_uint32 nextTimeout
enet_uint32 earliestTimeout
enet_uint32 packetLossEpoch
enet_uint32 packetsSent
enet_uint32 packetsLost
enet_uint32 packetLoss
enet_uint32 packetLossVariance
enet_uint32 packetThrottle
enet_uint32 packetThrottleLimit
enet_uint32 packetThrottleCounter
enet_uint32 packetThrottleEpoch
enet_uint32 packetThrottleAcceleration
enet_uint32 packetThrottleDeceleration
enet_uint32 packetThrottleInterval
enet_uint32 pingInterval
enet_uint32 timeoutLimit
enet_uint32 timeoutMinimum
enet_uint32 timeoutMaximum
enet_uint32 lastRoundTripTime
enet_uint32 lowestRoundTripTime
enet_uint32 lastRoundTripTimeVariance
enet_uint32 highestRoundTripTimeVariance
enet_uint32 roundTripTime
enet_uint32 roundTripTimeVariance
enet_uint32 mtu
enet_uint32 windowSize
enet_uint32 reliableDataInTransit
enet_uint16 outgoingReliableSequenceNumber
ENetList acknowledgements
ENetList sentReliableCommands
ENetList outgoingSendReliableCommands
ENetList outgoingCommands
ENetList dispatchedCommands
enet_uint16 flags
enet_uint16 reserved
enet_uint16 incomingUnsequencedGroup
enet_uint16 outgoingUnsequencedGroup
enet_uint32[ENET_PEER_UNSEQUENCED_WINDOW_SIZE / 32] unsequencedWindow
enet_uint32 eventData
size_t totalWaitingData
structENetCompressor
Fields
void * context
size_t function(void * context, const(ENetBuffer) * inBuffers, size_t inBufferCount, size_t inLimit, enet_uint8 * outData, size_t outLimit) compress
size_t function(void * context, const(enet_uint8) * inData, size_t inLimit, enet_uint8 * outData, size_t outLimit) decompress
void function(void * context) destroy
structENetHost
Fields
ENetSocket socket
ENetAddress address
enet_uint32 incomingBandwidth
enet_uint32 outgoingBandwidth
enet_uint32 bandwidthThrottleEpoch
enet_uint32 mtu
enet_uint32 randomSeed
int recalculateBandwidthLimits
ENetPeer * peers
size_t peerCount
size_t channelLimit
enet_uint32 serviceTime
ENetList dispatchQueue
enet_uint32 totalQueued
size_t packetSize
enet_uint16 headerFlags
ENetProtocol[ENET_PROTOCOL_MAXIMUM_PACKET_COMMANDS] commands
size_t commandCount
ENetBuffer[ENET_BUFFER_MAXIMUM] buffers
size_t bufferCount
ENetChecksumCallback checksum
ENetCompressor compressor
enet_uint8[ENET_PROTOCOL_MAXIMUM_MTU][2] packetData
ENetAddress receivedAddress
enet_uint8 * receivedData
size_t receivedDataLength
enet_uint32 totalSentData
enet_uint32 totalSentPackets
enet_uint32 totalReceivedData
enet_uint32 totalReceivedPackets
ENetInterceptCallback intercept
size_t connectedPeers
size_t bandwidthLimitedPeers
size_t duplicatePeers
size_t maximumPacketSize
size_t maximumWaitingData
structENetEvent
Fields
ENetEventType type
ENetPeer * peer
enet_uint8 channelID
enet_uint32 data
ENetPacket * packet

Functions 39

fnint enet_initialize() extern(C) @system nothrow @nogc
fnint enet_initialize_with_callbacks(ENetVersion version_, const(ENetCallbacks) * inits) extern(C) @system nothrow @nogc
fnvoid enet_deinitialize() extern(C) @system nothrow @nogc
fnENetVersion enet_linked_version() extern(C) @system nothrow @nogc
fnenet_uint32 enet_time_get() extern(C) @system nothrow @nogc
fnvoid enet_time_set(enet_uint32 newTimeBase) extern(C) @system nothrow @nogc
fnint enet_address_set_host_ip(ENetAddress * address, const(char) * hostName) extern(C) @system nothrow @nogc
fnint enet_address_set_host(ENetAddress * address, const(char) * hostName) extern(C) @system nothrow @nogc
fnint enet_address_get_host_ip(const(ENetAddress) * address, char * hostName, size_t nameLength) extern(C) @system nothrow @nogc
fnint enet_address_get_host(const(ENetAddress) * address, char * hostName, size_t nameLength) extern(C) @system nothrow @nogc
fnENetPacket * enet_packet_create(const(void) * data, size_t dataLength, enet_uint32 flags) extern(C) @system nothrow @nogc
fnvoid enet_packet_destroy(ENetPacket * packet) extern(C) @system nothrow @nogc
fnint enet_packet_resize(ENetPacket * packet, size_t dataLength) extern(C) @system nothrow @nogc
fnenet_uint32 enet_crc32(const(ENetBuffer) * buffers, size_t bufferCount) extern(C) @system nothrow @nogc
fnENetHost * enet_host_create(const(ENetAddress) * address, size_t peerCount, size_t channelLimit, enet_uint32 incomingBandwidth, enet_uint32 outgoingBandwidth) extern(C) @system nothrow @nogc
fnvoid enet_host_destroy(ENetHost * host) extern(C) @system nothrow @nogc
fnENetPeer * enet_host_connect(ENetHost * host, const(ENetAddress) * address, size_t channelCount, enet_uint32 data) extern(C) @system nothrow @nogc
fnint enet_host_check_events(ENetHost * host, ENetEvent * event) extern(C) @system nothrow @nogc
fnint enet_host_service(ENetHost * host, ENetEvent * event, enet_uint32 timeout) extern(C) @system nothrow @nogc
fnvoid enet_host_flush(ENetHost * host) extern(C) @system nothrow @nogc
fnvoid enet_host_broadcast(ENetHost * host, enet_uint8 channelID, ENetPacket * packet) extern(C) @system nothrow @nogc
fnvoid enet_host_compress(ENetHost * host, const(ENetCompressor) * compressor) extern(C) @system nothrow @nogc
fnint enet_host_compress_with_range_coder(ENetHost * host) extern(C) @system nothrow @nogc
fnvoid enet_host_channel_limit(ENetHost * host, size_t channelLimit) extern(C) @system nothrow @nogc
fnvoid enet_host_bandwidth_limit(ENetHost * host, enet_uint32 incomingBandwidth, enet_uint32 outgoingBandwidth) extern(C) @system nothrow @nogc
fnint enet_peer_send(ENetPeer * peer, enet_uint8 channelID, ENetPacket * packet) extern(C) @system nothrow @nogc
fnENetPacket * enet_peer_receive(ENetPeer * peer, enet_uint8 * channelID) extern(C) @system nothrow @nogc
fnvoid enet_peer_ping(ENetPeer * peer) extern(C) @system nothrow @nogc
fnvoid enet_peer_ping_interval(ENetPeer * peer, enet_uint32 pingInterval) extern(C) @system nothrow @nogc
fnvoid enet_peer_timeout(ENetPeer * peer, enet_uint32 timeoutLimit, enet_uint32 timeoutMinimum, enet_uint32 timeoutMaximum) extern(C) @system nothrow @nogc
fnvoid enet_peer_reset(ENetPeer * peer) extern(C) @system nothrow @nogc
fnvoid enet_peer_disconnect(ENetPeer * peer, enet_uint32 data) extern(C) @system nothrow @nogc
fnvoid enet_peer_disconnect_now(ENetPeer * peer, enet_uint32 data) extern(C) @system nothrow @nogc
fnvoid enet_peer_disconnect_later(ENetPeer * peer, enet_uint32 data) extern(C) @system nothrow @nogc
fnvoid enet_peer_throttle_configure(ENetPeer * peer, enet_uint32 interval, enet_uint32 acceleration, enet_uint32 deceleration) extern(C) @system nothrow @nogc
fnvoid * enet_range_coder_create() extern(C) @system nothrow @nogc
fnvoid enet_range_coder_destroy(void * context) extern(C) @system nothrow @nogc
fnsize_t enet_range_coder_compress(void * context, const(ENetBuffer) * inBuffers, size_t inBufferCount, size_t inLimit, enet_uint8 * outData, size_t outLimit) extern(C) @system nothrow @nogc
fnsize_t enet_range_coder_decompress(void * context, const(enet_uint8) * inData, size_t inLimit, enet_uint8 * outData, size_t outLimit) extern(C) @system nothrow @nogc

Variables 8

enumvarENET_VERSION_MAJOR = 1
enumvarENET_VERSION_MINOR = 3
enumvarENET_VERSION_PATCH = 18
enumvarENET_VERSION = (ENET_VERSION_MAJOR << 16) | (ENET_VERSION_MINOR << 8) | ENET_VERSION_PATCH
enumvarENET_HOST_ANY = 0
enumvarENET_HOST_BROADCAST = 0xFFFFFFFF
enumvarENET_PORT_ANY = 0
enumvarENET_BUFFER_MAXIMUM = 1 + 2 * ENET_PROTOCOL_MAXIMUM_PACKET_COMMANDS