IQWebSocketEngine

@quik/websocket

---

@quik/websocket / IQWebSocketEngine

Interface: IQWebSocketEngine

Defined in: websocket/src/engine/IQWebSocketEngine.ts:4

Interface describing a WebSocket engine implementation.

Properties

engine

readonly engine: string

Defined in: websocket/src/engine/IQWebSocketEngine.ts:6

Name of the underlying engine implementation.

---

isListening

readonly isListening: boolean

Defined in: websocket/src/engine/IQWebSocketEngine.ts:10

Indicates whether the engine is accepting upgrades.

---

path

readonly path: string

Defined in: websocket/src/engine/IQWebSocketEngine.ts:8

Upgrade path handled by the engine.

Methods

broadcast()

broadcast(data): number

Defined in: websocket/src/engine/IQWebSocketEngine.ts:31

Send data to every connected WebSocket peer.

Parameters

data

string

Payload to send.

Returns

number

---

send()

send(connectionId, data): boolean

Defined in: websocket/src/engine/IQWebSocketEngine.ts:24

Send data to a single WebSocket connection.

Parameters

connectionId

string

Connection identifier.

data

string

Payload to send.

Returns

boolean

---

start()

start(): Promise<void>

Defined in: websocket/src/engine/IQWebSocketEngine.ts:13

Start accepting WebSocket connections.

Returns

Promise<void>

---

stop()

stop(): Promise<void>

Defined in: websocket/src/engine/IQWebSocketEngine.ts:16

Stop accepting WebSocket connections and close active peers.

Returns

Promise<void>