Class WebSocketBase

WebSocket base properties/methods.

Hierarchy

WebSocketBase

Index

Constructors

constructor

Methods

Constructors

constructor

new WebSocketBase(): WebSocketBase

- Defined in fm.icelink/WebSocketBase.ts:11
Returns WebSocketBase

Methods

getTypeString

getTypeString(): string

- Defined in fm.icelink/WebSocketBase.ts:9
Returns string

Protected raiseCloseComplete

raiseCloseComplete(closeArgs: WebSocketCloseArgs, statusCode: WebSocketStatusCode, reason: string): void

- Defined in fm.icelink/WebSocketBase.ts:34
Raises the close complete callback.

Parameters
- closeArgs: WebSocketCloseArgs
  
  The close arguments.
- statusCode: WebSocketStatusCode
  
  The status code.
- reason: string
  
  The reason.
Returns void

Protected raiseOpenFailure

raiseOpenFailure(openArgs: WebSocketOpenArgs, statusCode: WebSocketStatusCode, exception: Exception): void

- Defined in fm.icelink/WebSocketBase.ts:58
Raises the open failure callback.

Parameters
- openArgs: WebSocketOpenArgs
  
  The open arguments.
- statusCode: WebSocketStatusCode
  
  The status code.
- exception: Exception
  
  The exception.
Returns void

Protected raiseOpenSuccess

raiseOpenSuccess(openArgs: WebSocketOpenArgs): void

- Defined in fm.icelink/WebSocketBase.ts:80
Raises the open success callback.

Parameters
- openArgs: WebSocketOpenArgs
  
  The open arguments.
Returns void

Protected raiseReceive

raiseReceive(openArgs: WebSocketOpenArgs, textMessage: string, binaryMessage: Uint8Array): void

- Defined in fm.icelink/WebSocketBase.ts:102
Raises the receive callback.

Parameters
- openArgs: WebSocketOpenArgs
  
  The open arguments.
- textMessage: string
  
  The text message.
- binaryMessage: Uint8Array
  
  The binary message.
Returns void

Protected raiseStreamFailure

raiseStreamFailure(openArgs: WebSocketOpenArgs, statusCode: WebSocketStatusCode, exception: Exception): void

- Defined in fm.icelink/WebSocketBase.ts:126
Raises the stream failure callback.

Parameters
- openArgs: WebSocketOpenArgs
  
  The open arguments.
- statusCode: WebSocketStatusCode
  
  The status code.
- exception: Exception
  
  The exception.
Returns void