X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fpool-internal.ts;h=ddfcc41ec40758e8520a2d708bf823aaaebeb39c;hb=d99ba5a8a292772965b5027272a8dc677a6ad008;hp=d61b9c715504d10fb88cc64d9d0d2ab709631ca2;hpb=09c9445fa9d52c59af5eb06fb69ca1d92842d923;p=poolifier.git diff --git a/src/pools/pool-internal.ts b/src/pools/pool-internal.ts index d61b9c71..ddfcc41e 100644 --- a/src/pools/pool-internal.ts +++ b/src/pools/pool-internal.ts @@ -3,6 +3,8 @@ import type { IPoolWorker } from './pool-worker' /** * Internal pool types. + * + * @enum */ export enum PoolType { FIXED = 'fixed', @@ -17,14 +19,25 @@ export interface TasksUsage { running: number runTime: number avgRunTime: number + error: number +} + +/** + * Internal worker type. + * + * @typeParam Worker - Type of worker type items which manages this pool. + */ +export interface WorkerType { + worker: Worker + tasksUsage: TasksUsage } /** * Internal contract definition for a poolifier pool. * - * @template Worker Type of worker which manages this pool. - * @template Data Type of data sent to the worker. - * @template Response Type of response of execution. + * @typeParam Worker - Type of worker which manages this pool. + * @typeParam Data - Type of data sent to the worker. This can only be serializable data. + * @typeParam Response - Type of response of execution. This can only be serializable data. */ export interface IPoolInternal< Worker extends IPoolWorker, @@ -32,24 +45,23 @@ export interface IPoolInternal< Response = unknown > extends IPool { /** - * List of currently available workers. + * Pool worker type items array. */ - readonly workers: Worker[] + readonly workers: Array> /** - * The workers tasks usage map. + * Pool type. * - * `key`: The `Worker` - * `value`: Worker tasks usage statistics. + * If it is `'dynamic'`, it provides the `max` property. */ - readonly workersTasksUsage: Map + readonly type: PoolType /** - * Pool type. + * Whether the pool is full or not. * - * If it is `'dynamic'`, it provides the `max` property. + * The pool filling boolean status. */ - readonly type: PoolType + readonly full: boolean /** * Whether the pool is busy or not. @@ -59,42 +71,13 @@ export interface IPoolInternal< readonly busy: boolean /** - * Number of tasks currently concurrently running. - */ - readonly numberOfRunningTasks: number - - /** - * Finds a free worker based on the number of tasks the worker has applied. + * Finds a free worker 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 returned. + * If a worker is found with `0` running tasks, it is detected as free and its key is returned. * * If no free worker is found, `false` is returned. * - * @returns A free worker if there is one, otherwise `false`. - */ - findFreeWorker(): Worker | false - - /** - * Gets worker index. - * - * @param worker The worker. - * @returns The worker index. - */ - getWorkerIndex(worker: Worker): number - - /** - * Gets worker running tasks. - * - * @param worker The worker. - * @returns The number of tasks currently running on the worker. - */ - getWorkerRunningTasks(worker: Worker): number | undefined - - /** - * Gets worker average tasks runtime. - * - * @param worker The worker. - * @returns The average tasks runtime on the worker. + * @returns A worker key if there is one, `-1` otherwise. */ - getWorkerAverageTasksRunTime(worker: Worker): number | undefined + findFreeWorkerKey: () => number }