Features
Docs
CLI
Benchmarks
Examples
GitHub

© 2024 MoroJs

@morojs/moro


@morojs/moro / WebSocketManager

Class: WebSocketManager

Defined in: src/core/networking/websocket-manager.ts:11

Constructors

Constructor

new WebSocketManager(adapter, container): WebSocketManager

Defined in: src/core/networking/websocket-manager.ts:16

Parameters

adapter

WebSocketAdapter

container

Container

Returns

WebSocketManager

Methods

close()

close(): Promise<void>

Defined in: src/core/networking/websocket-manager.ts:296

Close the WebSocket manager and underlying adapter

Returns

Promise<void>


enableCompression()

enableCompression(options?): void

Defined in: src/core/networking/websocket-manager.ts:33

Enable compression for the adapter

Parameters

options?

any

Returns

void


getAdapter()

getAdapter(): WebSocketAdapter

Defined in: src/core/networking/websocket-manager.ts:40

Get the underlying adapter

Returns

WebSocketAdapter


getConnectionCount()

getConnectionCount(): number

Defined in: src/core/networking/websocket-manager.ts:47

Get connection count across all namespaces

Returns

number


getNamespace()

getNamespace(namespace): WebSocketNamespace

Defined in: src/core/networking/websocket-manager.ts:54

Create or get a namespace

Parameters

namespace

string

Returns

WebSocketNamespace


registerHandler()

registerHandler(namespace, wsConfig, moduleConfig): Promise<void>

Defined in: src/core/networking/websocket-manager.ts:61

Register WebSocket handlers for a module

Parameters

namespace

WebSocketNamespace

wsConfig

WebSocketDefinition

moduleConfig

ModuleConfig

Returns

Promise<void>


setCustomIdGenerator()

setCustomIdGenerator(generator): void

Defined in: src/core/networking/websocket-manager.ts:26

Set custom ID generator for the adapter

Parameters

generator

() => string

Returns

void