Class WebsocketServer

WebSocket Server

The WebSocketServer class is used to start and configure the WebSocket service. It provides full-duplex communication channels over a single TCP connection using the WebSocket protocol. This enables real-time, two-way communication between a client (e.g., a web browser) and a server, allowing for interactive web applications.

Hierarchy

WebsocketServer

Index

Constructors

constructor

new WebsocketServer(httpServer): WebsocketServer
Creates a new WebsocketServer instance and starts the server using the provided HTTP server.
Parameters
- httpServer: Server
  
  The HTTP server object used to start the WebSocket server.
Returns WebsocketServer
- Defined in src/websocket/server/server.ts:28

Properties

`Private` connections

connections: WebsocketConnection[] = []

`Private` httpServer

httpServer: Server

The HTTP server object used to start the WebSocket server.

`Private` logging

logging: boolean = false

`Private` server

server: Server<WebSocket>

`Static` `Private` _fetchIpLocation

_fetchIpLocation: boolean = false

Accessors

`Static` fetchIpLocation

get fetchIpLocation(): boolean
Determines whether the connection IP location functionality is enabled.

Returns boolean
A boolean indicating if the connection IP location functionality is enabled.
- Defined in src/websocket/server/server.ts:68

Methods

close

close(): void
Closes the WebSocket server.

Returns void
- Defined in src/websocket/server/server.ts:174

enableLogging

enableLogging(): void
Enables logging of all received messages.

Returns void
- Defined in src/websocket/server/server.ts:51

`Private` getConfiguration

getConfiguration(): ServerOptions
Retrieves the recommended WebSocket server options.

Returns ServerOptions
The server options object.
- Defined in src/websocket/server/server.ts:77

getConnections

getConnections(): WebsocketConnection[]
Retrieves all currently established WebSocket connections.

Returns WebsocketConnection[]
An array of WebsocketConnection objects representing the established connections.
- Defined in src/websocket/server/server.ts:133

`Private` initializeClientInformationExchange

initializeClientInformationExchange(): void
Initializes routes used for framework-internal communication.

Returns void
- Defined in src/websocket/server/server.ts:101

`Private` initializeWebsocketServer

initializeWebsocketServer(): void
Initializes and starts the WebSocket server.

Returns void
- Defined in src/websocket/server/server.ts:35

`Private` loadDecoratorConfiguration

loadDecoratorConfiguration(): void
Returns void
- Defined in src/websocket/server/server.ts:43

onClientInformationReceived

onClientInformationReceived(info, conn): void
Updates the client information of the connection.
Parameters
- info: {
  browser: string;
  }
  
  An object containing descriptions concerning the client device.
  - browser: string
- conn: WebsocketConnection
  
  The associated WebsocketConnection object.
Returns void
- Defined in src/websocket/server/server.ts:121

`Private` onClose

onClose(connection): (() => void)
Handles the WebSocket connection close event.
Parameters
- connection: WebsocketConnection
  
  The closed WebsocketConnection object.
Returns (() => void)
A callback function that removes the closed connection from the list of established connections.
- - (): void
  - Returns void
- Defined in src/websocket/server/server.ts:164

`Private` onConnect

onConnect(connection, req): void
Handles the WebSocket connection event.
Parameters
- connection: WebSocket
  
  The WebSocket connection object.
- req: any
  
  The request object associated with the connection.
Returns void
- Defined in src/websocket/server/server.ts:143

`Static` enableIpLocationFetching

enableIpLocationFetching(): void
Enables the connection IP location functionality. When enabled, location information is fetched for all connections once they establish the connection.

Returns void
- Defined in src/websocket/server/server.ts:59

Class WebsocketServer

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

httpServer: Server

Returns WebsocketServer

Properties

Private connections

Private httpServer

Private logging

Private server

Static Private _fetchIpLocation

Accessors

Static fetchIpLocation

Returns boolean

Methods

close

Returns void

enableLogging

Returns void

Private getConfiguration

Returns ServerOptions

getConnections

Returns WebsocketConnection[]

Private initializeClientInformationExchange

Returns void

Private initializeWebsocketServer

Returns void

Private loadDecoratorConfiguration

Returns void

onClientInformationReceived

Parameters

info: { browser: string; }

browser: string

conn: WebsocketConnection

Returns void

Private onClose

Parameters

connection: WebsocketConnection

Returns (() => void)

Returns void

Private onConnect

Parameters

connection: WebSocket

req: any

Returns void

Static enableIpLocationFetching

Returns void

Settings

Member Visibility

Theme

On This Page

`Private` connections

`Private` httpServer

`Private` logging

`Private` server

`Static` `Private` _fetchIpLocation

`Static` fetchIpLocation

`Private` getConfiguration

`Private` initializeClientInformationExchange

`Private` initializeWebsocketServer

`Private` loadDecoratorConfiguration

info: {
browser: string;
}

`Private` onClose

`Private` onConnect

`Static` enableIpLocationFetching