Class WSTransport

WebSocket Transport

Hierarchy

EventEmitter
- WSTransport

Index

Constructors

constructor

Properties

Accessors

uri

Constructors

constructor

new WSTransport(uris: string[], options?: IWSTransportConstructorOptions): WSTransport

- Defined in lib/twilio/wstransport.ts:193
Parameters
- uris: string[]
  
  List of URI of the endpoints to connect to.
- Default value options: IWSTransportConstructorOptions = { }
Returns WSTransport

Properties

state

state: WSTransportState = WSTransportState.Closed

The current state of the WSTransport.

Static defaultMaxListeners

defaultMaxListeners: number

Accessors

uri

get uri(): string | null

- Defined in lib/twilio/wstransport.ts:623
The uri the transport is currently connected to

Returns string | null

Methods

addListener

addListener(event: string | symbol, listener: function): this

Inherited from Backoff.addListener

Overrides EventEmitter.addListener
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

close

close(): void

- Defined in lib/twilio/wstransport.ts:213
Close the WebSocket, and don't try to reconnect.

Returns void

emit

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

Inherited from Backoff.emit

Overrides EventEmitter.emit
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): Array<string | symbol>

Inherited from Backoff.eventNames

Overrides EventEmitter.eventNames
Returns Array<string | symbol>

getMaxListeners

getMaxListeners(): number

Inherited from Backoff.getMaxListeners

Overrides EventEmitter.getMaxListeners
Returns number

listenerCount

listenerCount(type: string | symbol): number

Inherited from Backoff.listenerCount

Overrides EventEmitter.listenerCount
Parameters
- type: string | symbol
Returns number

listeners

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

Inherited from Backoff.listeners

Overrides EventEmitter.listeners
Parameters
- event: string | symbol
Returns Function[]

off

off(event: string | symbol, listener: function): this

Inherited from Backoff.off

Overrides EventEmitter.off
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

on

on(event: string | symbol, listener: function): this

Inherited from Backoff.on

Overrides EventEmitter.on
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

once

once(event: string | symbol, listener: function): this

Inherited from Backoff.once

Overrides EventEmitter.once
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

open

open(): void

- Defined in lib/twilio/wstransport.ts:221
Attempt to open a WebSocket connection.

Returns void

prependListener

prependListener(event: string | symbol, listener: function): this

Inherited from Backoff.prependListener

Overrides EventEmitter.prependListener
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependOnceListener

prependOnceListener(event: string | symbol, listener: function): this

Inherited from Backoff.prependOnceListener

Overrides EventEmitter.prependOnceListener
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

rawListeners

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

Inherited from Backoff.rawListeners

Overrides EventEmitter.rawListeners
Parameters
- event: string | symbol
Returns Function[]

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from Backoff.removeAllListeners

Overrides EventEmitter.removeAllListeners
Parameters
- Optional event: string | symbol
Returns this

removeListener

removeListener(event: string | symbol, listener: function): this

Inherited from Backoff.removeListener

Overrides EventEmitter.removeListener
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

send

send(message: string): boolean

- Defined in lib/twilio/wstransport.ts:243
Send a message through the WebSocket connection.

Parameters
- message: string
  
  A message to send to the endpoint.
Returns boolean

Whether the message was sent.

setMaxListeners

setMaxListeners(n: number): this

Inherited from Backoff.setMaxListeners

Overrides EventEmitter.setMaxListeners
Parameters
- n: number
Returns this

updatePreferredURI

updatePreferredURI(uri: string | null): void

- Defined in lib/twilio/wstransport.ts:270
Update the preferred URI to connect to. Useful for Call signaling reconnection, which requires connecting on the same edge. If null is passed, the preferred URI is unset and the original uris array and uriIndex is used to determine the signaling URI to connect to.

Parameters
- uri: string | null
Returns void

updateURIs

updateURIs(uris: string[] | string): void

- Defined in lib/twilio/wstransport.ts:277
Update acceptable URIs to reconnect to. Resets the URI index to 0.

Parameters
- uris: string[] | string
Returns void

Static listenerCount

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

Inherited from Backoff.listenerCount
deprecated

since v4.0.0

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

Generated using TypeDoc