1681-engine / index / Connection
Class: Connection ​
Defined in: src/net/Connection.ts:52
The client side of the engine's netcode over a WebSocket: hello on open, input steps batched and sent once a frame (queueInput then flush), snapshots decoded (binary or JSON) onto events, pings that keep the server clock (serverNow) and rtt up to date, and reconnection with backoff.
Constructors ​
Constructor ​
new Connection(url, options?): Connection;Defined in: src/net/Connection.ts:65
Parameters ​
| Parameter | Type |
|---|---|
url | string |
options | ConnectionOptions |
Returns ​
Connection
Properties ​
events ​
readonly events: EventBus<ConnectionEvents>;Defined in: src/net/Connection.ts:53
rtt ​
rtt: number = 0;Defined in: src/net/Connection.ts:55
The last measured round trip, ms.
url ​
readonly url: string;Defined in: src/net/Connection.ts:66
Accessors ​
open ​
Get Signature ​
get open(): boolean;Defined in: src/net/Connection.ts:70
Returns ​
boolean
Methods ​
close() ​
close(): void;Defined in: src/net/Connection.ts:117
Returns ​
void
connect() ​
connect(): this;Defined in: src/net/Connection.ts:74
Returns ​
this
flush() ​
flush(): void;Defined in: src/net/Connection.ts:111
Sends this frame's input steps as one message. Call once a frame.
Returns ​
void
queueInput() ​
queueInput(seq, step): void;Defined in: src/net/Connection.ts:105
Adds one input step to this frame's batch; flush sends it. Steps must come in sequence order.
Parameters ​
| Parameter | Type |
|---|---|
seq | number |
step | InputStep |
Returns ​
void
send() ​
send(msg): void;Defined in: src/net/Connection.ts:100
Sends a message now (dropped while closed: input is resent by the prediction's own state, not by the socket).
Parameters ​
| Parameter | Type |
|---|---|
msg | | ClientMessage | { [k: string]: unknown; t: string; } |
Returns ​
void