Class DefaultWebSocketAdapter

Hierarchy

DefaultWebSocketAdapter

Implements

WebSocketAdapter

Index

Constructors

constructor

Methods

Constructors

constructor

new DefaultWebSocketAdapter(logger: Logger): DefaultWebSocketAdapter

- Defined in src/websocketadapter/DefaultWebSocketAdapter.ts:10
Parameters
- logger: Logger
Returns DefaultWebSocketAdapter

Methods

addEventListener

addEventListener(handler: string, eventListener: EventListener): void

Implementation of WebSocketAdapter.addEventListener
- Defined in src/websocketadapter/DefaultWebSocketAdapter.ts:49
Add an event listener for one of the handler types.

Parameters
- handler: string
- eventListener: EventListener
Returns void

close

close(code?: number, reason?: string): void

Implementation of WebSocketAdapter.close
- Defined in src/websocketadapter/DefaultWebSocketAdapter.ts:41
Close the WebSocket connection.

Parameters
- Optional code: number
- Optional reason: string
Returns void

create

create(url: string, protocols: string[], isSignedUrl?: boolean): void

Implementation of WebSocketAdapter.create
- Defined in src/websocketadapter/DefaultWebSocketAdapter.ts:14
Opens a WebSocket connection to the URL with the given protocols.

Parameters
- url: string
- protocols: string[]
- Optional isSignedUrl: boolean
Returns void

destroy

destroy(): void

Implementation of WebSocketAdapter.destroy
- Defined in src/websocketadapter/DefaultWebSocketAdapter.ts:45
Destroys internal reference to the WebSocket.

Returns void

readyState

readyState(): WebSocketReadyState

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

Returns WebSocketReadyState

removeEventListener

removeEventListener(handler: string, eventListener: EventListener): void

Implementation of WebSocketAdapter.removeEventListener
- Defined in src/websocketadapter/DefaultWebSocketAdapter.ts:58
Remove an event listener for one of the handler types.

Parameters
- handler: string
- eventListener: EventListener
Returns void

send

send(message: string | Uint8Array): boolean

Implementation of WebSocketAdapter.send
- Defined in src/websocketadapter/DefaultWebSocketAdapter.ts:19
Sends a raw byte message.

Parameters
- message: string | Uint8Array
Returns boolean

Generated using TypeDoc