Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface WebSocketChain<RequestType, ResponseType, UnderlyingDataType, UserInfo>

Sockets configured as a chain, where each chain link represents group of sockets to be initialized and opened concurrently, but chain links are initialized in sequence. New chain link is obtained through the call of the WebSocketChainLink.socketsReady function. The sockets from the first chain link are initialized immediately (but not opened) and available in WebSocketsOwnerService from the beginning.

Type Parameters

  • RequestType

  • ResponseType

  • UnderlyingDataType extends string | ArrayBufferLike | Blob | ArrayBufferView

  • UserInfo

Hierarchy

  • WebSocketChain

Index

Properties

chain: WebSocketChainLink<RequestType, ResponseType, UserInfo>

Sockets to be opened, when WebSocketsOwnerService.init is called. Sockets from the first chain link are initialized (but not opened) in WebSocketChainLink constructor, so they are available immediately. The sockets from consequent chain links are available after the observable, returned by WebSocketsOwnerService.init have completed.

commonConfig: CommonWebSocketConfig<RequestType, ResponseType, UnderlyingDataType>

Fields of the WebSocketControllerConfig common for all sockets.

commonOpenOptions: WebSocketOpenOptions

Will be passed as argument to every WebSocketController.open method.

Usually you want to enable reconnect.

commonOpenOptions: {
autoReconnect: {
interval: () => Math.floor(reopenDelayMin + Math.random() * reopenDelaySpan),
}
},

Generated using TypeDoc