Five On It

Appearance

five-on-it / apps/client/src/renderer/net / SocketTransport

Interface: SocketTransport ​

Defined in: apps/client/src/renderer/net.ts:23

A WebSocket Transport that tells whether its socket ever opened, and how it closed.

Extends ​

Properties ​

closeCode ​

readonly closeCode: number | undefined

Defined in: apps/client/src/renderer/net.ts:27

The code the socket closed with, once it has (a room's refusal is one of CLOSE_CODES).

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

opened ​

readonly opened: boolean

Defined in: apps/client/src/renderer/net.ts:25

Whether the server ever took the connection (a refused one never opens).

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

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