Orderly SDKs / Modules / @orderly.network/net / WS

​

Class: WS

@orderly.network/net.WS

​

Table of contents

​

Constructors

• constructor

​

Properties

• _eventContainer
• _eventHandlers
• _eventPrivateHandlers
• _pendingPrivateSubscribe
• _pendingPublicSubscribe
• _privateHeartbeatTime
• _privateRetryCount
• _publicHeartbeatTime
• _publicRetryCount
• _publicSocket
• authenticated
• options
• privateIsReconnecting
• privateSocket
• publicIsReconnecting
• reconnectInterval

​

Accessors

• accountId
• client

​

Methods

• authenticate
• bindEvents
• checkSocketStatus
• close
• closePrivate
• createPrivateSC
• createPublicSC
• emit
• errorBoardscast
• generateMessage
• getTopicKeyFromMessage
• getTopicKeyFromParams
• handlePendingPrivateTopic
• off
• on
• onMessage
• onNetworkStatusChange
• onOpen
• onPrivateClose
• onPrivateError
• onPrivateMessage
• onPrivateOpen
• onPublicClose
• onPublicError
• onPublicMessage
• onVisibilityChange
• onceSubscribe
• openPrivate
• privateSubscribe
• reconnectPrivate
• reconnectPublic
• send
• subscribe
• unsubscribe
• unsubscribePrivate
• unsubscribePublic

​

Constructors

​

constructor

• new WS(options)

​

Parameters

​

Defined in

ws/ws.ts:82

​

Properties

​

_eventContainer

• Private _eventContainer: Map<string, Set<Function>>

​

Defined in

ws/ws.ts:60

---

​

_eventHandlers

• Private _eventHandlers: Map<string, Topics>

​

Defined in

ws/ws.ts:73

---

​

_eventPrivateHandlers

• Private _eventPrivateHandlers: Map<string, Topics>

​

Defined in

ws/ws.ts:74

---

​

_pendingPrivateSubscribe

• Private _pendingPrivateSubscribe: any[][] = []

​

Defined in

ws/ws.ts:69

---

​

_pendingPublicSubscribe

• Private _pendingPublicSubscribe: any[][] = []

​

Defined in

ws/ws.ts:70

---

​

_privateHeartbeatTime

• Private Optional _privateHeartbeatTime: number

​

Defined in

ws/ws.ts:77

---

​

_privateRetryCount

• Private _privateRetryCount: number = 0

​

Defined in

ws/ws.ts:80

---

​

_publicHeartbeatTime

• Private Optional _publicHeartbeatTime: number

​

Defined in

ws/ws.ts:76

---

​

_publicRetryCount

• Private _publicRetryCount: number = 0

​

Defined in

ws/ws.ts:79

---

​

_publicSocket

• Private _publicSocket: WebSocket

​

Defined in

ws/ws.ts:57

---

​

authenticated

• Private authenticated: boolean = false

​

Defined in

ws/ws.ts:67

---

​

options

• Private options: WSOptions

​

Defined in

ws/ws.ts:82

---

​

privateIsReconnecting

• Private privateIsReconnecting: boolean = false

​

Defined in

ws/ws.ts:63

---

​

privateSocket

• Private Optional privateSocket: WebSocket

​

Defined in

ws/ws.ts:58

---

​

publicIsReconnecting

• Private publicIsReconnecting: boolean = false

​

Defined in

ws/ws.ts:62

---

​

reconnectInterval

• Private reconnectInterval: number = 1000

​

Defined in

ws/ws.ts:65

​

Accessors

​

accountId

• set accountId(accountId): void

​

Parameters

​

Returns

void

​

Defined in

ws/ws.ts:435

---

​

client

• get client(): Object

​

Returns

Object

​

Defined in

ws/ws.ts:716

​

Methods

​

authenticate

▸ Private authenticate(accountId): Promise<void>

​

Parameters

​

Returns

Promise<void>

​

Defined in

ws/ws.ts:437

---

​

bindEvents

▸ Private bindEvents(): void

​

Returns

void

​

Defined in

ws/ws.ts:92

---

​

checkSocketStatus

▸ Private checkSocketStatus(): void Determine the current connection status,

1. If it is disconnected, reconnect
2. If no message is received for too long, disconnect and reconnect actively
3. When returning from the background and the network status changes, the following process is followed

​

Returns

void

​

Defined in

ws/ws.ts:128

---

​

close

▸ close(): void

​

Returns

void

​

Defined in

ws/ws.ts:430

---

​

closePrivate

▸ closePrivate(code?, reason?): void

​

Parameters

​

Returns

void

​

Defined in

ws/ws.ts:184

---

​

createPrivateSC

▸ Private createPrivateSC(options): void

​

Parameters

​

Returns

void

​

Defined in

ws/ws.ts:216

---

​

createPublicSC

▸ Private createPublicSC(options): void

​

Parameters

​

Returns

void

​

Defined in

ws/ws.ts:198

---

​

emit

▸ emit(eventName, message): void

​

Parameters

​

Returns

void

​

Defined in

ws/ws.ts:739

---

​

errorBoardscast

▸ Private errorBoardscast(error, eventHandlers): void

​

Parameters

​

Returns

void

​

Defined in

ws/ws.ts:409

---

​

generateMessage

▸ Private generateMessage(params, onUnsubscribe?, onMessage?): [MessageParams, (event: string) => any]

​

Parameters

​

Returns

[MessageParams, (event: string) => any]

​

Defined in

ws/ws.ts:655

---

​

getTopicKeyFromMessage

▸ Private getTopicKeyFromMessage(message): string

​

Parameters

​

Returns

string

​

Defined in

ws/ws.ts:582

---

​

getTopicKeyFromParams

▸ Private getTopicKeyFromParams(params): string

​

Parameters

​

Returns

string

​

Defined in

ws/ws.ts:565

---

​

handlePendingPrivateTopic

▸ Private handlePendingPrivateTopic(): void

​

Returns

void

​

Defined in

ws/ws.ts:318

---

​

off

▸ off(eventName, callback): void

​

Parameters

​

Returns

void

​

Defined in

ws/ws.ts:733

---

​

on

▸ on(eventName, callback): void

​

Parameters

​

Returns

void

​

Defined in

ws/ws.ts:726

---

​

onMessage

▸ Private onMessage(event, socket, handlerMap): void

​

Parameters

​

Returns

void

​

Defined in

ws/ws.ts:255

---

​

onNetworkStatusChange

▸ Private onNetworkStatusChange(): void

​

Returns

void

​

Defined in

ws/ws.ts:116

---

​

onOpen

▸ Private onOpen(event): void

​

Parameters

​

Returns

void

​

Defined in

ws/ws.ts:231

---

​

onPrivateClose

▸ Private onPrivateClose(event): void

​

Parameters

​

Returns

void

​

Defined in

ws/ws.ts:345

---

​

onPrivateError

▸ Private onPrivateError(event): void

​

Parameters

​

Returns

void

​

Defined in

ws/ws.ts:389

---

​

onPrivateMessage

▸ Private onPrivateMessage(event): void

​

Parameters

​

Returns

void

​

Defined in

ws/ws.ts:312

---

​

onPrivateOpen

▸ Private onPrivateOpen(event): void

​

Parameters

​

Returns

void

​

Defined in

ws/ws.ts:246

---

​

onPublicClose

▸ Private onPublicClose(event): void

​

Parameters

​

Returns

void

​

Defined in

ws/ws.ts:327

---

​

onPublicError

▸ Private onPublicError(event): void

​

Parameters

​

Returns

void

​

Defined in

ws/ws.ts:366

---

​

onPublicMessage

▸ Private onPublicMessage(event): void

​

Parameters

​

Returns

void

​

Defined in

ws/ws.ts:306

---

​

onVisibilityChange

▸ Private onVisibilityChange(): void

​

Returns

void

​

Defined in

ws/ws.ts:106

---

​

onceSubscribe

▸ onceSubscribe(params, callback): void

​

Parameters

​

Returns

void

​

Defined in

ws/ws.ts:603

---

​

openPrivate

▸ openPrivate(accountId): void

​

Parameters

​

Returns

void

​

Defined in

ws/ws.ts:174

---

​

privateSubscribe

▸ privateSubscribe(params, callback): () => void

​

Parameters

​

Returns

fn ▸ (): void

Returns

void

​

Defined in

ws/ws.ts:465

---

​

reconnectPrivate

▸ Private reconnectPrivate(): void

​

Returns

void

​

Defined in

ws/ws.ts:695

---

​

reconnectPublic

▸ Private reconnectPublic(): void

​

Returns

void

​

Defined in

ws/ws.ts:679

---

​

send

▸ send(message): void

​

Parameters

​

Returns

void

​

Defined in

ws/ws.ts:417

---

​

subscribe

▸ subscribe(params, callback, once?, id?): undefined | unsubscribe

​

Parameters

​

Returns

undefined | unsubscribe

​

Defined in

ws/ws.ts:504

---

​

unsubscribe

▸ Private unsubscribe(parmas, webSocket, handlerMap): void

​

Parameters

​

Returns

void

​

Defined in

ws/ws.ts:610

---

​

unsubscribePrivate

▸ Private unsubscribePrivate(parmas): void

​

Parameters

​

Returns

void

​

Defined in

ws/ws.ts:647

---

​

unsubscribePublic

▸ Private unsubscribePublic(parmas): void

​

Parameters

​

Returns

void

​

Defined in

ws/ws.ts:651