Five On It

Appearance

five-on-it / apps/server/src/http / Connection

Interface: Connection ​

Defined in: apps/server/src/http.ts:120

A connection a room may take: a transport that can be closed with a code.

Extends ​

Extended by ​

Properties ​

lossy? ​

optional lossy?: boolean

Defined in: packages/protocol/src/transport.ts:55

Whether frames may be lost, duplicated or reordered (a WebRTC data channel without retransmits); absent or false for an ordered, reliable transport.

Inherited from ​

Transport.lossy

Methods ​

buffered()? ​

optional buffered(): number

Defined in: packages/protocol/src/transport.ts:53

Bytes sent and not yet on their way (a WebSocket's buffered amount); a transport that cannot tell leaves it out.

Returns ​

number

Inherited from ​

Transport.buffered

close() ​

close(): void

Defined in: packages/protocol/src/transport.ts:51

Closes the connection; the close listener fires on both ends.

Returns ​

void

Inherited from ​

Transport.close

onClose() ​

onClose(handler): void

Defined in: packages/protocol/src/transport.ts:49

Registers the single close listener.

Parameters ​

handler ​

() => void

Returns ​

void

Inherited from ​

Transport.onClose

onMessage() ​

onMessage(handler): void

Defined in: packages/protocol/src/transport.ts:47

Registers the single receiver of incoming frames.

Parameters ​

handler ​

(message) => void

Returns ​

void

Inherited from ​

Transport.onMessage

refuse() ​

refuse(code, reason): void

Defined in: apps/server/src/http.ts:122

Closes the connection with a WebSocket close code and a reason.

Parameters ​

code ​

number

reason ​

string

Returns ​

void

send() ​

send(channel, message): void

Defined in: packages/protocol/src/transport.ts:45

Sends one frame. unreliable frames may be dropped or reordered by a future transport; today every transport delivers both channels reliably and in order.

Parameters ​

channel ​

"reliable" | "unreliable"

message ​

TransportMessage

Returns ​

void

Inherited from ​

Transport.send