ENet  v1.3.13
Reliable UDP networking library
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Data Fields
ENetHost Struct Reference

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

#include <enet.h>

Data Fields

ENetAddress address
 Internet address of the host. More...
 
size_t bandwidthLimitedPeers
 
enet_uint32 bandwidthThrottleEpoch
 
size_t bufferCount
 
ENetBuffer buffers [(1+2 *ENET_PROTOCOL_MAXIMUM_PACKET_COMMANDS)]
 
size_t channelLimit
 maximum number of channels allowed for connected peers More...
 
ENetChecksumCallback checksum
 callback the user can set to enable packet checksums for this host More...
 
size_t commandCount
 
ENetProtocol commands [ENET_PROTOCOL_MAXIMUM_PACKET_COMMANDS]
 
ENetCompressor compressor
 
size_t connectedPeers
 
int continueSending
 
ENetList dispatchQueue
 
size_t duplicatePeers
 optional number of allowed peers from duplicate IPs, defaults to ENET_PROTOCOL_MAXIMUM_PEER_ID More...
 
enet_uint16 headerFlags
 
enet_uint32 incomingBandwidth
 downstream bandwidth of the host More...
 
ENetInterceptCallback intercept
 callback the user can set to intercept received raw UDP packets More...
 
size_t maximumPacketSize
 the maximum allowable packet size that may be sent or received on a peer More...
 
size_t maximumWaitingData
 the maximum aggregate amount of buffer space a peer may use waiting for packets to be delivered More...
 
enet_uint32 mtu
 
enet_uint32 outgoingBandwidth
 upstream bandwidth of the host More...
 
enet_uint8 packetData [2][ENET_PROTOCOL_MAXIMUM_MTU]
 
size_t packetSize
 
size_t peerCount
 number of peers allocated for this host More...
 
ENetPeerpeers
 array of peers allocated for this host More...
 
enet_uint32 randomSeed
 
int recalculateBandwidthLimits
 
ENetAddress receivedAddress
 
enet_uint8receivedData
 
size_t receivedDataLength
 
enet_uint32 serviceTime
 
ENetSocket socket
 
enet_uint32 totalReceivedData
 total data received, user should reset to 0 as needed to prevent overflow More...
 
enet_uint32 totalReceivedPackets
 total UDP packets received, user should reset to 0 as needed to prevent overflow More...
 
enet_uint32 totalSentData
 total data sent, user should reset to 0 as needed to prevent overflow More...
 
enet_uint32 totalSentPackets
 total UDP packets sent, user should reset to 0 as needed to prevent overflow More...
 

Detailed Description

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()

Field Documentation

ENetAddress ENetHost::address

Internet address of the host.

size_t ENetHost::bandwidthLimitedPeers
enet_uint32 ENetHost::bandwidthThrottleEpoch
size_t ENetHost::bufferCount
size_t ENetHost::channelLimit

maximum number of channels allowed for connected peers

ENetChecksumCallback ENetHost::checksum

callback the user can set to enable packet checksums for this host

size_t ENetHost::commandCount
ENetCompressor ENetHost::compressor
size_t ENetHost::connectedPeers
int ENetHost::continueSending
ENetList ENetHost::dispatchQueue
size_t ENetHost::duplicatePeers

optional number of allowed peers from duplicate IPs, defaults to ENET_PROTOCOL_MAXIMUM_PEER_ID

enet_uint16 ENetHost::headerFlags
enet_uint32 ENetHost::incomingBandwidth

downstream bandwidth of the host

ENetInterceptCallback ENetHost::intercept

callback the user can set to intercept received raw UDP packets

size_t ENetHost::maximumPacketSize

the maximum allowable packet size that may be sent or received on a peer

size_t ENetHost::maximumWaitingData

the maximum aggregate amount of buffer space a peer may use waiting for packets to be delivered

enet_uint32 ENetHost::mtu
enet_uint32 ENetHost::outgoingBandwidth

upstream bandwidth of the host

enet_uint8 ENetHost::packetData[2][ENET_PROTOCOL_MAXIMUM_MTU]
size_t ENetHost::packetSize
size_t ENetHost::peerCount

number of peers allocated for this host

ENetPeer* ENetHost::peers

array of peers allocated for this host

enet_uint32 ENetHost::randomSeed
int ENetHost::recalculateBandwidthLimits
ENetAddress ENetHost::receivedAddress
enet_uint8* ENetHost::receivedData
size_t ENetHost::receivedDataLength
enet_uint32 ENetHost::serviceTime
ENetSocket ENetHost::socket
enet_uint32 ENetHost::totalReceivedData

total data received, user should reset to 0 as needed to prevent overflow

enet_uint32 ENetHost::totalReceivedPackets

total UDP packets received, user should reset to 0 as needed to prevent overflow

enet_uint32 ENetHost::totalSentData

total data sent, user should reset to 0 as needed to prevent overflow

enet_uint32 ENetHost::totalSentPackets

total UDP packets sent, user should reset to 0 as needed to prevent overflow


The documentation for this struct was generated from the following file: