Class DefaultWebSocketAdapter

Adapter for WebSocket implementations

Implements

WebSocketAdapter

Index

Constructors

Methods

addEventListener close create destroy readyState removeEventListener send

Constructors

constructor

new DefaultWebSocketAdapter(logger: Logger): DefaultWebSocketAdapter
Parameters
- logger: Logger
Returns DefaultWebSocketAdapter
- Defined in src/websocketadapter/DefaultWebSocketAdapter.ts:12

Methods

addEventListener

addEventListener(handler: string, eventListener: EventListener): void
Add an event listener for one of the handler types.
Parameters
- handler: string
  The handler being assigned.
- eventListener: EventListener
  The event listener to add.
Returns void
Implementation of WebSocketAdapter.addEventListener
- Defined in src/websocketadapter/DefaultWebSocketAdapter.ts:49

close

close(code?: number, reason?: string): void
Close the WebSocket connection.
Parameters
- Optionalcode: number
- Optionalreason: string
Returns void
Implementation of WebSocketAdapter.close
- Defined in src/websocketadapter/DefaultWebSocketAdapter.ts:41

create

create(url: string, protocols: string[], isSignedUrl?: boolean): void
Opens a WebSocket connection to the URL with the given protocols.
Parameters
- url: string
  URL to connect to
- protocols: string[]
  Protocols to send when establishing the connection
- OptionalisSignedUrl: boolean
  whether the URL is signed
Returns void
Implementation of WebSocketAdapter.create
- Defined in src/websocketadapter/DefaultWebSocketAdapter.ts:14

destroy

destroy(): void
Destroys internal reference to the WebSocket.

Returns void
Implementation of WebSocketAdapter.destroy
- Defined in src/websocketadapter/DefaultWebSocketAdapter.ts:45

readyState

readyState(): WebSocketReadyState
Returns the ready state.

Returns WebSocketReadyState
The state of the WebSocketConnection
Implementation of WebSocketAdapter.readyState
- Defined in src/websocketadapter/DefaultWebSocketAdapter.ts:62

removeEventListener

removeEventListener(handler: string, eventListener: EventListener): void
Remove an event listener for one of the handler types.
Parameters
- handler: string
  The handler being assigned.
- eventListener: EventListener
  The event listener to add.
Returns void
Implementation of WebSocketAdapter.removeEventListener
- Defined in src/websocketadapter/DefaultWebSocketAdapter.ts:58

send

send(message: string | Uint8Array<ArrayBufferLike>): boolean
Sends a raw byte message.
Parameters
- message: string | Uint8Array<ArrayBufferLike>
  byte or string message to send
Returns boolean
Whether the data was queued for sending
Implementation of WebSocketAdapter.send
- Defined in src/websocketadapter/DefaultWebSocketAdapter.ts:19