@morojs/moro / UWebSocketsAdapter
Class: UWebSocketsAdapter
Defined in: src/core/networking/adapters/uws-adapter.ts:27
uWebSockets adapter implementation Provides high-performance WebSocket support using uWebSockets.js
Implements
Constructors
Constructor
new UWebSocketsAdapter():
UWebSocketsAdapter
Returns
UWebSocketsAdapter
Methods
close()
close():
Promise<void>
Defined in: src/core/networking/adapters/uws-adapter.ts:272
Close the WebSocket server and all connections
Returns
Promise<void>
Implementation of
createNamespace()
createNamespace(
namespace,options?):WebSocketNamespace
Defined in: src/core/networking/adapters/uws-adapter.ts:256
Create a namespace for organizing WebSocket connections
Parameters
namespace
string
options?
Returns
Implementation of
WebSocketAdapter.createNamespace
getAdapterName()
getAdapterName():
string
Defined in: src/core/networking/adapters/uws-adapter.ts:302
Get adapter name/type
Returns
string
Implementation of
WebSocketAdapter.getAdapterName
getApp()
getApp():
any
Defined in: src/core/networking/adapters/uws-adapter.ts:313
Get the underlying uWebSockets app for advanced usage
Returns
any
getConnectionCount()
getConnectionCount():
number
Defined in: src/core/networking/adapters/uws-adapter.ts:306
Get connection count across all namespaces
Returns
number
Implementation of
WebSocketAdapter.getConnectionCount
getDefaultNamespace()
getDefaultNamespace():
WebSocketNamespace
Defined in: src/core/networking/adapters/uws-adapter.ts:268
Get the default namespace (usually '/')
Returns
Implementation of
WebSocketAdapter.getDefaultNamespace
initialize()
initialize(
httpServer,options?):Promise<void>
Defined in: src/core/networking/adapters/uws-adapter.ts:40
Initialize the WebSocket server with the given HTTP server
Parameters
httpServer
any
options?
Returns
Promise<void>
Implementation of
listen()
listen(
port,callback?):void
Defined in: src/core/networking/adapters/uws-adapter.ts:138
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:157
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:291
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:297
Set custom ID generator for connections
Parameters
generator
() => string
Returns
void