/ fm / liveswitch / WebSocketBase

Class: WebSocketBase

fm.liveswitch.WebSocketBase

WebSocket base properties/methods.

Hierarchy

• WebSocketBase

  ↳ WebSocket

  ↳ WssWebSocketWorker

Table of contents

Constructors

• constructor

Methods

• addOnLatestRoundTripTime
• fmliveswitchWebSocketBaseInit
• getLastRoundTripTime
• getTypeString
• raiseCloseComplete
• raiseOnLatestRoundTripTime
• raiseOpenFailure
• raiseOpenSuccess
• raiseReceive
• raiseStreamFailure
• removeOnLatestRoundTripTime
• setLastRoundTripTime

Constructors

constructor

+ new WebSocketBase(): WebSocketBase

Returns: WebSocketBase

Defined in: Generated/TypeScript/fm.liveswitch/WebSocketBase.ts:26

Methods

addOnLatestRoundTripTime

▸ addOnLatestRoundTripTime(value: IAction1<number>): void

Adds a handler that is raised when the latest round trip time is calculated.

Parameters:

Name	Type
value	IAction1<number>

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebSocketBase.ts:45

---

fmliveswitchWebSocketBaseInit

▸ PrivatefmliveswitchWebSocketBaseInit(): void

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebSocketBase.ts:21

---

getLastRoundTripTime

▸ getLastRoundTripTime(): number

Gets the last round trip time.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/WebSocketBase.ts:57

---

getTypeString

▸ getTypeString(): string

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/WebSocketBase.ts:9

---

raiseCloseComplete

▸ ProtectedraiseCloseComplete(closeArgs: WebSocketCloseArgs, statusCode: WebSocketStatusCode, reason: string): void

Raises the close complete callback.

Parameters:

Name	Type	Description
closeArgs	WebSocketCloseArgs	The close arguments.
statusCode	WebSocketStatusCode	The status code.
reason	string	The reason.

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebSocketBase.ts:72

---

raiseOnLatestRoundTripTime

▸ ProtectedraiseOnLatestRoundTripTime(value: number): void

Raises the OnLatestRoundTripTime event.

Parameters:

Name	Type
value	number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebSocketBase.ts:91

---

raiseOpenFailure

▸ ProtectedraiseOpenFailure(openArgs: WebSocketOpenArgs, statusCode: WebSocketStatusCode, exception: Exception): void

Raises the open failure callback.

Parameters:

Name	Type	Description
openArgs	WebSocketOpenArgs	The open arguments.
statusCode	WebSocketStatusCode	The status code.
exception	Exception	The exception.

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebSocketBase.ts:109

---

raiseOpenSuccess

▸ ProtectedraiseOpenSuccess(openArgs: WebSocketOpenArgs): void

Raises the open success callback.

Parameters:

Name	Type	Description
openArgs	WebSocketOpenArgs	The open arguments.

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebSocketBase.ts:128

---

raiseReceive

▸ ProtectedraiseReceive(openArgs: WebSocketOpenArgs, textMessage: string, binaryMessage: Uint8Array): void

Raises the receive callback.

Parameters:

Name	Type	Description
openArgs	WebSocketOpenArgs	The open arguments.
textMessage	string	The text message.
binaryMessage	Uint8Array	The binary message.

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebSocketBase.ts:147

---

raiseStreamFailure

▸ ProtectedraiseStreamFailure(openArgs: WebSocketOpenArgs, statusCode: WebSocketStatusCode, exception: Exception): void

Raises the stream failure callback.

Parameters:

Name	Type	Description
openArgs	WebSocketOpenArgs	The open arguments.
statusCode	WebSocketStatusCode	The status code.
exception	Exception	The exception.

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebSocketBase.ts:177

---

removeOnLatestRoundTripTime

▸ removeOnLatestRoundTripTime(value: IAction1<number>): void

Removes a handler that is raised when the latest round trip time is calculated.

Parameters:

Name	Type
value	IAction1<number>

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebSocketBase.ts:195

---

setLastRoundTripTime

▸ ProtectedsetLastRoundTripTime(value: number): void

Sets the last round trip time.

Parameters:

Name	Type
value	number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebSocketBase.ts:207