Class RICChannelWebSocket

Hierarchy

RICChannelWebSocket

Implements

RICChannel

Constructors

constructor

new RICChannelWebSocket(): RICChannelWebSocket

Returns RICChannelWebSocket

Properties

Private _isConnected

_isConnected: boolean = false

Private _onConnEvent

_onConnEvent: null | RICConnEventFn = null

Private _requestedBatchAckSize

_requestedBatchAckSize: number = 10

Private _requestedFileBlockSize

_requestedFileBlockSize: number = 500

Private _ricMsgHandler

_ricMsgHandler: null | RICMsgHandler = null

Private _webSocket

_webSocket: any = null

Methods

_onMsgRx

_onMsgRx(msg: null | Uint8Array): void

- Defined in RICChannelWebSocket.ts:96
Parameters
- msg: null | Uint8Array
Returns void

Private _webSocketOpen

_webSocketOpen(url: string): Promise<WebSocket>

- Defined in RICChannelWebSocket.ts:208
Parameters
- url: string
Returns Promise<WebSocket>

_wsConnect

_wsConnect(locator: string | object): Promise<boolean>

- Defined in RICChannelWebSocket.ts:151
Parameters
- locator: string | object
Returns Promise<boolean>

connect

connect(locator: string | object): Promise<boolean>

Implementation of RICChannel.connect
- Defined in RICChannelWebSocket.ts:70
Parameters
- locator: string | object
Returns Promise<boolean>

disconnect

disconnect(): Promise<void>

Implementation of RICChannel.disconnect
- Defined in RICChannelWebSocket.ts:81
Returns Promise<void>

fhBatchAckSize

fhBatchAckSize(): number

Implementation of RICChannel.fhBatchAckSize
- Defined in RICChannelWebSocket.ts:40
Returns number

fhFileBlockSize

fhFileBlockSize(): number

Implementation of RICChannel.fhFileBlockSize
- Defined in RICChannelWebSocket.ts:41
Returns number

getConnectedLocator

getConnectedLocator(): string | object

Implementation of RICChannel.getConnectedLocator
- Defined in RICChannelWebSocket.ts:65
Returns string | object

isConnected

isConnected(): boolean

Implementation of RICChannel.isConnected
- Defined in RICChannelWebSocket.ts:45
Returns boolean

pauseConnection

pauseConnection(pause: boolean): void

Implementation of RICChannel.pauseConnection
- Defined in RICChannelWebSocket.ts:93
Parameters
- pause: boolean
Returns void

requiresSubscription

requiresSubscription(): boolean

Implementation of RICChannel.requiresSubscription
- Defined in RICChannelWebSocket.ts:55
Returns boolean

sendTxMsg

sendTxMsg(msg: Uint8Array, sendWithResponse: boolean): Promise<boolean>

Implementation of RICChannel.sendTxMsg
- Defined in RICChannelWebSocket.ts:111
Parameters
- msg: Uint8Array
- sendWithResponse: boolean
Returns Promise<boolean>

sendTxMsgNoAwait

sendTxMsgNoAwait(msg: Uint8Array, sendWithResponse: boolean): Promise<boolean>

Implementation of RICChannel.sendTxMsgNoAwait
- Defined in RICChannelWebSocket.ts:133
Parameters
- msg: Uint8Array
- sendWithResponse: boolean
Returns Promise<boolean>

setMsgHandler

setMsgHandler(ricMsgHandler: RICMsgHandler): void

Implementation of RICChannel.setMsgHandler
- Defined in RICChannelWebSocket.ts:50
Parameters
- ricMsgHandler: RICMsgHandler
Returns void

setOnConnEvent

setOnConnEvent(connEventFn: RICConnEventFn): void

Implementation of RICChannel.setOnConnEvent
- Defined in RICChannelWebSocket.ts:60
Parameters
- connEventFn: RICConnEventFn
Returns void

Generated using TypeDoc