/ fm / liveswitch / WebSocket

Class: WebSocket

fm.liveswitch.WebSocket

Hierarchy

• WebSocketBase

  ↳ WebSocket

Implements

• IWebSocket

Table of contents

Constructors

• constructor

Properties

• _aborting
• _closing
• _keepAliveInterval
• _keepAliveTimeout
• _keepAliveTimeoutId
• _onRequestCreated
• _onResponseReceived
• _openArgs
• _opening
• _pingSendTimes
• _protocol
• _raisedOpenFailure
• _raisedStreamFailure
• _requestUrl
• _sendArgs
• _timer
• _webSocket
• _disableBinary

Methods

• addOnLatestRoundTripTime
• close
• doCloseWebSocket
• getBufferedAmount
• getIsClosingOrClosed
• getIsOpen
• getLastRoundTripTime
• getSecure
• getTypeString
• onClose
• onError
• onMessage
• onOpen
• open
• processOnClose
• processPong
• raiseCloseComplete
• raiseOnLatestRoundTripTime
• raiseOnRequestCreated
• raiseOnResponseReceived
• raiseOpenFailure
• raiseOpenSuccess
• raiseReceive
• raiseStreamFailure
• removeOnLatestRoundTripTime
• send
• sendAndTrackPing
• setLastRoundTripTime
• startKeepAlive
• stopKeepAlive
• tryCloseWebSocket
• getDisableBinary
• getExists
• setDisableBinary

Constructors

constructor

+ new WebSocket(requestUrl: string, protocol?: string): WebSocket

Parameters:

Name	Type
requestUrl	string
protocol?	string

Returns: WebSocket

Inherited from: WebSocketBase

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

Properties

_aborting

• Private _aborting: boolean

Defined in: Generated/TypeScript/fm.liveswitch/WebSocket.ts:17

---

_closing

• Private _closing: boolean

Defined in: Generated/TypeScript/fm.liveswitch/WebSocket.ts:16

---

_keepAliveInterval

• Private _keepAliveInterval: number

Defined in: Generated/TypeScript/fm.liveswitch/WebSocket.ts:23

---

_keepAliveTimeout

• Private _keepAliveTimeout: number

Defined in: Generated/TypeScript/fm.liveswitch/WebSocket.ts:24

---

_keepAliveTimeoutId

• Private _keepAliveTimeoutId: number= null

Defined in: Generated/TypeScript/fm.liveswitch/WebSocket.ts:25

---

_onRequestCreated

• Private _onRequestCreated: IAction1<HttpRequestCreatedArgs>

Defined in: Generated/TypeScript/fm.liveswitch/WebSocket.ts:13

---

_onResponseReceived

• Private _onResponseReceived: IAction1<HttpResponseReceivedArgs>

Defined in: Generated/TypeScript/fm.liveswitch/WebSocket.ts:14

---

_openArgs

• Private _openArgs: WebSocketOpenArgs

Defined in: Generated/TypeScript/fm.liveswitch/WebSocket.ts:18

---

_opening

• Private _opening: boolean

Defined in: Generated/TypeScript/fm.liveswitch/WebSocket.ts:15

---

_pingSendTimes

• Private _pingSendTimes: object

Type declaration:

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

---

_protocol

• Private _protocol: string

Defined in: Generated/TypeScript/fm.liveswitch/WebSocket.ts:12

---

_raisedOpenFailure

• Private _raisedOpenFailure: boolean

Defined in: Generated/TypeScript/fm.liveswitch/WebSocket.ts:22

---

_raisedStreamFailure

• Private _raisedStreamFailure: boolean

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

---

_requestUrl

• Private _requestUrl: string

Defined in: Generated/TypeScript/fm.liveswitch/WebSocket.ts:10

---

_sendArgs

• Private _sendArgs: WebSocketSendArgs

Defined in: Generated/TypeScript/fm.liveswitch/WebSocket.ts:19

---

_timer

• Private _timer: number

Defined in: Generated/TypeScript/fm.liveswitch/WebSocket.ts:20

---

_webSocket

• Private _webSocket: any

Defined in: Generated/TypeScript/fm.liveswitch/WebSocket.ts:11

---

_disableBinary

▪ Private Static _disableBinary: boolean= false

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

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/WebSocket.ts:308

▸ close(args: WebSocketCloseArgs): void

Parameters:

Name	Type
args	WebSocketCloseArgs

Returns: void

Implementation of: IWebSocket

Defined in: Generated/TypeScript/fm.liveswitch/WebSocket.ts:309

---

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/WebSocket.ts:188

---

getBufferedAmount

▸ getBufferedAmount(): number

Returns: number

Implementation of: IWebSocket

Defined in: Generated/TypeScript/fm.liveswitch/WebSocket.ts:67

---

getIsClosingOrClosed

▸ PrivategetIsClosingOrClosed(): boolean

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/WebSocket.ts:81

---

getIsOpen

▸ getIsOpen(): boolean

Returns: boolean

Implementation of: IWebSocket

Defined in: Generated/TypeScript/fm.liveswitch/WebSocket.ts:74

---

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/WebSocket.ts:43

---

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: WebSocketBase

Defined in: Generated/TypeScript/fm.liveswitch/WebSocket.ts:5

---

onClose

▸ PrivateonClose(e: CloseEvent): any

Parameters:

Name	Type
e	CloseEvent

Returns: any

Defined in: Generated/TypeScript/fm.liveswitch/WebSocket.ts:160

---

onError

▸ PrivateonError(e: Event): any

Parameters:

Name	Type
e	Event

Returns: any

Defined in: Generated/TypeScript/fm.liveswitch/WebSocket.ts:146

---

onMessage

▸ PrivateonMessage(e: MessageEvent<any>): any

Parameters:

Name	Type
e	MessageEvent<any>

Returns: any

Defined in: Generated/TypeScript/fm.liveswitch/WebSocket.ts:262

---

onOpen

▸ PrivateonOpen(e: Event): any

Parameters:

Name	Type
e	Event

Returns: any

Defined in: Generated/TypeScript/fm.liveswitch/WebSocket.ts:137

---

open

▸ open(args: WebSocketOpenArgs): void

Parameters:

Name	Type
args	WebSocketOpenArgs

Returns: void

Implementation of: IWebSocket

Defined in: Generated/TypeScript/fm.liveswitch/WebSocket.ts:90

---

processOnClose

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

Parameters:

Name	Type
code	number
reason	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebSocket.ts:239

---

processPong

▸ PrivateprocessPong(message: string): void

Parameters:

Name	Type
message	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebSocket.ts:209

---

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

---

raiseOnRequestCreated

▸ PrivateraiseOnRequestCreated(): void

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebSocket.ts:327

---

raiseOnResponseReceived

▸ PrivateraiseOnResponseReceived(): void

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebSocket.ts:336

---

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(args: WebSocketSendArgs): void

Parameters:

Name	Type
args	WebSocketSendArgs

Returns: void

Implementation of: IWebSocket

Defined in: Generated/TypeScript/fm.liveswitch/WebSocket.ts:286

---

sendAndTrackPing

▸ PrivatesendAndTrackPing(): void

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebSocket.ts:199

---

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/WebSocket.ts:166

---

stopKeepAlive

▸ PrivatestopKeepAlive(): void

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebSocket.ts:227

---

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/WebSocket.ts:181

---

getDisableBinary

▸ StaticgetDisableBinary(): boolean

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/WebSocket.ts:36

---

getExists

▸ StaticgetExists(): boolean

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/WebSocket.ts:28

---

setDisableBinary

▸ StaticsetDisableBinary(disableBinary: boolean): void

Parameters:

Name	Type
disableBinary	boolean

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebSocket.ts:32