X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fpool.ts;h=14b30812d14bd21e55c0af4aee77db5daf8bc7e4;hb=5a31b13c97c664f37f284960713e5261e6b04055;hp=ea60833a42b445921ef162d15d651a9ba32d6127;hpb=a20f0ba5aa9c6946254aa197286ad9b70b6a0319;p=poolifier.git diff --git a/src/pools/pool.ts b/src/pools/pool.ts index ea60833a..14b30812 100644 --- a/src/pools/pool.ts +++ b/src/pools/pool.ts @@ -1,4 +1,4 @@ -import EventEmitter from 'node:events' +import EventEmitterAsyncResource from 'node:events' import type { ErrorHandler, ExitHandler, @@ -32,7 +32,7 @@ export enum PoolType { /** * Pool events emitter. */ -export class PoolEmitter extends EventEmitter {} +export class PoolEmitter extends EventEmitterAsyncResource {} /** * Enumeration of pool events. @@ -83,6 +83,8 @@ export interface PoolOptions { exitHandler?: ExitHandler /** * The worker choice strategy to use in this pool. + * + * @defaultValue WorkerChoiceStrategies.ROUND_ROBIN */ workerChoiceStrategy?: WorkerChoiceStrategy /** @@ -125,6 +127,10 @@ export interface IPool< * If it is `'dynamic'`, it provides the `max` property. */ readonly type: PoolType + /** + * Pool maximum size. + */ + readonly size: number /** * Pool worker nodes. */ @@ -139,22 +145,13 @@ export interface IPool< */ readonly emitter?: PoolEmitter /** - * Finds a free worker node key based on the number of tasks the worker has applied. + * Executes the specified function in the worker constructor with the task data input parameter. * - * If a worker is found with `0` running tasks, it is detected as free and its worker node key is returned. - * - * If no free worker is found, `-1` is returned. - * - * @returns A worker node key if there is one, `-1` otherwise. + * @param data - The task input data for the specified worker function. This can only be serializable data. + * @param name - The name of the worker function to execute. If not specified, the default worker function will be executed. + * @returns Promise that will be fulfilled when the task is completed. */ - findFreeWorkerNodeKey: () => number - /** - * Executes the function specified in the constructor with the task data parameter. - * - * @param data - The input for the specified task. This can only be serializable data. - * @returns Promise that will be resolved when the task is successfully completed. - */ - execute: (data: Data) => Promise + execute: (data?: Data, name?: string) => Promise /** * Shutdowns every current worker in this pool. */ @@ -163,8 +160,12 @@ export interface IPool< * Sets the worker choice strategy in this pool. * * @param workerChoiceStrategy - The worker choice strategy. + * @param workerChoiceStrategyOptions - The worker choice strategy options. */ - setWorkerChoiceStrategy: (workerChoiceStrategy: WorkerChoiceStrategy) => void + setWorkerChoiceStrategy: ( + workerChoiceStrategy: WorkerChoiceStrategy, + workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions + ) => void /** * Sets the worker choice strategy options in this pool. * @@ -179,7 +180,10 @@ export interface IPool< * @param enable - Whether to enable or disable the worker tasks queue. * @param tasksQueueOptions - The worker tasks queue options. */ - enableTasksQueue: (enable: boolean, opts?: TasksQueueOptions) => void + enableTasksQueue: ( + enable: boolean, + tasksQueueOptions?: TasksQueueOptions + ) => void /** * Sets the worker tasks queue options in this pool. *