WebSocketTransport

class WebSocketTransport implements Transport

import { WebSocketTransport } from '@driftengine/network';

Constructor

`new`

constructor(options: WebSocketTransportOptions)

Parameter	Type	Description
`options`	`WebSocketTransportOptions`

Properties

Name	Type	Description
`self`readonly	`PeerId`

Accessors

Name	Type	Description
`state`get	`TransportState`
`dropped`get	`number`	Messages dropped: because nothing drained, which a consumer watching for a stalled tab reads, or because nothing could be read out of them.

Methods

`send`

send(_to: PeerId, message: Uint8Array): void

Send, or do nothing if the socket is not open yet.

Parameter	Type	Description
`_to`	`PeerId`
`message`	`Uint8Array`

Nothing is queued while connecting, deliberately. Every message this package sends is addressed to a tick, and a tick that has passed by the time the socket opens is a tick nobody can use. Flushing a backlog of stale inputs on connect is worse than having sent none.

`drain`

drain(into: MessageSink): void

Parameter	Type	Description
`into`	`MessageSink`

`close`

close(): void