X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fpool-internal.ts;h=8912dd2c18f8a99a6791b006f672442e5be5ecdf;hb=f9f00b5f18805c14b1bac3b2e5d2e8b5abc6c66c;hp=9489d96f1c1ffc3ef548a06423b2bb05647bf277;hpb=e65c6cd9a3d6ed2e5b8af95120a5aa070101e945;p=poolifier.git diff --git a/src/pools/pool-internal.ts b/src/pools/pool-internal.ts index 9489d96f..8912dd2c 100644 --- a/src/pools/pool-internal.ts +++ b/src/pools/pool-internal.ts @@ -1,50 +1,32 @@ import type { IPool } from './pool' -import type { IPoolWorker } from './pool-worker' +import type { IWorker, WorkerNode } from './worker' /** * Internal pool types. + * + * @enum */ export enum PoolType { FIXED = 'fixed', DYNAMIC = 'dynamic' } -/** - * Internal tasks usage statistics. - */ -export interface TasksUsage { - run: number - running: number - runTime: number - avgRunTime: number -} - -/** - * Internal worker type. - * - * @typeParam Worker - Type of worker which manages this pool. - */ -export interface WorkerType { - worker: Worker - tasksUsage: TasksUsage -} - /** * Internal contract definition for a poolifier pool. * * @typeParam Worker - Type of worker which manages this pool. - * @typeParam Data - Type of data sent to the worker. - * @typeParam Response - Type of response of execution. + * @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, + Worker extends IWorker, Data = unknown, Response = unknown > extends IPool { /** - * Pool workers item array. + * Pool worker nodes. */ - readonly workers: Array> + readonly workerNodes: Array> /** * Pool type. @@ -54,33 +36,27 @@ export interface IPoolInternal< readonly type: PoolType /** - * Whether the pool is busy or not. + * Whether the pool is full or not. * - * The pool busyness boolean status. + * The pool filling boolean status. */ - readonly busy: boolean + readonly full: boolean /** - * Number of tasks currently concurrently running. + * Whether the pool is busy or not. + * + * The pool busyness boolean status. */ - readonly numberOfRunningTasks: number + readonly busy: boolean /** - * Finds a free worker 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. + * Finds a free worker node key based on the number of tasks the worker has applied. * - * If no free worker is found, `false` is returned. + * If a worker is found with `0` running tasks, it is detected as free and its worker node key is returned. * - * @returns A free worker if there is one, otherwise `false`. - */ - findFreeWorker: () => Worker | false - - /** - * Gets worker tasks usage. + * If no free worker is found, `-1` is returned. * - * @param worker - The worker. - * @returns The tasks usage on the worker. + * @returns A worker node key if there is one, `-1` otherwise. */ - getWorkerTasksUsage: (worker: Worker) => TasksUsage | undefined + findFreeWorkerNodeKey: () => number }