X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fworker.ts;h=29050455088c6efd49d8147aed07c41f2a5a004e;hb=2a87030e2fa5e42167e2aa13bd8c1cbb3d27ffc1;hp=1d0c4e22e47f073384bdf8c69e3c477ea9cb1d2b;hpb=bde3557b4daaacaea222926c3ac6934dcb90fdaa;p=poolifier.git diff --git a/src/pools/worker.ts b/src/pools/worker.ts index 1d0c4e22..29050455 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. */ @@ -167,6 +171,15 @@ export interface WorkerUsage { readonly elu: EventLoopUtilizationMeasurementStatistics } +/** + * Worker choice strategy data. + * + * @internal + */ +export interface StrategyData { + virtualTaskEndTimestamp?: number +} + /** * Worker interface. */ @@ -189,12 +202,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,13 +233,31 @@ export interface IWorkerNode { */ readonly info: WorkerInfo /** - * Message channel. + * Worker usage statistics. + */ + readonly usage: WorkerUsage + /** + * Worker choice strategy data. + * This is used to store data that is specific to the worker choice strategy. + */ + strategyData?: StrategyData + /** + * 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. + */ + tasksQueueBackPressureSize: number + /** + * Callback invoked when worker node tasks queue is back pressured. + */ + onBackPressure?: WorkerNodeEventCallback + /** + * Callback invoked when worker node tasks queue is empty. */ - usage: WorkerUsage + onEmptyQueue?: WorkerNodeEventCallback /** * Tasks queue size. * @@ -232,12 +271,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. */