Class HSWebSocketConnection

A WebSocket connection to a single client, passed to the callback registered with server.setWebSocketCallback(). Use send() to push messages to the connected client and close() to end the connection. Do not instantiate HSWebSocketConnection directly — it is created by the server when a client performs a WebSocket upgrade.

Index

Constructors

Properties

Methods

close destroy send

Constructors

constructor

new HSWebSocketConnection(): HSWebSocketConnection
Returns HSWebSocketConnection

Properties

`Readonly`identifier

identifier: string

A unique identifier for this connection (UUID string).

Methods

close

close(): void
Close the WebSocket connection to the client. Sends a WebSocket close frame and cancels the underlying TCP connection.

Returns void

destroy

destroy(): void
Destroy this connection object, releasing all resources.

Returns void

send

send(message: string): void
Send a text message to the connected WebSocket client.
Parameters
- message: string
  The text message to send.
Returns void