Class WebSocketClient

You must provide an error handler addEventListener('error'). Otherwise, errors will just be ignored.

Events:

EventWebSocketClientDestroy
EventWebSocketClientDestroyed
EventWebSocketClientError - includes re-dispatched EventWebSocketConnectionError
EventWebSocketClientClose
EventWebSocketConnection - all dispatched events from WebSocketConnection

Hierarchy

CreateDestroy
- WebSocketClient

Properties

`Readonly` [initLock]

[initLock]: RWLockWriter

`Protected` _closed

_closed: boolean = false

`Protected` address

address: string

`Readonly` closedP

closedP: Promise<void>

Resolved when the underlying server is closed.

`Readonly` connection

connection: WebSocketConnection

The connection of the client.

`Readonly` connectionMap

connectionMap: WebSocketConnectionMap = ...

Map of connections with connectionId keys that correspond to WebSocketConnection values.

`Protected` logger

logger: Logger

`Protected` resolveClosedP

resolveClosedP: (() => void)

Type declaration

- (): void
- Returns void

Accessors

[destroyed]

get [destroyed](): boolean
Returns boolean
Inherited from createDestroy.CreateDestroy.__@destroyed@24169
- Defined in node_modules/@matrixai/async-init/dist/CreateDestroy.d.ts:6

[eventHandled]

get [eventHandled](): ReadonlyWeakSet<Event>
Returns ReadonlyWeakSet<Event>
Inherited from createDestroy.CreateDestroy.__@eventHandled@24062
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:7

[eventHandlers]

get [eventHandlers](): ReadonlyMap<string, Set<EventHandlerInfo>>
Returns ReadonlyMap<string, Set<EventHandlerInfo>>
Inherited from createDestroy.CreateDestroy.__@eventHandlers@24060
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:6

[eventTarget]

get [eventTarget](): EventTarget
Returns EventTarget
Inherited from createDestroy.CreateDestroy.__@eventTarget@24058
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:5

[handleEventError]

get [handleEventError](): ((evt: EventError) => void)
Returns ((evt: EventError) => void)
- - (evt: EventError): void
  - Parameters
    - evt: EventError
    Returns void
Inherited from createDestroy.CreateDestroy.__@handleEventError@24064
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:8

[statusP]

get [statusP](): Promise<Status>
Returns Promise<Status>
Inherited from createDestroy.CreateDestroy.__@statusP@24173
- Defined in node_modules/@matrixai/async-init/dist/CreateDestroy.d.ts:8

[status]

get [status](): Status
Returns Status
Inherited from createDestroy.CreateDestroy.__@status@24171
- Defined in node_modules/@matrixai/async-init/dist/CreateDestroy.d.ts:7

closed

get closed(): boolean
Boolean that indicates whether the internal server is closed or not.

Returns boolean
- Defined in src/WebSocketClient.ts:279

Methods

addEventListener

addEventListener(type: string, callback: null | EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void
Parameters
- type: string
- callback: null | EventListenerOrEventListenerObject
- Optional options: boolean | AddEventListenerOptions
Returns void
Inherited from createDestroy.CreateDestroy.addEventListener
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:9

destroy

destroy(opts?: {
    errorCode?: number;
    errorMessage?: string;
    force?: boolean;
}): Promise<void>
Destroys WebSocketClient
Parameters
- opts: {
      errorCode?: number;
      errorMessage?: string;
      force?: boolean;
  } = {}
  - Optional errorCode?: number
    
    The error code to send to connections on closing
  - Optional errorMessage?: string
    
    The error message to send to connections on closing
  - Optional force?: boolean
    
    When force is false, the returned promise will wait for all streams and connections to close naturally before resolving.
Returns Promise<void>
Inherited from createDestroy.CreateDestroy.destroy
- Defined in src/WebSocketClient.ts:315

dispatchEvent

dispatchEvent(event: Event): boolean
Parameters
- event: Event
Returns boolean
Inherited from createDestroy.CreateDestroy.dispatchEvent
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:11

`Protected` handleEventWebSocketClientClose

handleEventWebSocketClientClose(): Promise<void>
Returns Promise<void>
- Defined in src/WebSocketClient.ts:232

`Protected` handleEventWebSocketClientError

handleEventWebSocketClientError(evt: EventWebSocketClientError): Promise<void>
Parameters
- evt: EventWebSocketClientError
Returns Promise<void>
- Defined in src/WebSocketClient.ts:210

`Protected` handleEventWebSocketConnection

handleEventWebSocketConnection(evt: EventAll<Event>): void
Parameters
- evt: EventAll<Event>
Returns void
- Defined in src/WebSocketClient.ts:258

`Protected` handleEventWebSocketConnectionError

handleEventWebSocketConnectionError(evt: EventWebSocketConnectionError): void
All connection errors are redispatched as client errors. Connection errors encompass both graceful closes and non-graceful closes. This also includes ErrorWebSocketConnectionInternal
Parameters
- evt: EventWebSocketConnectionError
Returns void
- Defined in src/WebSocketClient.ts:269

`Protected` handleEventWebSocketConnectionStopped

handleEventWebSocketConnectionStopped(evt: EventWebSocketConnectionStopped): Promise<void>
Parameters
- evt: EventWebSocketConnectionStopped
Returns Promise<void>
- Defined in src/WebSocketClient.ts:242

removeEventListener

removeEventListener(type: string, callback: null | EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void
Parameters
- type: string
- callback: null | EventListenerOrEventListenerObject
- Optional options: boolean | EventListenerOptions
Returns void
Inherited from createDestroy.CreateDestroy.removeEventListener
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:10

`Static` createWebSocketClient

createWebSocketClient(__namedParameters: {
    codeToReason?: StreamCodeToReason;
    config?: Partial<WebSocketConfig>;
    host: string;
    logger?: Logger;
    port: number;
    reasonToCode?: StreamReasonToCode;
    resolveHostname?: ResolveHostname;
}, ctx?: Partial<ContextTimedInput>): Promise<WebSocketClient>
Creates a WebSocketClient

Throws

Throws

Throws
- re-dispatched from WebSocketConnection
Parameters
- __namedParameters: {
      codeToReason?: StreamCodeToReason;
      config?: Partial<WebSocketConfig>;
      host: string;
      logger?: Logger;
      port: number;
      reasonToCode?: StreamReasonToCode;
      resolveHostname?: ResolveHostname;
  }
  - Optional codeToReason?: StreamCodeToReason
  - Optional config?: Partial<WebSocketConfig>
  - host: string
  - Optional logger?: Logger
  - port: number
  - Optional reasonToCode?: StreamReasonToCode
  - Optional resolveHostname?: ResolveHostname
- Optional ctx: Partial<ContextTimedInput>
Returns Promise<WebSocketClient>
- Defined in src/WebSocketClient.ts:51

Class WebSocketClient

Hierarchy

Index

Properties

Accessors

Methods

Properties

Readonly [initLock]

Protected _closed

Protected address

Readonly closedP

Readonly connection

Readonly connectionMap

Protected logger

Protected resolveClosedP

Type declaration

Returns void

Accessors

[destroyed]

Returns boolean

[eventHandled]

Returns ReadonlyWeakSet<Event>

[eventHandlers]

Returns ReadonlyMap<string, Set<EventHandlerInfo>>

[eventTarget]

Returns EventTarget

[handleEventError]

Returns ((evt: EventError) => void)

Parameters

evt: EventError

Returns void

[statusP]

Returns Promise<Status>

[status]

Returns Status

closed

Returns boolean

Methods

addEventListener

Parameters

type: string

callback: null | EventListenerOrEventListenerObject

Optional options: boolean | AddEventListenerOptions

Returns void

destroy

Parameters

opts: { errorCode?: number; errorMessage?: string; force?: boolean; } = {}

Optional errorCode?: number

Optional errorMessage?: string

Optional force?: boolean

Returns Promise<void>

dispatchEvent

Parameters

event: Event

Returns boolean

Protected handleEventWebSocketClientClose

Returns Promise<void>

Protected handleEventWebSocketClientError

Parameters

evt: EventWebSocketClientError

Returns Promise<void>

Protected handleEventWebSocketConnection

Parameters

evt: EventAll<Event>

Returns void

Protected handleEventWebSocketConnectionError

Parameters

evt: EventWebSocketConnectionError

Returns void

Protected handleEventWebSocketConnectionStopped

Parameters

evt: EventWebSocketConnectionStopped

Returns Promise<void>

removeEventListener

Parameters

type: string

callback: null | EventListenerOrEventListenerObject

Optional options: boolean | EventListenerOptions

Returns void

Static createWebSocketClient

`Readonly` [initLock]

`Protected` _closed

`Protected` address

`Readonly` closedP

`Readonly` connection

`Readonly` connectionMap

`Protected` logger

`Protected` resolveClosedP

`Optional` options: boolean | AddEventListenerOptions

opts: {
errorCode?: number;
errorMessage?: string;
force?: boolean;
} = {}

`Optional` errorCode?: number

`Optional` errorMessage?: string

`Optional` force?: boolean

`Protected` handleEventWebSocketClientClose

`Protected` handleEventWebSocketClientError

`Protected` handleEventWebSocketConnection

`Protected` handleEventWebSocketConnectionError

`Protected` handleEventWebSocketConnectionStopped

`Optional` options: boolean | EventListenerOptions

`Static` createWebSocketClient

__namedParameters: {
codeToReason?: StreamCodeToReason;
config?: Partial<WebSocketConfig>;
host: string;
logger?: Logger;
port: number;
reasonToCode?: StreamReasonToCode;
resolveHostname?: ResolveHostname;
}

`Optional` codeToReason?: StreamCodeToReason

`Optional` config?: Partial<WebSocketConfig>

`Optional` logger?: Logger

`Optional` reasonToCode?: StreamReasonToCode

`Optional` resolveHostname?: ResolveHostname

`Optional` ctx: Partial<ContextTimedInput>