Class GameWebSocketServer

Hierarchy

EventEmitter<WebSocketServerEvents>
- GameWebSocketServer

Index

Constructors

Accessors

Methods

broadcast emit listenerCount off on once removeAllListeners send start stop

Constructors

constructor

new GameWebSocketServer(config: WebSocketConfig): GameWebSocketServer
Parameters
- config: WebSocketConfig
Returns GameWebSocketServer
Overrides EventEmitter<WebSocketServerEvents>.constructor
- Defined in host/src/websocket.ts:72

Accessors

clientCount

get clientCount(): number
Returns the number of currently connected clients.

Returns number
- Defined in host/src/websocket.ts:264

Methods

broadcast

broadcast(data: unknown, excludeId?: string): void
Broadcast data to all connected clients. Wraps each send in try/catch so a single failed send doesn't skip remaining clients.
Parameters
- data: unknown
- OptionalexcludeId: string
Returns void
- Defined in host/src/websocket.ts:243

emit

emit<K extends "message" | "error" | "connection" | "disconnect" | "listening">(
event: K,
...args: WebSocketServerEvents[K],
): boolean
Type Parameters
- K extends "message" | "error" | "connection" | "disconnect" | "listening"
Parameters
- event: K
- ...args: WebSocketServerEvents[K]
Returns boolean
Inherited from EventEmitter.emit
- Defined in host/src/event-emitter.ts:63

listenerCount

listenerCount<
    K extends
        "message"
        | "error"
        | "connection"
        | "disconnect"
        | "listening",
>(
    event: K,
): number
Type Parameters
- K extends "message" | "error" | "connection" | "disconnect" | "listening"
Parameters
- event: K
Returns number
Inherited from EventEmitter.listenerCount
- Defined in host/src/event-emitter.ts:96

off

off<K extends "message" | "error" | "connection" | "disconnect" | "listening">(
event: K,
listener: (...args: WebSocketServerEvents[K]) => void,
): this
Type Parameters
- K extends "message" | "error" | "connection" | "disconnect" | "listening"
Parameters
- event: K
- listener: (...args: WebSocketServerEvents[K]) => void
Returns this
Inherited from EventEmitter.off
- Defined in host/src/event-emitter.ts:49

on

on<K extends "message" | "error" | "connection" | "disconnect" | "listening">(
event: K,
listener: (...args: WebSocketServerEvents[K]) => void,
): this
Type Parameters
- K extends "message" | "error" | "connection" | "disconnect" | "listening"
Parameters
- event: K
- listener: (...args: WebSocketServerEvents[K]) => void
Returns this
Inherited from EventEmitter.on
- Defined in host/src/event-emitter.ts:26

once

once<K extends "message" | "error" | "connection" | "disconnect" | "listening">(
event: K,
listener: (...args: WebSocketServerEvents[K]) => void,
): this
Type Parameters
- K extends "message" | "error" | "connection" | "disconnect" | "listening"
Parameters
- event: K
- listener: (...args: WebSocketServerEvents[K]) => void
Returns this
Inherited from EventEmitter.once
- Defined in host/src/event-emitter.ts:37

removeAllListeners

removeAllListeners<
    K extends
        "message"
        | "error"
        | "connection"
        | "disconnect"
        | "listening",
>(
    event?: K,
): this
Type Parameters
- K extends "message" | "error" | "connection" | "disconnect" | "listening"
Parameters
- Optionalevent: K
Returns this
Inherited from EventEmitter.removeAllListeners
- Defined in host/src/event-emitter.ts:87

send

send(socketId: string, data: unknown): void
Send data to a specific client by socket ID. Silently ignores unknown socket IDs and write errors.
Parameters
- socketId: string
- data: unknown
Returns void
- Defined in host/src/websocket.ts:217

start

start(): Promise<void>
Returns Promise<void>
- Defined in host/src/websocket.ts:90

stop

stop(): Promise<void>
Returns Promise<void>
- Defined in host/src/websocket.ts:193