X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fpool-internal.ts;h=e0d0534f83a846cbfac77eb87e305e0975c49abf;hb=e5a5c0fc68a38b7d6316cc573c34313aa6ec30e9;hp=ddee27eac0ed21bf43ca4f61b8378ee3a3146b6a;hpb=a35560bac09e829e1e19f88f8fd1d71a64c9d50b;p=poolifier.git diff --git a/src/pools/pool-internal.ts b/src/pools/pool-internal.ts index ddee27ea..e0d0534f 100644 --- a/src/pools/pool-internal.ts +++ b/src/pools/pool-internal.ts @@ -1,22 +1,33 @@ -import EventEmitter from 'events' -import type { MessageValue } from '../utility-types' -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 +} /** * 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 { @@ -26,56 +37,64 @@ export interface IPoolInternal< readonly workers: Worker[] /** - * The tasks map. + * The workers tasks usage map. * - * - `key`: The `Worker` - * - `value`: Number of tasks currently in progress on the worker. + * `key`: The `Worker` + * `value`: Worker tasks usage statistics. */ - readonly tasks: Map + readonly workersTasksUsage: Map /** - * Emitter on which events can be listened to. + * Pool type. * - * Events that can currently be listened to: + * If it is `'dynamic'`, it provides the `max` property. + */ + readonly type: PoolType + + /** + * Whether the pool is busy or not. * - * - `'FullPool'` + * The pool busyness boolean status. */ - readonly emitter: PoolEmitter + readonly busy: boolean /** - * Maximum number of workers that can be created by this pool. + * Number of tasks currently concurrently running. */ - readonly max?: number + readonly numberOfRunningTasks: number /** - * Whether the pool is dynamic or not. + * 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 no free worker is found, `false` is returned. * - * If it is dynamic, it provides the `max` property. + * @returns A free worker if there is one, otherwise `false`. */ - isDynamic(): boolean + findFreeWorker: () => Worker | false /** - * Creates a new worker for this pool and sets it up completely. + * Gets worker index. * - * @returns New, completely set up worker. + * @param worker - The worker. + * @returns The worker index. */ - createAndSetupWorker(): Worker + getWorkerIndex: (worker: Worker) => number /** - * Shut down given worker. + * Gets worker running tasks. * - * @param worker A worker within `workers`. + * @param worker - The worker. + * @returns The number of tasks currently running on the worker. */ - destroyWorker(worker: Worker): void | Promise + getWorkerRunningTasks: (worker: Worker) => number | undefined /** - * Register a listener callback on a given worker. + * Gets worker average tasks runtime. * - * @param worker A worker. - * @param listener A message listener callback. + * @param worker - The worker. + * @returns The average tasks runtime on the worker. */ - registerWorkerMessageListener( - worker: Worker, - listener: (message: MessageValue) => void - ): void + getWorkerAverageTasksRunTime: (worker: Worker) => number | undefined }