Features
Docs
CLI
Benchmarks
Examples
GitHub

© 2024 MoroJs

@morojs/moro


@morojs/moro / WebSocketNamespace

Interface: WebSocketNamespace

Defined in: src/core/networking/websocket-adapter.ts:67

WebSocket namespace interface Represents a logical grouping of WebSocket connections

Methods

emit()

emit(event, data): void

Defined in: src/core/networking/websocket-adapter.ts:76

Emit event to all connected sockets in this namespace

Parameters

event

string

data

any

Returns

void


except()

except(room): WebSocketEmitter

Defined in: src/core/networking/websocket-adapter.ts:86

Emit to sockets except those in specified room(s)

Parameters

room

string | string[]

Returns

WebSocketEmitter


getConnectionCount()

getConnectionCount(): number

Defined in: src/core/networking/websocket-adapter.ts:96

Get connection count for this namespace

Returns

number


getSockets()

getSockets(): WebSocketConnection[]

Defined in: src/core/networking/websocket-adapter.ts:91

Get all connected sockets

Returns

WebSocketConnection[]


on()

on(event, handler): void

Defined in: src/core/networking/websocket-adapter.ts:71

Listen for connection events

Parameters

event

"connection"

handler

(socket) => void

Returns

void


to()

to(room): WebSocketEmitter

Defined in: src/core/networking/websocket-adapter.ts:81

Emit to specific room(s)

Parameters

room

string | string[]

Returns

WebSocketEmitter


use()

use(middleware): void

Defined in: src/core/networking/websocket-adapter.ts:101

Use middleware for this namespace

Parameters

middleware

(socket, next) => void

Returns

void