Class WebSocket

An implementation of the Connection interface that wraps a WebSocket.

Hierarchy

EventedConnection
- WebSocket

Implements

Connection

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new WebSocket(_ws: WS, _remoteAddress: string): WebSocket

- Defined in src/internal/connection/webSocket.ts:17
Parameters
- _ws: WS
- _remoteAddress: string
Returns WebSocket

Properties

statsTracker

statsTracker: NetworkStatsTracker = new NetworkStatsTracker()

Static defaultMaxListeners

defaultMaxListeners: number

Accessors

promises

get promises(): Map<Guid, QueuedPromise>

Inherited from EventedConnection.promises
- Defined in src/internal/connection/eventedConnection.ts:33
inheritdoc

Returns Map<Guid, QueuedPromise>

quality

get quality(): ConnectionQuality

Inherited from EventedConnection.quality
- Defined in src/internal/connection/eventedConnection.ts:30
inheritdoc

Returns ConnectionQuality

remoteAddress

get remoteAddress(): string

- Defined in src/internal/connection/webSocket.ts:17
Returns string

statsReport

get statsReport(): NetworkStatsReport

Inherited from EventedConnection.statsReport
- Defined in src/internal/connection/eventedConnection.ts:36
A snapshot of this connection's bandwidth usage

inheritdoc

Returns NetworkStatsReport

Methods

addListener

addListener(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from EventEmitter.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/index.d.ts:1081
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

close

close(): void

Implementation of Connection.close

Overrides EventedConnection.close
- Defined in src/internal/connection/webSocket.ts:77
override

Returns void

emit

emit(event: string | symbol, ...args: any[]): boolean

Inherited from EventEmitter.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/index.d.ts:1093
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): Array<string | symbol>

Inherited from EventEmitter.eventNames

Overrides EventEmitter.eventNames
- Defined in node_modules/@types/node/index.d.ts:1094
Returns Array<string | symbol>

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners

Overrides EventEmitter.getMaxListeners
- Defined in node_modules/@types/node/index.d.ts:1090
Returns number

listenerCount

listenerCount(type: string | symbol): number

Inherited from EventEmitter.listenerCount

Overrides EventEmitter.listenerCount
- Defined in node_modules/@types/node/index.d.ts:1095
Parameters
- type: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

Inherited from EventEmitter.listeners

Overrides EventEmitter.listeners
- Defined in node_modules/@types/node/index.d.ts:1091
Parameters
- event: string | symbol
Returns Function[]

off

off(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from EventedConnection.off

Overrides EventEmitter.off
- Defined in src/internal/connection/eventedConnection.ts:51
inheritdoc

Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

on

on(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from EventEmitter.on

Overrides EventEmitter.on
- Defined in node_modules/@types/node/index.d.ts:1082
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

once

once(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from EventEmitter.once

Overrides EventEmitter.once
- Defined in node_modules/@types/node/index.d.ts:1083
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependListener

prependListener(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from EventEmitter.prependListener

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/index.d.ts:1084
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependOnceListener

prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from EventEmitter.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/index.d.ts:1085
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

rawListeners

rawListeners(event: string | symbol): Function[]

Inherited from EventEmitter.rawListeners

Overrides EventEmitter.rawListeners
- Defined in node_modules/@types/node/index.d.ts:1092
Parameters
- event: string | symbol
Returns Function[]

recv

recv(message: Message, serializedMessage?: Buffer): void

Implementation of Connection.recv

Inherited from EventedConnection.recv
- Defined in src/internal/connection/eventedConnection.ts:66
Receives a message.

Parameters
- message: Message
- Optional serializedMessage: Buffer
Returns void

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from EventEmitter.removeAllListeners

Overrides EventEmitter.removeAllListeners
- Defined in node_modules/@types/node/index.d.ts:1088
Parameters
- Optional event: string | symbol
Returns this

removeListener

removeListener(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from EventEmitter.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/index.d.ts:1086
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

send

send(message: Message, serializedMessage?: Buffer): void

Implementation of Connection.send

Inherited from EventedConnection.send
- Defined in src/internal/connection/eventedConnection.ts:61
Sends a message.

Parameters
- message: Message
- Optional serializedMessage: Buffer
Returns void

setMaxListeners

setMaxListeners(n: number): this

Inherited from EventEmitter.setMaxListeners

Overrides EventEmitter.setMaxListeners
- Defined in node_modules/@types/node/index.d.ts:1089
Parameters
- n: number
Returns this

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

Inherited from EventEmitter.listenerCount
- Defined in node_modules/@types/node/index.d.ts:1078
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number