/ fm / liveswitch / WssWebSocketWorker

Class: WssWebSocketWorker

fm.liveswitch.WssWebSocketWorker

Hierarchy

• WebSocketBase

  ↳ WssWebSocketWorker

Implements

• IWebSocket

Table of contents

Constructors

• constructor

Properties

• _aborting
• _closing
• _keepAliveTimeoutId
• _lastReadyState
• _openArgs
• _opening
• _raisedOpenFailure
• _raisedStreamFailure
• _requestUrl
• _worker

Methods

• addOnLatestRoundTripTime
• close
• doCloseWebSocket
• getBufferedAmount
• getIsClosingOrClosed
• getIsOpen
• getLastRoundTripTime
• getSecure
• getTypeString
• handleEventFromWorker
• onClose
• onError
• onMessage
• onOpen
• onReadyState
• open
• processOnClose
• processRTT
• raiseCloseComplete
• raiseOnLatestRoundTripTime
• raiseOpenFailure
• raiseOpenSuccess
• raiseReceive
• raiseStreamFailure
• removeOnLatestRoundTripTime
• send
• sendPing
• setLastRoundTripTime
• startKeepAlive
• stopKeepAlive
• tryCloseWebSocket
• createWorker

Constructors

constructor

+ new WssWebSocketWorker(requestUrl: string): WssWebSocketWorker

Parameters:

Name	Type
requestUrl	string

Returns: WssWebSocketWorker

Inherited from: WebSocketBase

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketWorker.ts:179

Properties

_aborting

• Private _aborting: boolean= false

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketWorker.ts:175

---

_closing

• Private _closing: boolean= false

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketWorker.ts:174

---

_keepAliveTimeoutId

• Private _keepAliveTimeoutId: number= null

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketWorker.ts:179

---

_lastReadyState

• Private _lastReadyState: number

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketWorker.ts:172

---

_openArgs

• Private _openArgs: WebSocketOpenArgs

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketWorker.ts:176

---

_opening

• Private _opening: boolean= false

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketWorker.ts:173

---

_raisedOpenFailure

• Private _raisedOpenFailure: boolean

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketWorker.ts:178

---

_raisedStreamFailure

• Private _raisedStreamFailure: boolean

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

---

_requestUrl

• Private _requestUrl: string

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketWorker.ts:171

---

_worker

• Private _worker: Worker

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketWorker.ts:170

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

Implementation of: IWebSocket

Inherited from: WebSocketBase

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

---

close

▸ close(): void

Returns: void

Implementation of: IWebSocket

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketWorker.ts:188

▸ close(args: WebSocketCloseArgs): void

Parameters:

Name	Type
args	WebSocketCloseArgs

Returns: void

Implementation of: IWebSocket

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketWorker.ts:189

---

doCloseWebSocket

▸ PrivatedoCloseWebSocket(abort: boolean, code: number, reason: string): void

Parameters:

Name	Type
abort	boolean
code	number
reason	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketWorker.ts:356

---

getBufferedAmount

▸ getBufferedAmount(): number

Returns: number

Implementation of: IWebSocket

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketWorker.ts:203

---

getIsClosingOrClosed

▸ PrivategetIsClosingOrClosed(): boolean

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketWorker.ts:211

---

getIsOpen

▸ getIsOpen(): boolean

Returns: boolean

Implementation of: IWebSocket

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

---

getLastRoundTripTime

▸ getLastRoundTripTime(): number

Gets the last round trip time.

Returns: number

Implementation of: IWebSocket

Inherited from: WebSocketBase

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

---

getSecure

▸ getSecure(): boolean

Returns: boolean

Implementation of: IWebSocket

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketWorker.ts:216

---

getTypeString

▸ getTypeString(): string

Returns: string

Inherited from: WebSocketBase

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

---

handleEventFromWorker

▸ PrivatehandleEventFromWorker(event: any): void

Parameters:

Name	Type
event	any

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketWorker.ts:278

---

onClose

▸ PrivateonClose(code: any, reason: any): void

Parameters:

Name	Type
code	any
reason	any

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketWorker.ts:326

---

onError

▸ PrivateonError(data: any): void

Parameters:

Name	Type
data	any

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketWorker.ts:331

---

onMessage

▸ PrivateonMessage(textMessage: string, binaryMessage: Uint8Array): void

Parameters:

Name	Type
textMessage	string
binaryMessage	Uint8Array

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketWorker.ts:322

---

onOpen

▸ PrivateonOpen(readyState: any): void

Parameters:

Name	Type
readyState	any

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketWorker.ts:314

---

onReadyState

▸ PrivateonReadyState(data: any): void

Parameters:

Name	Type
data	any

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketWorker.ts:345

---

open

▸ open(openArgs: WebSocketOpenArgs): void

Parameters:

Name	Type
openArgs	WebSocketOpenArgs

Returns: void

Implementation of: IWebSocket

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketWorker.ts:220

---

processOnClose

▸ PrivateprocessOnClose(code: number, reason: string): void

Parameters:

Name	Type
code	number
reason	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketWorker.ts:369

---

processRTT

▸ PrivateprocessRTT(rtt: number): void

Parameters:

Name	Type
rtt	number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketWorker.ts:414

---

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

Inherited from: WebSocketBase

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

Inherited from: WebSocketBase

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

Inherited from: WebSocketBase

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

Inherited from: WebSocketBase

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

Inherited from: WebSocketBase

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

Inherited from: WebSocketBase

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

Implementation of: IWebSocket

Inherited from: WebSocketBase

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

---

send

▸ send(sendArgs: WebSocketSendArgs): void

Parameters:

Name	Type
sendArgs	WebSocketSendArgs

Returns: void

Implementation of: IWebSocket

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketWorker.ts:266

---

sendPing

▸ PrivatesendPing(): void

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketWorker.ts:400

---

setLastRoundTripTime

▸ ProtectedsetLastRoundTripTime(value: number): void

Sets the last round trip time.

Parameters:

Name	Type
value	number

Returns: void

Inherited from: WebSocketBase

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

---

startKeepAlive

▸ PrivatestartKeepAlive(): void

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketWorker.ts:394

---

stopKeepAlive

▸ PrivatestopKeepAlive(): void

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketWorker.ts:419

---

tryCloseWebSocket

▸ PrivatetryCloseWebSocket(abort: boolean, code: number, reason: string): void

Parameters:

Name	Type
abort	boolean
code	number
reason	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketWorker.ts:349

---

createWorker

▸ StaticcreateWorker(): Worker

Returns: Worker

Defined in: Generated/TypeScript/fm.liveswitch/WssWebSocketWorker.ts:439