@morojs/moro / SocketIOAdapter

Class: SocketIOAdapter

Defined in: src/core/networking/adapters/socketio-adapter.ts:17

Socket.IO adapter implementation

Implements

WebSocketAdapter

Constructors

Constructor

new SocketIOAdapter(): SocketIOAdapter

Returns

SocketIOAdapter

Methods

close()

close(): Promise<void>

Defined in: src/core/networking/adapters/socketio-adapter.ts:65

Close the WebSocket server and all connections

Returns

Promise<void>

Implementation of

WebSocketAdapter.close

createNamespace()

createNamespace(namespace): WebSocketNamespace

Defined in: src/core/networking/adapters/socketio-adapter.ts:52

Create a namespace for organizing WebSocket connections

Parameters

namespace

string

Returns

WebSocketNamespace

Implementation of

WebSocketAdapter.createNamespace

getAdapterName()

getAdapterName(): string

Defined in: src/core/networking/adapters/socketio-adapter.ts:92

Get adapter name/type

Returns

string

Implementation of

WebSocketAdapter.getAdapterName

getConnectionCount()

getConnectionCount(): number

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

Get connection count across all namespaces

Returns

number

Implementation of

WebSocketAdapter.getConnectionCount

getDefaultNamespace()

getDefaultNamespace(): WebSocketNamespace

Defined in: src/core/networking/adapters/socketio-adapter.ts:61

Get the default namespace (usually '/')

Returns

WebSocketNamespace

Implementation of

WebSocketAdapter.getDefaultNamespace

initialize()

initialize(httpServer, options): Promise<void>

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

Initialize the WebSocket server with the given HTTP server

Parameters

httpServer

any

options

WebSocketAdapterOptions = {}

Returns

Promise<void>

Implementation of

WebSocketAdapter.initialize

setCompression()

setCompression(enabled, options): void

Defined in: src/core/networking/adapters/socketio-adapter.ts:73

Set compression configuration

Parameters

enabled

boolean

options

any = {}

Returns

void

Implementation of

WebSocketAdapter.setCompression

setCustomIdGenerator()

setCustomIdGenerator(generator): void

Defined in: src/core/networking/adapters/socketio-adapter.ts:85

Set custom ID generator for connections

Parameters

generator

() => string

Returns

void

Implementation of

WebSocketAdapter.setCustomIdGenerator