Class Peer

Represents a connected remote ENet peer endpoint. Provides methods for transmitting packets, querying state, and managing connection lifecycle.

Index

Constructors

Properties

Accessors

ip port rtt state

Methods

disconnect disconnectLater disconnectNow ping reset send sendRaw

Constructors

constructor

new Peer(host: Host, id: number): Peer
Instantiates a new Peer wrapper.
Parameters
- host: Host
  Underlying WebAssembly Host instance.
- id: number
  Numeric peer ID.
Returns Peer
- Defined in lib/src/Peer.ts:18

Properties

id

id: number

The unique numeric ID assigned to this peer by the ENet host.

Accessors

ip

get ip(): string
Gets the remote IP address of the peer.

Returns string
- Defined in lib/src/Peer.ts:99

port

get port(): number
Gets the remote UDP port number of the peer.

Returns number
- Defined in lib/src/Peer.ts:106

rtt

get rtt(): number
Gets the current round-trip time (RTT) in milliseconds.

Returns number
- Defined in lib/src/Peer.ts:113

state

get state(): number
Gets the current ENet connection state for this peer.

Returns number
- Defined in lib/src/Peer.ts:92

Methods

disconnect

disconnect(data?: number): void
Initiates a graceful disconnect request for this peer.
Parameters
- data: number = 0
  Optional integer disconnect code.
Returns void
- Defined in lib/src/Peer.ts:53

disconnectLater

disconnectLater(data?: number): void
Schedules a disconnect for this peer after all queued outgoing packets are delivered.
Parameters
- data: number = 0
  Optional integer disconnect code.
Returns void
- Defined in lib/src/Peer.ts:71

disconnectNow

disconnectNow(data?: number): void
Forces an immediate abrupt disconnect for this peer without waiting for acknowledgments.
Parameters
- data: number = 0
  Optional integer disconnect code.
Returns void
- Defined in lib/src/Peer.ts:62

ping

ping(): void
Sends a ping request to update peer round-trip time calculations.

Returns void
- Defined in lib/src/Peer.ts:78

reset

reset(): void
Resets peer connection state immediately, clearing allocated core resources.

Returns void
- Defined in lib/src/Peer.ts:85

send

send(packet: Packet, channel?: number): void
Sends a WebAssembly ENet packet to the peer.
Parameters
- packet: Packet
  ENet Packet instance to transmit.
- channel: number = 0
  ENet channel ID (defaults to 0).
Returns void
- Defined in lib/src/Peer.ts:29

sendRaw

sendRaw(data: Uint8Array, channel?: number, flags?: number): void
Encapsulates raw byte data into an ENet Packet and transmits it to the peer.
Parameters
- data: Uint8Array
  Byte array containing payload data.
- channel: number = 0
  ENet channel ID (defaults to 0).
- flags: number = 1
  Reliability flag (0 = Unreliable, 1 = Reliable, 2 = Unsequenced).
Returns void
- Defined in lib/src/Peer.ts:40