X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fpool-internal.ts;h=095e954e2c2bb498ad27f1e1a5999686b99249a7;hb=53cf34054602ef192d39c45ef257eddc0ae0fa97;hp=3f35ec13e25b79e67c3cb2c9084843adcbf63f99;hpb=8accb8d5d2f8a6d77017a421938796623ac2b239;p=poolifier.git diff --git a/src/pools/pool-internal.ts b/src/pools/pool-internal.ts index 3f35ec13..095e954e 100644 --- a/src/pools/pool-internal.ts +++ b/src/pools/pool-internal.ts @@ -1,9 +1,8 @@ -import EventEmitter from 'events' import type { IPool } from './pool' import type { IPoolWorker } from './pool-worker' /** - * Pool types. + * Internal pool types. */ export enum PoolType { FIXED = 'fixed', @@ -11,26 +10,32 @@ 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 type items 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. 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, @@ -38,26 +43,9 @@ export interface IPoolInternal< Response = unknown > extends IPool { /** - * List of currently available workers. - */ - readonly workers: Worker[] - - /** - * The workers tasks usage map. - * - * `key`: The `Worker` - * `value`: Worker tasks usage statistics. - */ - readonly workersTasksUsage: Map - - /** - * Emitter on which events can be listened to. - * - * Events that can currently be listened to: - * - * - `'busy'` + * Pool worker type items array. */ - readonly emitter?: PoolEmitter + readonly workers: Array> /** * Pool type. @@ -67,9 +55,11 @@ export interface IPoolInternal< readonly type: PoolType /** - * Maximum number of workers that can be created by this pool. + * Whether the pool is full or not. + * + * The pool filling boolean status. */ - readonly max?: number + readonly full: boolean /** * Whether the pool is busy or not. @@ -79,42 +69,13 @@ export interface IPoolInternal< readonly busy: boolean /** - * Number of tasks currently concurrently running. - */ - readonly numberOfRunningTasks: number - - /** - * Finds 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 - - /** - * Gets worker index. - * - * @param worker The worker. - * @returns The worker index. - */ - getWorkerIndex(worker: Worker): number - - /** - * Gets worker running tasks. - * - * @param worker The worker. - * @returns The number of tasks currently running on the worker. - */ - getWorkerRunningTasks(worker: Worker): number | undefined - - /** - * Gets worker average tasks runtime. - * - * @param worker The worker. - * @returns The average tasks runtime on the worker. + * @returns A worker key if there is one, `-1` otherwise. */ - getWorkerAverageTasksRunTime(worker: Worker): number | undefined + findFreeWorkerKey: () => number }