SwarmSocket

@codebolt/client-sdk

---

Class: SwarmSocket

Defined in: CodeBolt/packages/clientsdk/src/sockets/swarm.socket.ts:16

Swarm WebSocket - Socket.IO based swarm management. Supports rooms, agent registration, team management, roles, spawn/termination requests.

Extends

• TypedEventEmitter<SwarmSocketEvents>

Constructors

Constructor

new SwarmSocket(baseUrl: string, options?: SocketIOClientOptions): SwarmSocket;

Defined in: CodeBolt/packages/clientsdk/src/sockets/swarm.socket.ts:19

Parameters

Parameter	Type
baseUrl	string
options?	SocketIOClientOptions

Returns

SwarmSocket

Overrides

TypedEventEmitter.constructor

Properties

Property	Modifier	Type	Inherited from	Defined in
listeners	protected	Map<string | symbol, Set<(...args: any[]) => void>>	TypedEventEmitter.listeners	CodeBolt/packages/clientsdk/src/core/event-emitter.ts:24

Methods

approveSpawnRequest()

approveSpawnRequest(requestId: string): void;

Defined in: CodeBolt/packages/clientsdk/src/sockets/swarm.socket.ts:169

Parameters

Parameter	Type
requestId	string

Returns

void

---

approveTerminationRequest()

approveTerminationRequest(requestId: string): void;

Defined in: CodeBolt/packages/clientsdk/src/sockets/swarm.socket.ts:180

Parameters

Parameter	Type
requestId	string

Returns

void

---

assignRole()

assignRole(assignment: unknown): void;

Defined in: CodeBolt/packages/clientsdk/src/sockets/swarm.socket.ts:141

Parameters

Parameter	Type
assignment	unknown

Returns

void

---

connect()

connect(): Promise<void>;

Defined in: CodeBolt/packages/clientsdk/src/sockets/swarm.socket.ts:27

Returns

Promise<void>

---

createSpawnRequest()

createSpawnRequest(request: CreateSpawnRequestBody): void;

Defined in: CodeBolt/packages/clientsdk/src/sockets/swarm.socket.ts:166

Parameters

Parameter	Type
request	CreateSpawnRequestBody

Returns

void

---

createTerminationRequest()

createTerminationRequest(request: CreateTerminationRequestBody): void;

Defined in: CodeBolt/packages/clientsdk/src/sockets/swarm.socket.ts:177

Parameters

Parameter	Type
request	CreateTerminationRequestBody

Returns

void

---

disconnect()

disconnect(): void;

Defined in: CodeBolt/packages/clientsdk/src/sockets/swarm.socket.ts:108

Returns

void

---

emit()

emit<K>(event: K, ...args: Parameters<SwarmSocketEvents[K]>): boolean;

Defined in: CodeBolt/packages/clientsdk/src/core/event-emitter.ts:54

Type Parameters

Type Parameter
K extends string

Parameters

Parameter	Type
event	K
...args	Parameters<SwarmSocketEvents[K]>

Returns

boolean

Inherited from

TypedEventEmitter.emit

---

getSwarmConfig()

getSwarmConfig(swarmId: string): void;

Defined in: CodeBolt/packages/clientsdk/src/sockets/swarm.socket.ts:149

Parameters

Parameter	Type
swarmId	string

Returns

void

---

getSwarmStatus()

getSwarmStatus(swarmId: string): void;

Defined in: CodeBolt/packages/clientsdk/src/sockets/swarm.socket.ts:161

Parameters

Parameter	Type
swarmId	string

Returns

void

---

joinSwarm()

joinSwarm(swarmId: string): void;

Defined in: CodeBolt/packages/clientsdk/src/sockets/swarm.socket.ts:114

Parameters

Parameter	Type
swarmId	string

Returns

void

---

joinTeam()

joinTeam(teamId: string): void;

Defined in: CodeBolt/packages/clientsdk/src/sockets/swarm.socket.ts:133

Parameters

Parameter	Type
teamId	string

Returns

void

---

leaveSwarm()

leaveSwarm(swarmId: string): void;

Defined in: CodeBolt/packages/clientsdk/src/sockets/swarm.socket.ts:117

Parameters

Parameter	Type
swarmId	string

Returns

void

---

leaveTeam()

leaveTeam(teamId: string): void;

Defined in: CodeBolt/packages/clientsdk/src/sockets/swarm.socket.ts:136

Parameters

Parameter	Type
teamId	string

Returns

void

---

listenerCount()

listenerCount(event: string): number;

Defined in: CodeBolt/packages/clientsdk/src/core/event-emitter.ts:75

Parameters

Parameter	Type
event	string

Returns

number

Inherited from

TypedEventEmitter.listenerCount

---

off()

off<K>(event: K, listener: SwarmSocketEvents[K]): this;

Defined in: CodeBolt/packages/clientsdk/src/core/event-emitter.ts:35

Type Parameters

Type Parameter
K extends string

Parameters

Parameter	Type
event	K
listener	SwarmSocketEvents[K]

Returns

this

Inherited from

TypedEventEmitter.off

---

on()

on<K>(event: K, listener: SwarmSocketEvents[K]): this;

Defined in: CodeBolt/packages/clientsdk/src/core/event-emitter.ts:27

Type Parameters

Type Parameter
K extends string

Parameters

Parameter	Type
event	K
listener	SwarmSocketEvents[K]

Returns

this

Inherited from

TypedEventEmitter.on

---

once()

once<K>(event: K, listener: SwarmSocketEvents[K]): this;

Defined in: CodeBolt/packages/clientsdk/src/core/event-emitter.ts:46

Type Parameters

Type Parameter
K extends string

Parameters

Parameter	Type
event	K
listener	SwarmSocketEvents[K]

Returns

this

Inherited from

TypedEventEmitter.once

---

registerAgent()

registerAgent(agent: AgentRegistration): void;

Defined in: CodeBolt/packages/clientsdk/src/sockets/swarm.socket.ts:122

Parameters

Parameter	Type
agent	AgentRegistration

Returns

void

---

rejectSpawnRequest()

rejectSpawnRequest(requestId: string): void;

Defined in: CodeBolt/packages/clientsdk/src/sockets/swarm.socket.ts:172

Parameters

Parameter	Type
requestId	string

Returns

void

---

rejectTerminationRequest()

rejectTerminationRequest(requestId: string): void;

Defined in: CodeBolt/packages/clientsdk/src/sockets/swarm.socket.ts:183

Parameters

Parameter	Type
requestId	string

Returns

void

---

removeAllListeners()

removeAllListeners(event?: string): this;

Defined in: CodeBolt/packages/clientsdk/src/core/event-emitter.ts:66

Parameters

Parameter	Type
event?	string

Returns

this

Inherited from

TypedEventEmitter.removeAllListeners

---

startSwarm()

startSwarm(swarmId: string): void;

Defined in: CodeBolt/packages/clientsdk/src/sockets/swarm.socket.ts:155

Parameters

Parameter	Type
swarmId	string

Returns

void

---

stopSwarm()

stopSwarm(swarmId: string): void;

Defined in: CodeBolt/packages/clientsdk/src/sockets/swarm.socket.ts:158

Parameters

Parameter	Type
swarmId	string

Returns

void

---

unassignRole()

unassignRole(assignment: unknown): void;

Defined in: CodeBolt/packages/clientsdk/src/sockets/swarm.socket.ts:144

Parameters

Parameter	Type
assignment	unknown

Returns

void

---

unregisterAgent()

unregisterAgent(agentId: string): void;

Defined in: CodeBolt/packages/clientsdk/src/sockets/swarm.socket.ts:125

Parameters

Parameter	Type
agentId	string

Returns

void

---

updateAgentStatus()

updateAgentStatus(agentId: string, status: AgentStatusUpdateRequest): void;

Defined in: CodeBolt/packages/clientsdk/src/sockets/swarm.socket.ts:128

Parameters

Parameter	Type
agentId	string
status	AgentStatusUpdateRequest

Returns

void

---

updateSwarmConfig()

updateSwarmConfig(swarmId: string, config: Partial<SwarmConfig>): void;

Defined in: CodeBolt/packages/clientsdk/src/sockets/swarm.socket.ts:152

Parameters

Parameter	Type
swarmId	string
config	Partial<SwarmConfig>

Returns

void