X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fpool.ts;h=08aad620f5cde2ef28892e43e47f99ba545e6707;hb=5b5321fd0b3ef10dd12b9aa21bf3ca9fa3970e76;hp=118b283246e8fc71691911ea816726a3b716ff01;hpb=25926072f5397949802f6af5a2f7d49d6f15cacc;p=poolifier.git diff --git a/src/pools/pool.ts b/src/pools/pool.ts index 118b2832..08aad620 100644 --- a/src/pools/pool.ts +++ b/src/pools/pool.ts @@ -1,5 +1,6 @@ -import type { TransferListItem } from 'node:worker_threads' -import type { EventEmitter, EventEmitterAsyncResource } from 'node:events' +import type { TransferListItem, WorkerOptions } from 'node:worker_threads' +import type { EventEmitterAsyncResource } from 'node:events' +import type { ClusterSettings } from 'node:cluster' import type { TaskFunction } from '../worker/task-functions' import type { ErrorHandler, @@ -68,6 +69,8 @@ export interface PoolInfo { readonly utilization?: number /** Pool total worker nodes. */ readonly workerNodes: number + /** Pool stealing worker nodes. */ + readonly stealingWorkerNodes?: number /** Pool idle worker nodes. */ readonly idleWorkerNodes: number /** Pool busy worker nodes. */ @@ -110,17 +113,23 @@ export interface TasksQueueOptions { */ readonly concurrency?: number /** - * Whether to enable task stealing. + * Whether to enable task stealing on idle. * * @defaultValue true */ readonly taskStealing?: boolean /** - * Whether to enable tasks stealing on back pressure. + * Whether to enable tasks stealing under back pressure. * * @defaultValue true */ readonly tasksStealingOnBackPressure?: boolean + /** + * Queued tasks finished timeout in milliseconds at worker node termination. + * + * @defaultValue 2000 + */ + readonly tasksFinishedTimeout?: number } /** @@ -189,6 +198,24 @@ export interface PoolOptions { * Pool worker node tasks queue options. */ tasksQueueOptions?: TasksQueueOptions + /** + * Worker options. + * + * @see https://nodejs.org/api/worker_threads.html#new-workerfilename-options + */ + workerOptions?: WorkerOptions + /** + * Key/value pairs to add to worker process environment. + * + * @see https://nodejs.org/api/cluster.html#cluster_cluster_fork_env + */ + env?: Record + /** + * Cluster settings. + * + * @see https://nodejs.org/api/cluster.html#cluster_cluster_settings + */ + settings?: ClusterSettings } /** @@ -235,13 +262,13 @@ export interface IPool< * - `'taskError'`: Emitted when an error occurs while executing a task. * - `'backPressure'`: Emitted when all worker nodes have back pressure (i.e. their tasks queue is full: queue size \>= maximum queue size). */ - readonly emitter?: EventEmitter | EventEmitterAsyncResource + readonly emitter?: EventEmitterAsyncResource /** * Executes the specified function in the worker constructor with the task data input parameter. * * @param data - The optional task input data for the specified task function. This can only be structured-cloneable data. * @param name - The optional name of the task function to execute. If not specified, the default task function will be executed. - * @param transferList - An optional array of transferable objects to transfer ownership of. Ownership of the transferred objects is given to the pool's worker_threads worker and they should not be used in the main thread afterwards. + * @param transferList - An optional array of transferable objects to transfer ownership of. Ownership of the transferred objects is given to the chosen pool's worker_threads worker and they should not be used in the main thread afterwards. * @returns Promise that will be fulfilled when the task is completed. */ readonly execute: (