Skip to content

ChainGraph API Documentation / @badaitech/chaingraph-executor / server / ITaskQueue

Interface: ITaskQueue

Defined in: packages/chaingraph-executor/server/interfaces/ITaskQueue.ts:37

Interface for task queue implementations Handles distribution of execution tasks to workers

Properties

close()

close: () => Promise<void>

Defined in: packages/chaingraph-executor/server/interfaces/ITaskQueue.ts:62

Close the queue and cleanup resources

Returns

Promise<void>


consumeTasks()

consumeTasks: (handler) => Promise<void>

Defined in: packages/chaingraph-executor/server/interfaces/ITaskQueue.ts:47

Start consuming tasks from the queue Handler is called for each task with optional context for manual offset management

Parameters

handler

TaskHandler

Returns

Promise<void>


getPendingCount()?

optional getPendingCount: () => Promise<number>

Defined in: packages/chaingraph-executor/server/interfaces/ITaskQueue.ts:57

Get the number of pending tasks (if available)

Returns

Promise<number>


publishTask()

publishTask: (task) => Promise<void>

Defined in: packages/chaingraph-executor/server/interfaces/ITaskQueue.ts:41

Publish an execution task to the queue

Parameters

task

ExecutionTask

Returns

Promise<void>


stopConsuming()

stopConsuming: () => Promise<void>

Defined in: packages/chaingraph-executor/server/interfaces/ITaskQueue.ts:52

Stop consuming tasks

Returns

Promise<void>

Licensed under BUSL-1.1