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=911e761df157a07f54ac1300328c82548cc6d9d6;hpb=330c983e06cc9711c66fcd0f1bb419e80453c77f;p=poolifier.git diff --git a/src/pools/pool-internal.ts b/src/pools/pool-internal.ts index 911e761d..261a9d7b 100644 --- a/src/pools/pool-internal.ts +++ b/src/pools/pool-internal.ts @@ -1,55 +1,79 @@ -import EventEmitter from 'events' -import type { IWorker } from './abstract-pool' import type { IPool } from './pool' +import type { IPoolWorker } from './pool-worker' /** - * Internal poolifier pool emitter. + * Internal pool types. */ -export class PoolEmitter extends EventEmitter {} +export enum PoolType { + FIXED = 'fixed', + DYNAMIC = 'dynamic' +} + +/** + * Internal tasks usage statistics. + */ +export interface TasksUsage { + run: number + running: number + runTime: number + avgRunTime: number + error: 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. * - * @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 IWorker, + Worker extends IPoolWorker, Data = unknown, Response = unknown > extends IPool { /** - * List of currently available workers. + * Pool workers item array. */ - readonly workers: Worker[] + readonly workers: Array> /** - * The tasks map. + * Pool type. * - * - `key`: The `Worker` - * - `value`: Number of tasks currently in progress on the worker. + * If it is `'dynamic'`, it provides the `max` property. */ - readonly tasks: Map + readonly type: PoolType /** - * Emitter on which events can be listened to. + * Whether the pool is busy or not. * - * Events that can currently be listened to: - * - * - `'busy'` + * The pool busyness boolean status. */ - readonly emitter: PoolEmitter + readonly busy: boolean /** - * Whether the pool is dynamic or not. - * - * If it is dynamic, it provides the `max` property. + * Number of tasks currently concurrently running. */ - readonly dynamic: boolean + readonly numberOfRunningTasks: number /** - * Maximum number of workers that can be created by this pool. + * 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 its key is returned. + * + * If no free worker is found, `false` is returned. + * + * @returns A worker key if there is one, otherwise `false`. */ - readonly max?: number + findFreeWorkerKey: () => number | false }