Class default

This is a listener for web socket connections.

It wraps the Websocket.Server in a more convenient interface.

Index

Constructors

constructor

new default(): default
Creates the listener.

Returns default
- Defined in misc/ConnectionEstablishment/webSockets/WebSocketListener.ts:46

Properties

onConnection

onConnection: OEvent<(connection: default) => void> = ...

Event is emitted on incoming connections.

onStateChange

onStateChange: OEvent<
    (
        newState: WebSocketListenerState,
        oldState: WebSocketListenerState,
        reason?: string,
    ) => void,
> = ...

Event is emitted when the state of the connector changes. The listener callback will be called in order to have access from outside to the errors that occur on the web socket level.

state

state: WebSocketListenerState

Methods

start

start(host: string, port: number): Promise<void>
Start the web socket listener.
Parameters
- host: string
  The host to listen on
- port: number
  The port to listen on
Returns Promise<void>
- Defined in misc/ConnectionEstablishment/webSockets/WebSocketListener.ts:56

stop

stop(): Promise<void>
Stops the listener

Returns Promise<void>
- Defined in misc/ConnectionEstablishment/webSockets/WebSocketListener.ts:105

Class default

Index

Constructors

Properties

Methods

Constructors

constructor

Returns default

Properties

onConnection

onStateChange

state

Methods

start

Parameters

Returns Promise<void>

stop

Returns Promise<void>

Settings

On This Page