Class WebSockets

Class for handling WebSockets connections Keeps track of and delegates the WebSocket connection Also provides methods for retrieving and closing connections

Hierarchy

WebSockets

Index

Constructors

Properties

connections server

Methods

handleConnection handleUpgrade isReady setID stop

Constructors

constructor

new WebSockets(): WebSockets
Constructor for WebSockets class

Returns WebSockets
- Defined in Instance/IO/Wss.ts:25

Properties

`Private` connections

connections: Map<string, WebSocketConnection>

`Private` `Readonly` server

server: WebSocketServer

Methods

`Private` handleConnection

handleConnection(ws: WebSocket): void
Method that handles incoming connections
Parameters
- ws: WebSocket
  
  The WebSocket instance
Returns void
- Defined in Instance/IO/Wss.ts:34

handleUpgrade

handleUpgrade(request: IncomingMessage, socket: Socket, head: Buffer): void
Handle WebSocket upgrade
Parameters
- request: IncomingMessage
  
  IncomingMessage object representing the request to the server
- socket: Socket
  
  Socket object representing the underlying connection
- head: Buffer
  
  Buffer holding the first packet of the upgraded stream
Returns void
- Defined in Instance/IO/Wss.ts:48

isReady

isReady(): Promise<boolean>
Asynchronous method that indicates if the WebSockets server is ready

Returns
A promise that resolves to a boolean indicating if the server is ready

Returns Promise<boolean>
- Defined in Instance/IO/Wss.ts:72

`Private` setID

setID(connection: WebSocketConnection): string
Method that creates a new ID for a connection
Parameters
- connection: WebSocketConnection
Returns string
- Defined in Instance/IO/Wss.ts:56

stop

stop(): Promise<void>
Returns Promise<void>
- Defined in Instance/IO/Wss.ts:65

Generated using TypeDoc