ENet Xojo plugin

ENetPeer.PeerTimeout Method

Sets the timeout parameters for a peer.

PeerTimeout(
   timeoutLimit as UInt32,
   timeoutMinimum as UInt32,
   timeoutMaximum as UInt32)

Parameters

timeoutLimit
The timeout limit. If set to zero then default timeout limit is used.
timeoutMinimum
The timeout minimum. If set to zero then default timeout minimum is used.
timeoutMaximum
The timeout maximum. If set to zero then default timeout maximum is used.

Remarks

Controls how and when a peer will timeout from a failure to acknowledge reliable traffic. Timeout values use an exponential backoff mechanism, where if a reliable packet is not acknowledge within some multiple of the average RTT plus a variance tolerance, the timeout will be doubled until it reaches a set limit. If the timeout is thus at this limit and reliable packets have been sent but not acknowledged within a certain minimum time period, the peer will be disconnected. Alternatively, if reliable packets have been sent but not acknowledged for a certain maximum time period, the peer will be disconnected regardless of the current timeout limit value.

See Also

ENetPeer Class