@morojs/moro / UWebSocketsAdapter

Class: UWebSocketsAdapter

Defined in: src/core/networking/adapters/uws-adapter.ts:20

uWebSockets adapter implementation Provides high-performance WebSocket support using uWebSockets.js

Implements

WebSocketAdapter

Constructors

Constructor

new UWebSocketsAdapter(): UWebSocketsAdapter

Returns

UWebSocketsAdapter

Methods

close()

close(): Promise<void>

Defined in: src/core/networking/adapters/uws-adapter.ts:244

Close the WebSocket server and all connections

Returns

Promise<void>

Implementation of

WebSocketAdapter.close

createNamespace()

createNamespace(namespace): WebSocketNamespace

Defined in: src/core/networking/adapters/uws-adapter.ts:231

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/uws-adapter.ts:273

Get adapter name/type

Returns

string

Implementation of

WebSocketAdapter.getAdapterName

getApp()

getApp(): any

Defined in: src/core/networking/adapters/uws-adapter.ts:284

Get the underlying uWebSockets app for advanced usage

Returns

any

getConnectionCount()

getConnectionCount(): number

Defined in: src/core/networking/adapters/uws-adapter.ts:277

Get connection count across all namespaces

Returns

number

Implementation of

WebSocketAdapter.getConnectionCount

getDefaultNamespace()

getDefaultNamespace(): WebSocketNamespace

Defined in: src/core/networking/adapters/uws-adapter.ts:240

Get the default namespace (usually '/')

Returns

WebSocketNamespace

Implementation of

WebSocketAdapter.getDefaultNamespace

initialize()

initialize(httpServer, options): Promise<void>

Defined in: src/core/networking/adapters/uws-adapter.ts:33

Initialize the WebSocket server with the given HTTP server

Parameters

httpServer

any

options

WebSocketAdapterOptions = {}

Returns

Promise<void>

Implementation of

WebSocketAdapter.initialize

listen()

listen(port, callback?): void

Defined in: src/core/networking/adapters/uws-adapter.ts:122

Start listening on a specific port This is necessary because uWebSockets.js manages its own server

Parameters

port

number

callback?

(token) => void

Returns

void

listenWithHost()

listenWithHost(host, port, callback?): void

Defined in: src/core/networking/adapters/uws-adapter.ts:141

Start listening on host and port

Parameters

host

string

port

number

callback?

(token) => void

Returns

void

setCompression()

setCompression(enabled, options?): void

Defined in: src/core/networking/adapters/uws-adapter.ts:262

Set compression configuration

Parameters

enabled

boolean

options?

any

Returns

void

Implementation of

WebSocketAdapter.setCompression

setCustomIdGenerator()

setCustomIdGenerator(generator): void

Defined in: src/core/networking/adapters/uws-adapter.ts:268

Set custom ID generator for connections

Parameters

generator

() => string

Returns

void

Implementation of

WebSocketAdapter.setCustomIdGenerator