X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=src%2Fpools%2Fpool-internal.ts;h=c3ec39bea578d3de3c0423f2ef789e0cd6c6f9df;hb=7cd8af0033b35def46016a78ea9be1ee516480bf;hp=2cf84adbc6bfd28e9d552795cbb3b49bbe8ffee4;hpb=23135a899846318ad8c093ee03ae5301782bc011;p=poolifier.git diff --git a/src/pools/pool-internal.ts b/src/pools/pool-internal.ts index 2cf84adb..c3ec39be 100644 --- a/src/pools/pool-internal.ts +++ b/src/pools/pool-internal.ts @@ -1,9 +1,10 @@ -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. + * + * @enum */ export enum PoolType { FIXED = 'fixed', @@ -11,45 +12,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 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 AbstractPoolWorker, + Worker extends IPoolWorker, Data = unknown, Response = unknown > extends IPool { /** - * List of currently available workers. - */ - readonly workers: Worker[] - - /** - * 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. @@ -59,9 +57,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. @@ -71,42 +71,13 @@ export interface IPoolInternal< readonly busy: boolean /** - * Number of tasks currently concurrently running. - */ - 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 runtime. + * If no free worker is found, `-1` is returned. * - * @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 }