X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fpool-internal.ts;h=261a9d7beeb862258ebabceef5b69a71df091180;hb=refs%2Ftags%2Fv2.4.0-1;hp=f5f1d1908a14d60f2e26f9d6baa75c627468e96b;hpb=bf9549aef8a23a3931e19040dadb7f1e8e6422b5;p=poolifier.git diff --git a/src/pools/pool-internal.ts b/src/pools/pool-internal.ts index f5f1d190..261a9d7b 100644 --- a/src/pools/pool-internal.ts +++ b/src/pools/pool-internal.ts @@ -1,9 +1,8 @@ -import EventEmitter from 'events' -import type { AbstractPoolWorker } from './abstract-pool-worker' import type { IPool } from './pool' +import type { IPoolWorker } from './pool-worker' /** - * Pool types. + * Internal pool types. */ export enum PoolType { FIXED = 'fixed', @@ -11,45 +10,42 @@ export enum PoolType { } /** - * Tasks usage statistics. + * Internal tasks usage statistics. */ export interface TasksUsage { run: number running: number runTime: number avgRunTime: number + error: number } /** - * Internal poolifier pool emitter. + * Internal worker type. + * + * @typeParam Worker - Type of worker which manages this pool. */ -export class PoolEmitter extends EventEmitter {} +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. + * @typeParam Response - Type of response of execution. */ export interface IPoolInternal< - Worker extends AbstractPoolWorker, + Worker extends IPoolWorker, Data = unknown, Response = unknown > extends IPool { /** - * List of currently available workers. + * Pool workers item array. */ - readonly workers: Worker[] - - /** - * Emitter on which events can be listened to. - * - * Events that can currently be listened to: - * - * - `'busy'` - */ - readonly emitter?: PoolEmitter + readonly workers: Array> /** * Pool type. @@ -58,11 +54,6 @@ export interface IPoolInternal< */ readonly type: PoolType - /** - * Maximum number of workers that can be created by this pool. - */ - readonly max?: number - /** * Whether the pool is busy or not. * @@ -76,37 +67,13 @@ export interface IPoolInternal< readonly numberOfRunningTasks: number /** - * Find 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 - - /** - * Get worker index. - * - * @param worker The worker. - * @returns The worker index. - */ - getWorkerIndex(worker: Worker): number - - /** - * Get worker running tasks. - * - * @param worker The worker. - * @returns The number of tasks currently running on the worker. - */ - getWorkerRunningTasks(worker: Worker): number | undefined - - /** - * Get worker average tasks run time. - * - * @param worker The worker. - * @returns The average tasks run time on the worker. + * @returns A worker key if there is one, otherwise `false`. */ - getWorkerAverageTasksRunTime(worker: Worker): number | undefined + findFreeWorkerKey: () => number | false }