X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fworker.ts;h=7a8c59e7730eba9be39ae972f94022a8a65a14ce;hb=9fe8fd698590c2494dc6793cfd8c08026fe88a31;hp=1d0c4e22e47f073384bdf8c69e3c477ea9cb1d2b;hpb=1079e6ed099b03189005b33702c1e9fa912c74d1;p=poolifier.git diff --git a/src/pools/worker.ts b/src/pools/worker.ts index 1d0c4e22..7a8c59e7 100644 --- a/src/pools/worker.ts +++ b/src/pools/worker.ts @@ -96,6 +96,10 @@ export interface TaskStatistics { * Maximum number of queued tasks. */ readonly maxQueued?: number + /** + * Number of stolen tasks. + */ + stolen: number /** * Number of failed tasks. */ @@ -189,12 +193,15 @@ export interface IWorker { /** * Registers a listener to the exit event that will only be performed once. * - * @param event - `'exit'`. + * @param event - The `'exit'` event. * @param handler - The exit handler. */ readonly once: (event: 'exit', handler: ExitHandler) => void } +export type EmptyQueueCallback = (workerId: number) => void +export type BackPressureCallback = EmptyQueueCallback + /** * Worker node interface. * @@ -212,13 +219,30 @@ export interface IWorkerNode { */ readonly info: WorkerInfo /** - * Message channel. + * Worker usage statistics. + */ + usage: WorkerUsage + /** + * Message channel (worker_threads only). */ readonly messageChannel?: MessageChannel /** - * Worker usage statistics. + * Tasks queue back pressure size. + * This is the number of tasks that can be enqueued before the worker node has back pressure. */ - usage: WorkerUsage + tasksQueueBackPressureSize: number + /** + * Callback invoked when worker node tasks queue is back pressured. + * + * @param workerId - The worker id. + */ + onBackPressure?: EmptyQueueCallback + /** + * Callback invoked when worker node tasks queue is empty. + * + * @param workerId - The worker id. + */ + onEmptyQueue?: BackPressureCallback /** * Tasks queue size. * @@ -232,12 +256,25 @@ export interface IWorkerNode { * @returns The tasks queue size. */ readonly enqueueTask: (task: Task) => number + /** + * Prepends a task to the tasks queue. + * + * @param task - The task to prepend. + * @returns The tasks queue size. + */ + readonly unshiftTask: (task: Task) => number /** * Dequeue task. * * @returns The dequeued task. */ readonly dequeueTask: () => Task | undefined + /** + * Pops a task from the tasks queue. + * + * @returns The popped task. + */ + readonly popTask: () => Task | undefined /** * Clears tasks queue. */