Class SocketManager

A class which maps client ids to their corresponding sockets (if any).

Hierarchy

SocketManager

Index

Constructors

Properties

Methods

getSocket handleSocketClosed registerSocket sendToSocket

Constructors

constructor

new SocketManager(sockets: Record<string, WebSocket>): SocketManager
Parameters
- sockets: Record<string, WebSocket>
Returns SocketManager
- Defined in src/server/api/socket-manager.ts:8

Properties

`Private` sockets

sockets: Record<string, WebSocket>

Methods

getSocket

getSocket(id: string): WebSocket
Parameters
- id: string
Returns WebSocket
- Defined in src/server/api/socket-manager.ts:18

handleSocketClosed

handleSocketClosed(id: string): void
Parameters
- id: string
Returns void
- Defined in src/server/api/socket-manager.ts:14

registerSocket

registerSocket(id: string, socket: WebSocket): void
Parameters
- id: string
- socket: WebSocket
Returns void
- Defined in src/server/api/socket-manager.ts:10

sendToSocket

sendToSocket(id: string, message: Message): boolean
Sends a message to a socket with the specified id. Returns true if the message was sent successfully, and false otherwise.
Parameters
- id: string
- message: Message
Returns boolean
- Defined in src/server/api/socket-manager.ts:26

Generated using TypeDoc