Skip to main content

SocketConnectionManager

@codebolt/client-sdk


Class: SocketConnectionManager

Defined in: CodeBolt/packages/clientsdk/src/core/socket-connection-manager.ts:19

Constructors

Constructor

new SocketConnectionManager(baseUrl: string, config: CodeBoltConfig): SocketConnectionManager;

Defined in: CodeBolt/packages/clientsdk/src/core/socket-connection-manager.ts:28

Parameters

ParameterType
baseUrlstring
configCodeBoltConfig

Returns

SocketConnectionManager

Methods

addSubscriptions()

addSubscriptions(socketNames: string[]): void;

Defined in: CodeBolt/packages/clientsdk/src/core/socket-connection-manager.ts:87

Parameters

ParameterType
socketNamesstring[]

Returns

void


autoConnect()

autoConnect(preset?: ConnectionPreset): Promise<void>;

Defined in: CodeBolt/packages/clientsdk/src/core/socket-connection-manager.ts:43

Parameters

ParameterType
preset?ConnectionPreset

Returns

Promise<void>


connect()

connect(socketNames: string[]): Promise<void>;

Defined in: CodeBolt/packages/clientsdk/src/core/socket-connection-manager.ts:50

Parameters

ParameterType
socketNamesstring[]

Returns

Promise<void>


disconnect()

disconnect(): void;

Defined in: CodeBolt/packages/clientsdk/src/core/socket-connection-manager.ts:157

Returns

void


getActiveConnections()

getActiveConnections(): string[];

Defined in: CodeBolt/packages/clientsdk/src/core/socket-connection-manager.ts:153

Returns

string[]


onAllEvents()

onAllEvents(callback: (event: SocketEvent) => void): UnsubscribeFn;

Defined in: CodeBolt/packages/clientsdk/src/core/socket-connection-manager.ts:142

Parameters

ParameterType
callback(event: SocketEvent) => void

Returns

UnsubscribeFn


onEvents()

onEvents(filter: EventFilter, callback: (event: SocketEvent) => void): UnsubscribeFn;

Defined in: CodeBolt/packages/clientsdk/src/core/socket-connection-manager.ts:146

Parameters

ParameterType
filterEventFilter
callback(event: SocketEvent) => void

Returns

UnsubscribeFn


removeSubscriptions()

removeSubscriptions(socketNames: string[]): void;

Defined in: CodeBolt/packages/clientsdk/src/core/socket-connection-manager.ts:98

Parameters

ParameterType
socketNamesstring[]

Returns

void


sendToSocket()

sendToSocket(socketName: string, message: unknown): void;

Defined in: CodeBolt/packages/clientsdk/src/core/socket-connection-manager.ts:109

Parameters

ParameterType
socketNamestring
messageunknown

Returns

void


subscribeToSocket()

subscribeToSocket(socketName: string, params?: Record<string, string>): void;

Defined in: CodeBolt/packages/clientsdk/src/core/socket-connection-manager.ts:123

Parameters

ParameterType
socketNamestring
params?Record<string, string>

Returns

void


unsubscribeFromSocket()

unsubscribeFromSocket(socketName: string): void;

Defined in: CodeBolt/packages/clientsdk/src/core/socket-connection-manager.ts:133

Parameters

ParameterType
socketNamestring

Returns

void