X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fworker.ts;h=c1af1cf79c99d05e7c803e7d072529301b6d678a;hb=b7ea53bbd96886c5bc95c13943e5c92a3206f8a5;hp=05f6606edde672db081d9f392e9584ebc7a917f7;hpb=a4791fb12ff22711bc4bf1bcae4231ca7d6c7974;p=poolifier.git diff --git a/src/pools/worker.ts b/src/pools/worker.ts index 05f6606e..c1af1cf7 100644 --- a/src/pools/worker.ts +++ b/src/pools/worker.ts @@ -1,7 +1,8 @@ -import type { MessageChannel, WorkerOptions } from 'node:worker_threads' import type { EventEmitter } from 'node:events' -import type { CircularArray } from '../circular-array.js' -import type { Task } from '../utility-types.js' +import type { MessageChannel, WorkerOptions } from 'node:worker_threads' + +import type { CircularBuffer } from '../circular-buffer.js' +import type { Task, TaskFunctionProperties } from '../utility-types.js' /** * Callback invoked when the worker has started successfully. @@ -51,6 +52,11 @@ export type EventHandler = | ErrorHandler | ExitHandler +/** + * Measurement history size. + */ +export const MeasurementHistorySize = 386 + /** * Measurement statistics. * @@ -80,7 +86,7 @@ export interface MeasurementStatistics { /** * Measurement history. */ - readonly history: CircularArray + readonly history: CircularBuffer } /** @@ -133,10 +139,11 @@ export interface TaskStatistics { /** * Enumeration of worker types. */ -export const WorkerTypes = Object.freeze({ - thread: 'thread', - cluster: 'cluster' -} as const) +export const WorkerTypes: Readonly<{ thread: 'thread', cluster: 'cluster' }> = + Object.freeze({ + thread: 'thread', + cluster: 'cluster' + } as const) /** * Worker type. @@ -171,9 +178,14 @@ export interface WorkerInfo { */ stealing: boolean /** - * Task function names. + * Back pressure flag. + * This flag is set to `true` when worker node tasks queue has back pressure. + */ + backPressure: boolean + /** + * Task functions properties. */ - taskFunctionNames?: string[] + taskFunctionsProperties?: TaskFunctionProperties[] } /** @@ -235,6 +247,12 @@ export interface IWorker extends EventEmitter { * @param handler - The event handler. */ readonly once: (event: string, handler: EventHandler) => this + /** + * Calling `unref()` on a worker allows the thread to exit if this is the only + * active handle in the event system. If the worker is already `unref()`ed calling`unref()` again has no effect. + * @since v10.5.0 + */ + readonly unref?: () => void /** * Stop all JavaScript execution in the worker thread as soon as possible. * Returns a Promise for the exit code that is fulfilled when the `'exit' event` is emitted. @@ -259,6 +277,8 @@ export interface WorkerNodeOptions { workerOptions?: WorkerOptions env?: Record tasksQueueBackPressureSize: number | undefined + tasksQueueBucketSize: number | undefined + tasksQueuePriority: boolean | undefined } /** @@ -296,6 +316,12 @@ export interface IWorkerNode * This is the number of tasks that can be enqueued before the worker node has back pressure. */ tasksQueueBackPressureSize: number + /** + * Sets tasks queue priority. + * + * @param enablePriority - Whether to enable tasks queue priority. + */ + readonly setTasksQueuePriority: (enablePriority: boolean) => void /** * Tasks queue size. * @@ -309,25 +335,19 @@ 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. * + * @param bucket - The prioritized bucket to dequeue from. @defaultValue 0 * @returns The dequeued task. */ - readonly dequeueTask: () => Task | undefined + readonly dequeueTask: (bucket?: number) => Task | undefined /** - * Pops a task from the tasks queue. + * Dequeue last prioritized task. * - * @returns The popped task. + * @returns The dequeued task. */ - readonly popTask: () => Task | undefined + readonly dequeueLastPrioritizedTask: () => Task | undefined /** * Clears tasks queue. */ @@ -338,10 +358,6 @@ export interface IWorkerNode * @returns `true` if the worker node has back pressure, `false` otherwise. */ readonly hasBackPressure: () => boolean - /** - * Resets usage statistics. - */ - readonly resetUsage: () => void /** * Terminates the worker node. */