X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fpool.ts;h=0a015476f3af30e9750b092aadbd428282784b3f;hb=dab8c377b70fc962ec217f2aeb719842f9f94cd6;hp=5c90ff77c8b3e62ea444bbb998f03ec53937dc1f;hpb=1d6ec394e8f7467f72baeb74dda4794fdc5ab322;p=poolifier.git diff --git a/src/pools/pool.ts b/src/pools/pool.ts index 5c90ff77..0a015476 100644 --- a/src/pools/pool.ts +++ b/src/pools/pool.ts @@ -83,6 +83,8 @@ export interface PoolOptions { exitHandler?: ExitHandler /** * The worker choice strategy to use in this pool. + * + * @defaultValue WorkerChoiceStrategies.ROUND_ROBIN */ workerChoiceStrategy?: WorkerChoiceStrategy /** @@ -98,14 +100,11 @@ export interface PoolOptions { /** * Pool worker tasks queue. * - * @experimental * @defaultValue false */ enableTasksQueue?: boolean /** * Pool worker tasks queue options. - * - * @experimental */ tasksQueueOptions?: TasksQueueOptions } @@ -128,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. */ @@ -142,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. - * - * 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. - */ - findFreeWorkerNodeKey: () => number - /** - * Performs the task specified in the constructor with the data parameter. + * Executes the specified function in the worker constructor with the task data input 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. + * @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. */ - execute: (data: Data) => Promise + execute: (data?: Data, name?: string) => Promise /** * Shutdowns every current worker in this pool. */ @@ -166,6 +160,34 @@ 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, + workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions + ) => void + /** + * Sets the worker choice strategy options in this pool. + * + * @param workerChoiceStrategyOptions - The worker choice strategy options. + */ + setWorkerChoiceStrategyOptions: ( + workerChoiceStrategyOptions: WorkerChoiceStrategyOptions + ) => void + /** + * Enables/disables the worker tasks queue in this pool. + * + * @param enable - Whether to enable or disable the worker tasks queue. + * @param tasksQueueOptions - The worker tasks queue options. + */ + enableTasksQueue: ( + enable: boolean, + tasksQueueOptions?: TasksQueueOptions + ) => void + /** + * Sets the worker tasks queue options in this pool. + * + * @param tasksQueueOptions - The worker tasks queue options. */ - setWorkerChoiceStrategy: (workerChoiceStrategy: WorkerChoiceStrategy) => void + setTasksQueueOptions: (tasksQueueOptions: TasksQueueOptions) => void }