X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=src%2Fpools%2Fworker.ts;h=5cd58b28be9b2ee3ef44be54af4e2fb6bdcddca2;hb=02fd4f2cab0cb6b9f4dc06f6653569fa2cbdb81b;hp=e6dd0fae91cd7b0cfd29b14ba828b89d131854d0;hpb=4445abb25ec4c9d80985ca93c65762a6c892a852;p=poolifier.git diff --git a/src/pools/worker.ts b/src/pools/worker.ts index e6dd0fae..5cd58b28 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. */ @@ -128,7 +132,7 @@ export interface WorkerInfo { /** * Worker type. */ - type: WorkerType + readonly type: WorkerType /** * Dynamic flag. */ @@ -189,12 +193,20 @@ 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 } +/** + * Worker node event callback. + * + * @param workerId - The worker id. + * @internal + */ +export type WorkerNodeEventCallback = (workerId: number) => void + /** * Worker node interface. * @@ -212,18 +224,26 @@ export interface IWorkerNode { */ readonly info: WorkerInfo /** - * Message channel (worker_threads only). + * Worker usage statistics. */ - readonly messageChannel?: MessageChannel + readonly usage: WorkerUsage /** - * Worker usage statistics. + * Message channel (worker_threads only). */ - usage: WorkerUsage + readonly messageChannel?: MessageChannel /** * Tasks queue back pressure size. * This is the number of tasks that can be enqueued before the worker node has back pressure. */ tasksQueueBackPressureSize: number + /** + * Callback invoked when worker node tasks queue is back pressured. + */ + onBackPressure?: WorkerNodeEventCallback + /** + * Callback invoked when worker node tasks queue is empty. + */ + onEmptyQueue?: WorkerNodeEventCallback /** * Tasks queue size. * @@ -237,12 +257,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. */