X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fpool-internal.ts;h=9da6495266ab6c6e4654def94eca460b4630cb24;hb=3032893add6cc97da7b0600e21df2865ad1f675c;hp=dd71ae71045b555d99b64a24bba516461c77b561;hpb=7c0ba92006a5c188738ffc5ff642c51f172df3d6;p=poolifier.git diff --git a/src/pools/pool-internal.ts b/src/pools/pool-internal.ts index dd71ae71..9da64952 100644 --- a/src/pools/pool-internal.ts +++ b/src/pools/pool-internal.ts @@ -1,9 +1,8 @@ -import EventEmitter from 'events' -import type { IWorker } from './abstract-pool' import type { IPool } from './pool' +import type { IPoolWorker } from './pool-worker' /** - * Pool types. + * Internal pool types. */ export enum PoolType { FIXED = 'fixed', @@ -11,43 +10,41 @@ export enum PoolType { } /** - * Internal poolifier pool emitter. + * Internal tasks usage statistics. */ -export class PoolEmitter extends EventEmitter {} +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. * - * @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. - */ - readonly workers: Worker[] - - /** - * The tasks map. - * - * - `key`: The `Worker` - * - `value`: Number of tasks currently in progress on the worker. - */ - readonly tasks: Map - - /** - * Emitter on which events can be listened to. - * - * Events that can currently be listened to: - * - * - `'busy'` + * Pool workers map. */ - readonly emitter?: PoolEmitter + readonly workers: Map> /** * Pool type. @@ -56,11 +53,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. * @@ -74,13 +66,21 @@ export interface IPoolInternal< readonly numberOfRunningTasks: number /** - * Find a tasks map entry with 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. * - * If an entry is found with a worker that has `0` tasks, it is detected as free. + * If no free worker is found, `false` is returned. * - * If no tasks map entry with a free worker was found, `false` will be returned. + * @returns A free worker if there is one, otherwise `false`. + */ + findFreeWorker: () => Worker | false + + /** + * Gets worker tasks usage. * - * @returns A tasks map entry with a free worker if there was one, otherwise `false`. + * @param worker - The worker. + * @returns The tasks usage on the worker. */ - findFreeTasksMapEntry(): [Worker, number] | false + getWorkerTasksUsage: (worker: Worker) => TasksUsage | undefined }