Index · Object → RefCounted → PacketPeer → ENetPacketPeer

ENetPacketPeer

A wrapper class for an ENetPeer.

Class Description

A PacketPeer implementation representing a peer of an ENetConnection.

This class cannot be instantiated directly but can be retrieved during ENetConnection.service() or via ENetConnection.get_peers().

Note: When exporting to Android, make sure to enable the INTERNET permission in the Android export preset before exporting the project or using one-click deploy. Otherwise, network communication of any kind will be blocked by Android.

Properties

Inherited from PacketPeer (1)

Methods

func get_channels() -> int

Returns the number of channels allocated for communication with peer.

func get_packet_flags() -> int

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.

func get_remote_address() -> String

Returns the IP address of this peer.

func get_remote_port() -> int

Returns the remote port of this peer.

func get_state() -> ENetPacketPeer.PeerState

Returns the current peer state.

func get_statistic(statistic: ENetPacketPeer.PeerStatistic) -> float

Returns the requested statistic for this peer.

func is_active() -> bool

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

func peer_disconnect(data: int = 0) -> void

Request a disconnection from a peer. An ENetConnection.EVENT_DISCONNECT will be generated during ENetConnection.service() once the disconnection is complete.

func peer_disconnect_later(data: int = 0) -> void

Request a disconnection from a peer, but only after all queued outgoing packets are sent. An ENetConnection.EVENT_DISCONNECT will be generated during ENetConnection.service() once the disconnection is complete.

func peer_disconnect_now(data: int = 0) -> void

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

func ping() -> void

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.

func ping_interval(ping_interval: int) -> void

Sets the ping_interval 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.

func reset() -> void

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.

func send(channel: int, packet: PackedByteArray, flags: int) -> Error

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

func set_timeout(timeout: int, timeout_min: int, timeout_max: int) -> void

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.

func throttle_configure(interval: int, acceleration: int, deceleration: int) -> void

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 PACKET_THROTTLE_SCALE).

When the throttle has a value of PACKET_THROTTLE_SCALE, 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.

Inherited from PacketPeer (6)
func get_packet_error() -> Error
func get_var(allow_objects: bool = false) -> Variant
func put_packet(buffer: PackedByteArray) -> Error
func put_var(var: Variant, full_objects: bool = false) -> Error
Inherited from RefCounted (4)
func init_ref() -> bool
func reference() -> bool
func unreference() -> bool
Inherited from Object (62)
func _get(property: StringName) -> Variant
func _get_property_list() -> Dictionary[]
func _init() -> void
func _iter_get(iter: Variant) -> Variant
func _iter_init(iter: Array) -> bool
func _iter_next(iter: Array) -> bool
func _notification(what: int) -> void
func _set(property: StringName, value: Variant) -> bool
func _to_string() -> String
func _validate_property(property: Dictionary) -> void
func add_user_signal(signal: String, arguments: Array = []) -> void
func call(method: StringName) -> Variant
func callv(method: StringName, arg_array: Array) -> Variant
func cancel_free() -> void
func connect(signal: StringName, callable: Callable, flags: int = 0) -> Error
func disconnect(signal: StringName, callable: Callable) -> void
func emit_signal(signal: StringName) -> Error
func free() -> void
func get(property: StringName) -> Variant
func get_class() -> String
func get_incoming_connections() -> Dictionary[]
func get_indexed(property_path: NodePath) -> Variant
func get_meta(name: StringName, default: Variant = null) -> Variant
func get_meta_list() -> StringName[]
func get_method_list() -> Dictionary[]
func get_property_list() -> Dictionary[]
func get_signal_connection_list(signal: StringName) -> Dictionary[]
func get_signal_list() -> Dictionary[]
func has_meta(name: StringName) -> bool
func has_method(method: StringName) -> bool
func has_signal(signal: StringName) -> bool
func is_class(class: StringName) -> bool
func is_connected(signal: StringName, callable: Callable) -> bool
func notification(what: int, reversed: bool = false) -> void
func remove_meta(name: StringName) -> void
func remove_user_signal(signal: StringName) -> void
func set(property: StringName, value: Variant) -> void
func set_block_signals(enable: bool) -> void
func set_deferred(property: StringName, value: Variant) -> void
func set_indexed(property_path: NodePath, value: Variant) -> void
func set_message_translation(enable: bool) -> void
func set_meta(name: StringName, value: Variant) -> void
func set_script(script: Variant) -> void
func set_translation_domain(domain: StringName) -> void
func to_string() -> String
func tr(message: StringName, context: StringName = &"") -> String
func tr_n(message: StringName, plural_message: StringName, n: int, context: StringName = &"") -> String

Signals

Inherited from Object (2)

Enums & Constants

enum PeerState
STATE_DISCONNECTED = 0

The peer is disconnected.

STATE_CONNECTING = 1

The peer is currently attempting to connect.

STATE_ACKNOWLEDGING_CONNECT = 2

The peer has acknowledged the connection request.

STATE_CONNECTION_PENDING = 3

The peer is currently connecting.

STATE_CONNECTION_SUCCEEDED = 4

The peer has successfully connected, but is not ready to communicate with yet (STATE_CONNECTED).

STATE_CONNECTED = 5

The peer is currently connected and ready to communicate with.

STATE_DISCONNECT_LATER = 6

The peer is expected to disconnect after it has no more outgoing packets to send.

STATE_DISCONNECTING = 7

The peer is currently disconnecting.

STATE_ACKNOWLEDGING_DISCONNECT = 8

The peer has acknowledged the disconnection request.

STATE_ZOMBIE = 9

The peer has lost connection, but is not considered truly disconnected (as the peer didn't acknowledge the disconnection request).

enum PeerStatistic
PEER_PACKET_LOSS = 0

Mean packet loss of reliable packets as a ratio with respect to the PACKET_LOSS_SCALE.

PEER_PACKET_LOSS_VARIANCE = 1

Packet loss variance.

PEER_PACKET_LOSS_EPOCH = 2

The time at which packet loss statistics were last updated (in milliseconds since the connection started). The interval for packet loss statistics updates is 10 seconds, and at least one packet must have been sent since the last statistics update.

PEER_ROUND_TRIP_TIME = 3

Mean packet round trip time for reliable packets.

PEER_ROUND_TRIP_TIME_VARIANCE = 4

Variance of the mean round trip time.

PEER_LAST_ROUND_TRIP_TIME = 5

Last recorded round trip time for a reliable packet.

PEER_LAST_ROUND_TRIP_TIME_VARIANCE = 6

Variance of the last trip time recorded.

PEER_PACKET_THROTTLE = 7

The peer's current throttle status.

PEER_PACKET_THROTTLE_LIMIT = 8

The maximum number of unreliable packets that should not be dropped. This value is always greater than or equal to 1. The initial value is equal to PACKET_THROTTLE_SCALE.

PEER_PACKET_THROTTLE_COUNTER = 9

Internal value used to increment the packet throttle counter. The value is hardcoded to 7 and cannot be changed. You probably want to look at PEER_PACKET_THROTTLE_ACCELERATION instead.

PEER_PACKET_THROTTLE_EPOCH = 10

The time at which throttle statistics were last updated (in milliseconds since the connection started). The interval for throttle statistics updates is PEER_PACKET_THROTTLE_INTERVAL.

PEER_PACKET_THROTTLE_ACCELERATION = 11

The throttle's acceleration factor. Higher values will make ENet adapt to fluctuating network conditions faster, causing unrelaible packets to be sent more often. The default value is 2.

PEER_PACKET_THROTTLE_DECELERATION = 12

The throttle's deceleration factor. Higher values will make ENet adapt to fluctuating network conditions faster, causing unrelaible packets to be sent less often. The default value is 2.

PEER_PACKET_THROTTLE_INTERVAL = 13

The interval over which the lowest mean round trip time should be measured for use by the throttle mechanism (in milliseconds). The default value is 5000.

const PACKET_LOSS_SCALE = 65536

The reference scale for packet loss. See get_statistic() and PEER_PACKET_LOSS.

const PACKET_THROTTLE_SCALE = 32

The reference value for throttle configuration. The default value is 32. See throttle_configure().

const FLAG_RELIABLE = 1

Mark the packet to be sent as reliable.

const FLAG_UNSEQUENCED = 2

Mark the packet to be sent unsequenced (unreliable).

const FLAG_UNRELIABLE_FRAGMENT = 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).