JobsSocket

@codebolt/plugin-sdk

---

Class: JobsSocket

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

Jobs WebSocket - Manage jobs, pheromones, splits, locks, bids, and blockers. Action-based protocol with ~35 actions.

Extends

• TypedEventEmitter<JobsSocketEvents>

Constructors

Constructor

new JobsSocket(connectionManager: SocketConnectionManager): JobsSocket;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/jobs.socket.ts:13

Parameters

Parameter	Type
connectionManager	SocketConnectionManager

Returns

JobsSocket

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

acceptBid()

acceptBid(bidId: string): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/jobs.socket.ts:119

Parameters

Parameter	Type
bidId	string

Returns

void

---

acceptSplit()

acceptSplit(splitId: string): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/jobs.socket.ts:83

Parameters

Parameter	Type
splitId	string

Returns

void

---

acquireLock()

acquireLock(lock: unknown): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/jobs.socket.ts:88

Parameters

Parameter	Type
lock	unknown

Returns

void

---

addBid()

addBid(bid: unknown): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/jobs.socket.ts:113

Parameters

Parameter	Type
bid	unknown

Returns

void

---

addBlocker()

addBlocker(blocker: unknown): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/jobs.socket.ts:127

Parameters

Parameter	Type
blocker	unknown

Returns

void

---

addPheromoneType()

addPheromoneType(type: CreatePheromoneTypeRequest): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/jobs.socket.ts:52

Parameters

Parameter	Type
type	CreatePheromoneTypeRequest

Returns

void

---

addUnlockRequest()

addUnlockRequest(request: unknown): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/jobs.socket.ts:99

Parameters

Parameter	Type
request	unknown

Returns

void

---

approveUnlockRequest()

approveUnlockRequest(requestId: string): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/jobs.socket.ts:102

Parameters

Parameter	Type
requestId	string

Returns

void

---

blocked()

blocked(): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/jobs.socket.ts:44

Returns

void

---

checkLock()

checkLock(resourceId: string): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/jobs.socket.ts:94

Parameters

Parameter	Type
resourceId	string

Returns

void

---

deleteSplit()

deleteSplit(splitId: string): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/jobs.socket.ts:80

Parameters

Parameter	Type
splitId	string

Returns

void

---

deleteUnlockRequest()

deleteUnlockRequest(requestId: string): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/jobs.socket.ts:108

Parameters

Parameter	Type
requestId	string

Returns

void

---

depositPheromone()

depositPheromone(pheromone: PheromoneDepositRequest): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/jobs.socket.ts:60

Parameters

Parameter	Type
pheromone	PheromoneDepositRequest

Returns

void

---

emit()

emit<K>(event: K, ...args: Parameters<JobsSocketEvents[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<JobsSocketEvents[K]>

Returns

boolean

Inherited from

TypedEventEmitter.emit

---

get()

get(jobId: string): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/jobs.socket.ts:32

Parameters

Parameter	Type
jobId	string

Returns

void

---

getAggregatedPheromones()

getAggregatedPheromones(filter?: unknown): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/jobs.socket.ts:69

Parameters

Parameter	Type
filter?	unknown

Returns

void

---

getEvent()

getEvent(eventId: string): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/jobs.socket.ts:141

Parameters

Parameter	Type
eventId	string

Returns

void

---

getPheromones()

getPheromones(filter?: unknown): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/jobs.socket.ts:66

Parameters

Parameter	Type
filter?	unknown

Returns

void

---

getPheromonesWithDecay()

getPheromonesWithDecay(filter?: unknown): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/jobs.socket.ts:72

Parameters

Parameter	Type
filter?	unknown

Returns

void

---

getPheromoneTypes()

getPheromoneTypes(): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/jobs.socket.ts:49

Returns

void

---

groups()

groups(): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/jobs.socket.ts:35

Returns

void

---

labels()

labels(): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/jobs.socket.ts:38

Returns

void

---

list()

list(filter?: JobListFilters): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/jobs.socket.ts:29

Parameters

Parameter	Type
filter?	JobListFilters

Returns

void

---

listBids()

listBids(jobId: string): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/jobs.socket.ts:122

Parameters

Parameter	Type
jobId	string

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

---

listEvents()

listEvents(filter?: unknown): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/jobs.socket.ts:138

Parameters

Parameter	Type
filter?	unknown

Returns

void

---

off()

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

Returns

this

Inherited from

TypedEventEmitter.off

---

on()

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

Returns

this

Inherited from

TypedEventEmitter.on

---

once()

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

Returns

this

Inherited from

TypedEventEmitter.once

---

proposeSplit()

proposeSplit(split: CreateSplitProposalRequest): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/jobs.socket.ts:77

Parameters

Parameter	Type
split	CreateSplitProposalRequest

Returns

void

---

ready()

ready(): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/jobs.socket.ts:41

Returns

void

---

rejectUnlockRequest()

rejectUnlockRequest(requestId: string): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/jobs.socket.ts:105

Parameters

Parameter	Type
requestId	string

Returns

void

---

releaseLock()

releaseLock(lockId: string): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/jobs.socket.ts:91

Parameters

Parameter	Type
lockId	string

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

---

removeBlocker()

removeBlocker(blockerId: string): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/jobs.socket.ts:130

Parameters

Parameter	Type
blockerId	string

Returns

void

---

removePheromone()

removePheromone(pheromoneId: string): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/jobs.socket.ts:63

Parameters

Parameter	Type
pheromoneId	string

Returns

void

---

removePheromoneType()

removePheromoneType(typeId: string): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/jobs.socket.ts:55

Parameters

Parameter	Type
typeId	string

Returns

void

---

resolveBlocker()

resolveBlocker(blockerId: string): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/jobs.socket.ts:133

Parameters

Parameter	Type
blockerId	string

Returns

void

---

withdrawBid()

withdrawBid(bidId: string): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/jobs.socket.ts:116

Parameters

Parameter	Type
bidId	string

Returns

void