Class WebsocketAPIBase

Hierarchy (View Summary)

WebsocketCommon
- WebsocketAPIBase

Constructors

constructor

new WebsocketAPIBase(
configuration: ConfigurationWebsocketAPI,
connectionPool?: WebsocketConnection[],
): WebsocketAPIBase
Parameters
- configuration: ConfigurationWebsocketAPI
- connectionPool: WebsocketConnection[] = []
Returns WebsocketAPIBase
Overrides WebsocketCommon.constructor
- Defined in common/src/websocket.ts:695

Properties

configuration

configuration: ConfigurationWebsocketAPI

connectionPool

connectionPool: WebsocketConnection[]

logger

logger: Logger = ...

streamCallbackMap

streamCallbackMap: Map<string, Set<(data: unknown) => void>> = ...

Methods

`Protected`cleanup

cleanup(ws: WebSocket): void
Cleans up WebSocket connection resources. Removes all listeners and clears any associated timers for the provided WebSocket client.
Parameters
- ws: WebSocket
  The WebSocket client to clean up.
Returns void
void
Inherited from WebsocketCommon.cleanup
- Defined in common/src/websocket.ts:355

connect

connect(): Promise<void>
Establishes a WebSocket connection to Binance

Returns Promise<void>
Promise that resolves when connection is established

Throws
Error if connection times out
- Defined in common/src/websocket.ts:767

`Protected`connectPool

connectPool(url: string): Promise<void>
Connects all WebSocket connections in the pool
Parameters
- url: string
  The Websocket server URL.
Returns Promise<void>
A promise that resolves when all connections are established.
Inherited from WebsocketCommon.connectPool
- Defined in common/src/websocket.ts:413

`Protected`createWebSocket

createWebSocket(url: string): WebSocket
Creates a new WebSocket client instance.
Parameters
- url: string
  The URL to connect to.
Returns WebSocket
A new WebSocket client instance.
Inherited from WebsocketCommon.createWebSocket
- Defined in common/src/websocket.ts:434

disconnect

disconnect(): Promise<void>
Disconnects from the WebSocket server. If there is no active connection, a warning is logged. Otherwise, all connections in the connection pool are closed gracefully, and a message is logged indicating that the connection has been disconnected.

Returns Promise<void>
A Promise that resolves when all connections have been closed.

Throws
Error if the WebSocket client is not set.
Inherited from WebsocketCommon.disconnect
- Defined in common/src/websocket.ts:575

`Protected`emit

emit(
event: "open" | "message" | "error" | "close" | "ping" | "pong",
...args: any[],
): void
Parameters
- event: "open" | "message" | "error" | "close" | "ping" | "pong"
- ...args: any[]
Returns void
Inherited from WebsocketCommon.emit
- Defined in common/src/websocket.ts:39

`Protected`getAvailableConnections

getAvailableConnections(
allowNonEstablishedWebsockets?: boolean,
): WebsocketConnection[]
Retrieves available WebSocket connections based on the connection mode and readiness. In 'single' mode, returns the first connection in the pool. In 'pool' mode, filters and returns connections that are ready for use.
Parameters
- allowNonEstablishedWebsockets: boolean = false
  Optional flag to include non-established WebSocket connections.
Returns WebsocketConnection[]
An array of available WebSocket connections.
Inherited from WebsocketCommon.getAvailableConnections
- Defined in common/src/websocket.ts:125

`Protected`getConnection

getConnection(allowNonEstablishedWebsockets?: boolean): WebsocketConnection
Gets a WebSocket connection from the pool or single connection. If the connection mode is 'single', it returns the first connection in the pool. If the connection mode is 'pool', it returns an available connection from the pool, using a round-robin selection strategy. If no available connections are found, it throws an error.
Parameters
- allowNonEstablishedWebsockets: boolean = false
  A boolean indicating whether to allow connections that are not established.
Returns WebsocketConnection
The selected WebSocket connection.
Inherited from WebsocketCommon.getConnection
- Defined in common/src/websocket.ts:146

`Protected`getReconnectURL

getReconnectURL(
defaultURL: string,
targetConnection: WebsocketConnection,
): string
Returns the URL to use when reconnecting. Derived classes should override this to provide dynamic URLs.
Parameters
- defaultURL: string
  The URL originally passed during the first connection.
- targetConnection: WebsocketConnection
  The WebSocket connection being connected.
Returns string
The URL to reconnect to.
Inherited from WebsocketCommon.getReconnectURL
- Defined in common/src/websocket.ts:404

`Protected`initConnect

initConnect(
    url: string,
    isRenewal?: boolean,
    connection?: WebsocketConnection,
): undefined | WebsocketConnection
Initializes a WebSocket connection.
Parameters
- url: string
  The Websocket server URL.
- isRenewal: boolean = false
  Whether this is a connection renewal.
- Optionalconnection: WebsocketConnection
  An optional WebSocket connection to use.
Returns undefined | WebsocketConnection
The WebSocket connection.
Inherited from WebsocketCommon.initConnect
- Defined in common/src/websocket.ts:452

isConnected

isConnected(connection?: WebsocketConnection): boolean
Checks if the WebSocket connection is currently open.
Parameters
- Optionalconnection: WebsocketConnection
  An optional WebSocket connection to check. If not provided, the entire connection pool is checked.
Returns boolean
true if the connection is open, false otherwise.
Inherited from WebsocketCommon.isConnected
- Defined in common/src/websocket.ts:562

`Protected`isConnectionReady

isConnectionReady(
connection: WebsocketConnection,
allowNonEstablishedWebsockets?: boolean,
): boolean
Checks if the provided WebSocket connection is ready for use. A connection is considered ready if it is open, has no pending reconnection, and has not been closed.
Parameters
- connection: WebsocketConnection
  The WebSocket connection to check.
- allowNonEstablishedWebsockets: boolean = false
  An optional flag to allow non-established WebSocket connections.
Returns boolean
true if the connection is ready, false otherwise.
Inherited from WebsocketCommon.isConnectionReady
- Defined in common/src/websocket.ts:167

off

off(
event: "open" | "message" | "error" | "close" | "ping" | "pong",
listener: (...args: any[]) => void,
): void
Parameters
- event: "open" | "message" | "error" | "close" | "ping" | "pong"
- listener: (...args: any[]) => void
Returns void
Inherited from WebsocketCommon.off
- Defined in common/src/websocket.ts:31

on

on(
event: "open" | "message" | "error" | "close" | "ping" | "pong",
listener: (...args: any[]) => void,
): void
Parameters
- event: "open" | "message" | "error" | "close" | "ping" | "pong"
- listener: (...args: any[]) => void
Returns void
Inherited from WebsocketCommon.on
- Defined in common/src/websocket.ts:23

`Protected`onMessage

onMessage<T>(data: string, connection: WebsocketConnection): void
Processes incoming WebSocket messages
Type Parameters
- T
Parameters
- data: string
  The raw message data received
- connection: WebsocketConnection
Returns void
Overrides WebsocketCommon.onMessage
- Defined in common/src/websocket.ts:725

`Protected`onOpen

onOpen(
    url: string,
    targetConnection: WebsocketConnection,
    oldWSConnection: WebSocket,
): void
Handles the opening of a WebSocket connection.
Parameters
- url: string
  The URL of the WebSocket server.
- targetConnection: WebsocketConnection
  The WebSocket connection being opened.
- oldWSConnection: WebSocket
  The WebSocket client instance associated with the old connection.
Returns void
Inherited from WebsocketCommon.onOpen
- Defined in common/src/websocket.ts:377

pingServer

pingServer(): void
Sends a ping message to all connected Websocket servers in the pool. If no connections are ready, a warning is logged. For each active connection, the ping message is sent, and debug logs provide details.

Returns void
Throws
Error if a Websocket client is not set for a connection.
Inherited from WebsocketCommon.pingServer
- Defined in common/src/websocket.ts:599

`Protected`send

send<T = unknown>(
    payload: string,
    id?: string,
    promiseBased?: boolean,
    timeout?: number,
    connection?: WebsocketConnection,
): void | Promise<WebsocketApiResponse<T>>
Sends a payload through the WebSocket connection.
Type Parameters
- T = unknown
Parameters
- payload: string
  Message to send.
- Optionalid: string
  Optional request identifier.
- promiseBased: boolean = true
  Whether to return a promise.
- timeout: number = 5000
  Timeout duration in milliseconds.
- Optionalconnection: WebsocketConnection
  The WebSocket connection to use.
Returns void | Promise<WebsocketApiResponse<T>>
A promise if promiseBased is true, void otherwise.

Throws
Error if not connected or WebSocket client is not set.
Inherited from WebsocketCommon.send
- Defined in common/src/websocket.ts:631

sendMessage

sendMessage<T>(
    method: string,
    payload: WebsocketSendMsgOptions,
    options: WebsocketSendMsgConfig & { isSessionLogon: true },
): Promise<WebsocketApiResponse<T>[]>
Type Parameters
- T
Parameters
- method: string
- payload: WebsocketSendMsgOptions
- options: WebsocketSendMsgConfig & { isSessionLogon: true }
Returns Promise<WebsocketApiResponse<T>[]>
- Defined in common/src/websocket.ts:797
sendMessage<T>(
    method: string,
    payload: WebsocketSendMsgOptions,
    options: WebsocketSendMsgConfig & { isSessionLogout: true },
): Promise<WebsocketApiResponse<T>[]>
Type Parameters
- T
Parameters
- method: string
- payload: WebsocketSendMsgOptions
- options: WebsocketSendMsgConfig & { isSessionLogout: true }
Returns Promise<WebsocketApiResponse<T>[]>
- Defined in common/src/websocket.ts:803
sendMessage<T>(
    method: string,
    payload?: WebsocketSendMsgOptions,
    options?: WebsocketSendMsgConfig,
): Promise<WebsocketApiResponse<T>>
Type Parameters
- T
Parameters
- method: string
- Optionalpayload: WebsocketSendMsgOptions
- Optionaloptions: WebsocketSendMsgConfig
Returns Promise<WebsocketApiResponse<T>>
- Defined in common/src/websocket.ts:809

Class WebsocketAPIBase

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns WebsocketAPIBase

Properties

configuration

connectionPool

logger

streamCallbackMap

Methods

Protectedcleanup

Parameters

Returns void

connect

Returns Promise<void>

Throws

ProtectedconnectPool

Parameters

Returns Promise<void>

ProtectedcreateWebSocket

Parameters

Returns WebSocket

disconnect

Returns Promise<void>

Throws

Protectedemit

Parameters

Returns void

ProtectedgetAvailableConnections

Parameters

Returns WebsocketConnection[]

ProtectedgetConnection

Parameters

Returns WebsocketConnection

ProtectedgetReconnectURL

Parameters

Returns string

ProtectedinitConnect

Parameters

Returns undefined | WebsocketConnection

isConnected

Parameters

Returns boolean

ProtectedisConnectionReady

Parameters

Returns boolean

off

Parameters

Returns void

on

Parameters

Returns void

ProtectedonMessage

Type Parameters

Parameters

Returns void

ProtectedonOpen

Parameters

Returns void

pingServer

Returns void

Throws

Protectedsend

Type Parameters

Parameters

Returns void | Promise<WebsocketApiResponse<T>>

Throws

sendMessage

Type Parameters

Parameters

Returns Promise<WebsocketApiResponse<T>[]>

Type Parameters

Parameters

Returns Promise<WebsocketApiResponse<T>[]>

`Protected`cleanup

`Protected`connectPool

`Protected`createWebSocket

`Protected`emit

`Protected`getAvailableConnections

`Protected`getConnection

`Protected`getReconnectURL

`Protected`initConnect

`Protected`isConnectionReady

`Protected`onMessage

`Protected`onOpen

`Protected`send