SocketConnectionManager
Class: SocketConnectionManager
Defined in: CodeBolt/packages/pluginSdk/src/core/socket-connection-manager.ts:19
Constructors
Constructor
new SocketConnectionManager(baseUrl: string, config: CodeBoltConfig): SocketConnectionManager;
Defined in: CodeBolt/packages/pluginSdk/src/core/socket-connection-manager.ts:28
Parameters
| Parameter | Type |
|---|---|
baseUrl | string |
config | CodeBoltConfig |
Returns
SocketConnectionManager
Methods
addSubscriptions()
addSubscriptions(socketNames: string[]): void;
Defined in: CodeBolt/packages/pluginSdk/src/core/socket-connection-manager.ts:87
Parameters
| Parameter | Type |
|---|---|
socketNames | string[] |
Returns
void
autoConnect()
autoConnect(preset?: ConnectionPreset): Promise<void>;
Defined in: CodeBolt/packages/pluginSdk/src/core/socket-connection-manager.ts:43
Parameters
| Parameter | Type |
|---|---|
preset? | ConnectionPreset |
Returns
Promise<void>
connect()
connect(socketNames: string[]): Promise<void>;
Defined in: CodeBolt/packages/pluginSdk/src/core/socket-connection-manager.ts:50
Parameters
| Parameter | Type |
|---|---|
socketNames | string[] |
Returns
Promise<void>
disconnect()
disconnect(): void;
Defined in: CodeBolt/packages/pluginSdk/src/core/socket-connection-manager.ts:157
Returns
void
getActiveConnections()
getActiveConnections(): string[];
Defined in: CodeBolt/packages/pluginSdk/src/core/socket-connection-manager.ts:153
Returns
string[]
onAllEvents()
onAllEvents(callback: (event: SocketEvent) => void): UnsubscribeFn;
Defined in: CodeBolt/packages/pluginSdk/src/core/socket-connection-manager.ts:142
Parameters
| Parameter | Type |
|---|---|
callback | (event: SocketEvent) => void |
Returns
onEvents()
onEvents(filter: EventFilter, callback: (event: SocketEvent) => void): UnsubscribeFn;
Defined in: CodeBolt/packages/pluginSdk/src/core/socket-connection-manager.ts:146
Parameters
| Parameter | Type |
|---|---|
filter | EventFilter |
callback | (event: SocketEvent) => void |
Returns
removeSubscriptions()
removeSubscriptions(socketNames: string[]): void;
Defined in: CodeBolt/packages/pluginSdk/src/core/socket-connection-manager.ts:98
Parameters
| Parameter | Type |
|---|---|
socketNames | string[] |
Returns
void
sendToSocket()
sendToSocket(socketName: string, message: unknown): void;
Defined in: CodeBolt/packages/pluginSdk/src/core/socket-connection-manager.ts:109
Parameters
| Parameter | Type |
|---|---|
socketName | string |
message | unknown |
Returns
void
subscribeToSocket()
subscribeToSocket(socketName: string, params?: Record<string, string>): void;
Defined in: CodeBolt/packages/pluginSdk/src/core/socket-connection-manager.ts:123
Parameters
| Parameter | Type |
|---|---|
socketName | string |
params? | Record<string, string> |
Returns
void
unsubscribeFromSocket()
unsubscribeFromSocket(socketName: string): void;
Defined in: CodeBolt/packages/pluginSdk/src/core/socket-connection-manager.ts:133
Parameters
| Parameter | Type |
|---|---|
socketName | string |
Returns
void