OrchestratorSocket

@codebolt/plugin-sdk

---

Class: OrchestratorSocket

Defined in: CodeBolt/packages/pluginSdk/src/sockets/orchestrator.socket.ts:10

Orchestrator WebSocket - Subscribe to orchestrator thread/message updates. Subscribe-based: subscribe/unsubscribe for targeted updates.

Extends

• TypedEventEmitter<OrchestratorSocketEvents>

Constructors

Constructor

new OrchestratorSocket(connectionManager: SocketConnectionManager): OrchestratorSocket;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/orchestrator.socket.ts:14

Parameters

Parameter	Type
connectionManager	SocketConnectionManager

Returns

OrchestratorSocket

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<OrchestratorSocketEvents[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<OrchestratorSocketEvents[K]>

Returns

boolean

Inherited from

TypedEventEmitter.emit

---

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: OrchestratorSocketEvents[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	OrchestratorSocketEvents[K]

Returns

this

Inherited from

TypedEventEmitter.off

---

on()

on<K>(event: K, listener: OrchestratorSocketEvents[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	OrchestratorSocketEvents[K]

Returns

this

Inherited from

TypedEventEmitter.on

---

once()

once<K>(event: K, listener: OrchestratorSocketEvents[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	OrchestratorSocketEvents[K]

Returns

this

Inherited from

TypedEventEmitter.once

---

ping()

ping(): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/orchestrator.socket.ts:65

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(filter?: unknown): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/orchestrator.socket.ts:59

Parameters

Parameter	Type
filter?	unknown

Returns

void

---

unsubscribe()

unsubscribe(): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/orchestrator.socket.ts:62

Returns

void