Features
Docs
CLI
Benchmarks
Examples
GitHub

© 2024 MoroJs

@morojs/moro


@morojs/moro / WebSocketAdapter

Interface: WebSocketAdapter

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

Abstract WebSocket adapter interface Allows the framework to work with different WebSocket implementations

Methods

close()

close(): Promise<void>

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

Close the WebSocket server and all connections

Returns

Promise<void>


createNamespace()

createNamespace(namespace): WebSocketNamespace

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

Create a namespace for organizing WebSocket connections

Parameters

namespace

string

Returns

WebSocketNamespace


getAdapterName()

getAdapterName(): string

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

Get adapter name/type

Returns

string


getConnectionCount()

getConnectionCount(): number

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

Get connection count across all namespaces

Returns

number


getDefaultNamespace()

getDefaultNamespace(): WebSocketNamespace

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

Get the default namespace (usually '/')

Returns

WebSocketNamespace


initialize()

initialize(httpServer, options?): Promise<void>

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

Initialize the WebSocket server with the given HTTP server

Parameters

httpServer

any

options?

WebSocketAdapterOptions

Returns

Promise<void>


setCompression()

setCompression(enabled, options?): void

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

Set compression configuration

Parameters

enabled

boolean

options?

any

Returns

void


setCustomIdGenerator()

setCustomIdGenerator(generator): void

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

Set custom ID generator for connections

Parameters

generator

() => string

Returns

void