ENetPacketPeer

public int GetChannels();

Returns the number of channels allocated for communication with peer.

public int GetPacketFlags();

Returns the ENet flags of the next packet in the received queue. See FLAG_* constants for available packet flags. Note that not all flags are replicated from the sending peer to the receiving peer.

public string GetRemoteAddress();

Returns the IP address of this peer.

public int GetRemotePort();

Returns the remote port of this peer.

public ENetPacketPeer.PeerState GetState();

Returns the current peer state.

public double GetStatistic(ENetPacketPeer.PeerStatistic statistic);

Returns the requested statistic for this peer.

public bool IsActive();

Returns true if the peer is currently active (i.e. the associated ENetConnection is still valid).

public void PeerDisconnect(int data = 0);

Request a disconnection from a peer. An ENetConnection.EventType.Disconnect will be generated during ENetConnection.Service once the disconnection is complete.

public void PeerDisconnectLater(int data = 0);

Request a disconnection from a peer, but only after all queued outgoing packets are sent. An ENetConnection.EventType.Disconnect will be generated during ENetConnection.Service once the disconnection is complete.

public void PeerDisconnectNow(int data = 0);

Force an immediate disconnection from a peer. No ENetConnection.EventType.Disconnect will be generated. The foreign peer is not guaranteed to receive the disconnect notification, and is reset immediately upon return from this function.

public void Ping();

Sends a ping request to a peer. ENet automatically pings all connected peers at regular intervals, however, this function may be called to ensure more frequent ping requests.

public void PingInterval(int pingInterval);

Sets the ENetPacketPeer.PingInterval in milliseconds at which pings will be sent to a peer. Pings are used both to monitor the liveness of the connection and also to dynamically adjust the throttle during periods of low traffic so that the throttle has reasonable responsiveness during traffic spikes. The default ping interval is 500 milliseconds.

public void Reset();

Forcefully disconnects a peer. The foreign host represented by the peer is not notified of the disconnection and will timeout on its connection to the local host.

public Error Send(int channel, byte[] packet, int flags);

Queues a packet to be sent over the specified channel. See FLAG_* constants for available packet flags.

public Error Send(int channel, ReadOnlySpan<byte> packet, int flags);

Queues a packet to be sent over the specified channel. See FLAG_* constants for available packet flags.

public void SetTimeout(int timeout, int timeoutMin, int timeoutMax);

Sets the timeout parameters for a peer. The timeout parameters control how and when a peer will timeout from a failure to acknowledge reliable traffic. Timeout values are expressed in milliseconds. The timeout is a factor that, multiplied by a value based on the average round trip time, will determine the timeout limit for a reliable packet. When that limit is reached, the timeout will be doubled, and the peer will be disconnected if that limit has reached timeout_min. The timeout_max parameter, on the other hand, defines a fixed timeout for which any packet must be acknowledged or the peer will be dropped.

public void ThrottleConfigure(int interval, int acceleration, int deceleration);

Configures throttle parameter for a peer. Unreliable packets are dropped by ENet in response to the varying conditions of the Internet connection to the peer. The throttle represents a probability that an unreliable packet should not be dropped and thus sent by ENet to the peer. By measuring fluctuations in round trip times of reliable packets over the specified interval, ENet will either increase the probability by the amount specified in the acceleration parameter, or decrease it by the amount specified in the deceleration parameter (both are ratios to ENetPacketPeer.PacketThrottleScale). When the throttle has a value of ENetPacketPeer.PacketThrottleScale, no unreliable packets are dropped by ENet, and so 100% of all unreliable packets will be sent. When the throttle has a value of 0, all unreliable packets are dropped by ENet, and so 0% of all unreliable packets will be sent. Intermediate values for the throttle represent intermediate probabilities between 0% and 100% of unreliable packets being sent. The bandwidth limits of the local and foreign hosts are taken into account to determine a sensible limit for the throttle probability above which it should not raise even in the best of conditions.

public const long FlagReliable = 1;

Mark the packet to be sent as reliable.

public const long FlagUnreliableFragment = 8;

Mark the packet to be sent unreliable even if the packet is too big and needs fragmentation (increasing the chance of it being dropped).

public const long FlagUnsequenced = 2;

Mark the packet to be sent unsequenced (unreliable).

public const long PacketLossScale = 65536;

The reference scale for packet loss. See ENetPacketPeer.GetStatistic and ENetPacketPeer.PeerStatistic.PacketLoss.

public const long PacketThrottleScale = 32;

The reference value for throttle configuration. The default value is 32. See ENetPacketPeer.ThrottleConfigure.