BackgroundAgentSocket

@codebolt/plugin-sdk

---

Class: BackgroundAgentSocket

Defined in: CodeBolt/packages/pluginSdk/src/sockets/background-agent.socket.ts:9

Background Agent WebSocket - Monitor background agent processes. Type-based protocol with subscribe for targeted updates and broadcast events.

Extends

• TypedEventEmitter<BackgroundAgentSocketEvents>

Constructors

Constructor

new BackgroundAgentSocket(connectionManager: SocketConnectionManager): BackgroundAgentSocket;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/background-agent.socket.ts:12

Parameters

Parameter	Type
connectionManager	SocketConnectionManager

Returns

BackgroundAgentSocket

Overrides

TypedEventEmitter.constructor

Properties

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

Methods

emit()

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

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

Type Parameters

Type Parameter
K extends string

Parameters

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

Returns

boolean

Inherited from

TypedEventEmitter.emit

---

get()

get(agentId: string): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/background-agent.socket.ts:46

Parameters

Parameter	Type
agentId	string

Returns

void

---

list()

list(): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/background-agent.socket.ts:43

Returns

void

---

listenerCount()

listenerCount(event: string): number;

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

Parameters

Parameter	Type
event	string

Returns

number

Inherited from

TypedEventEmitter.listenerCount

---

off()

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

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

Type Parameters

Type Parameter
K extends string

Parameters

Parameter	Type
event	K
listener	BackgroundAgentSocketEvents[K]

Returns

this

Inherited from

TypedEventEmitter.off

---

on()

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

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

Type Parameters

Type Parameter
K extends string

Parameters

Parameter	Type
event	K
listener	BackgroundAgentSocketEvents[K]

Returns

this

Inherited from

TypedEventEmitter.on

---

once()

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

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

Type Parameters

Type Parameter
K extends string

Parameters

Parameter	Type
event	K
listener	BackgroundAgentSocketEvents[K]

Returns

this

Inherited from

TypedEventEmitter.once

---

ping()

ping(): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/background-agent.socket.ts:52

Returns

void

---

removeAllListeners()

removeAllListeners(event?: string): this;

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

Parameters

Parameter	Type
event?	string

Returns

this

Inherited from

TypedEventEmitter.removeAllListeners

---

subscribe()

subscribe(agentId: string): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/background-agent.socket.ts:49

Parameters

Parameter	Type
agentId	string

Returns

void