X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fpool-internal.ts;h=e0d0534f83a846cbfac77eb87e305e0975c49abf;hb=8bd0b5363ad2defbce7c1cc49e616c24ad135dde;hp=f5f1d1908a14d60f2e26f9d6baa75c627468e96b;hpb=bf9549aef8a23a3931e19040dadb7f1e8e6422b5;p=poolifier.git diff --git a/src/pools/pool-internal.ts b/src/pools/pool-internal.ts index f5f1d190..e0d0534f 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,7 +10,7 @@ export enum PoolType { } /** - * Tasks usage statistics. + * Internal tasks usage statistics. */ export interface TasksUsage { run: number @@ -20,20 +19,15 @@ export interface TasksUsage { avgRunTime: number } -/** - * Internal poolifier pool emitter. - */ -export class PoolEmitter extends EventEmitter {} - /** * 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 { @@ -43,13 +37,12 @@ export interface IPoolInternal< readonly workers: Worker[] /** - * Emitter on which events can be listened to. - * - * Events that can currently be listened to: + * The workers tasks usage map. * - * - `'busy'` + * `key`: The `Worker` + * `value`: Worker tasks usage statistics. */ - readonly emitter?: PoolEmitter + readonly workersTasksUsage: Map /** * Pool type. @@ -58,11 +51,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,7 +64,7 @@ export interface IPoolInternal< readonly numberOfRunningTasks: number /** - * Find a free worker based on the number of tasks the worker has applied. + * 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. * @@ -84,29 +72,29 @@ export interface IPoolInternal< * * @returns A free worker if there is one, otherwise `false`. */ - findFreeWorker(): Worker | false + findFreeWorker: () => Worker | false /** - * Get worker index. + * Gets worker index. * - * @param worker The worker. + * @param worker - The worker. * @returns The worker index. */ - getWorkerIndex(worker: Worker): number + getWorkerIndex: (worker: Worker) => number /** - * Get worker running tasks. + * Gets worker running tasks. * - * @param worker The worker. + * @param worker - The worker. * @returns The number of tasks currently running on the worker. */ - getWorkerRunningTasks(worker: Worker): number | undefined + getWorkerRunningTasks: (worker: Worker) => number | undefined /** - * Get worker average tasks run time. + * Gets worker average tasks runtime. * - * @param worker The worker. - * @returns The average tasks run time on the worker. + * @param worker - The worker. + * @returns The average tasks runtime on the worker. */ - getWorkerAverageTasksRunTime(worker: Worker): number | undefined + getWorkerAverageTasksRunTime: (worker: Worker) => number | undefined }