Class WebSocketService

WebSocketService - Manages WebSocket server.

Index

Constructors

Methods

close getServer initialize

Constructors

constructor

new WebSocketService(backend: Backend): WebSocketService
Constructor.
Parameters
- backend: Backend
  Backend instance for connection callbacks
Returns WebSocketService
- Defined in packages/server/src/services/websocket/WebSocketService.ts:48

Methods

close

close(): void
Close WebSocket server.

Returns void
- Defined in packages/server/src/services/websocket/WebSocketService.ts:246

getServer

getServer(): WebSocketServer | null
Get the WebSocket server instance.

Returns WebSocketServer | null
- Defined in packages/server/src/services/websocket/WebSocketService.ts:239

initialize

initialize(
httpServer: Server,
sessionMiddleware: RequestHandler,
): WebSocketServer
Initialize WebSocket server.
Parameters
- httpServer: Server
  HTTP server to attach to
- sessionMiddleware: RequestHandler
  Express session middleware
Returns WebSocketServer
WebSocket server instance
- Defined in packages/server/src/services/websocket/WebSocketService.ts:59