five-on-it / packages/protocol/src/transport / Transport

Interface: Transport

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

A bidirectional, message-oriented connection to one peer.

Extended by

• Connection
• SocketTransport
• HeldTransport
• RtcTransport

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.

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

---

close()

close(): void

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

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

Returns

void

---

onClose()

onClose(handler): void

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

Registers the single close listener.

Parameters

handler

() => void

Returns

void

---

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

---

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