X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fworker.ts;h=99c0d9a6feeea35815a520ff95a160d927bcc4fc;hb=efbad167abfbf5bfe3c362b652a39c579ab09899;hp=7f8148ffcc93db670479a9ce5d7c96b6e576a1d0;hpb=c63a35a04c190989be80f9218d97e0aca739475e;p=poolifier.git diff --git a/src/pools/worker.ts b/src/pools/worker.ts index 7f8148ff..99c0d9a6 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 { MessageChannel, WorkerOptions } from 'node:worker_threads' + import type { CircularArray } from '../circular-array.js' -import type { Task } from '../utility-types.js' +import type { Task, TaskFunctionProperties } from '../utility-types.js' /** * Callback invoked when the worker has started successfully. @@ -133,10 +134,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 +173,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. */ - taskFunctionNames?: string[] + backPressure: boolean + /** + * Task functions properties. + */ + taskFunctionsProperties?: TaskFunctionProperties[] } /** @@ -212,7 +219,7 @@ export interface StrategyData { /** * Worker interface. */ -export interface IWorker { +export interface IWorker extends EventEmitter { /** * Cluster worker id. */ @@ -227,14 +234,20 @@ export interface IWorker { * @param event - The event. * @param handler - The event handler. */ - readonly on: (event: string, handler: EventHandler) => void + readonly on: (event: string, handler: EventHandler) => this /** * Registers once an event handler. * * @param event - The event. * @param handler - The event handler. */ - readonly once: (event: string, handler: EventHandler) => void + 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 +272,7 @@ export interface WorkerNodeOptions { workerOptions?: WorkerOptions env?: Record tasksQueueBackPressureSize: number | undefined + tasksQueueBucketSize: number | undefined } /** @@ -309,25 +323,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 +346,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. */ @@ -388,6 +392,6 @@ export interface IWorkerNode * @internal */ export interface WorkerNodeEventDetail { - workerId: number + workerId?: number workerNodeKey?: number }