X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fpool.ts;h=78d298f90f20381d3cb2157d276e32ced109f4a2;hb=2431bdb4c2dc637169bf623a40fc6562f685e56e;hp=22757f9a54a841597d0394c51675efa25ac08a5d;hpb=23ccf9d796ac950710863515ff45612a0456931d;p=poolifier.git diff --git a/src/pools/pool.ts b/src/pools/pool.ts index 22757f9a..78d298f9 100644 --- a/src/pools/pool.ts +++ b/src/pools/pool.ts @@ -1,11 +1,12 @@ -import EventEmitterAsyncResource from 'node:events' +import { EventEmitter } from 'node:events' import type { ErrorHandler, ExitHandler, IWorker, + IWorkerNode, MessageHandler, OnlineHandler, - WorkerNode + WorkerType } from './worker' import type { WorkerChoiceStrategy, @@ -31,29 +32,17 @@ export const PoolTypes = Object.freeze({ */ export type PoolType = keyof typeof PoolTypes -/** - * Enumeration of worker types. - */ -export const WorkerTypes = Object.freeze({ - cluster: 'cluster', - thread: 'thread' -} as const) - -/** - * Worker type. - */ -export type WorkerType = keyof typeof WorkerTypes - /** * Pool events emitter. */ -export class PoolEmitter extends EventEmitterAsyncResource {} +export class PoolEmitter extends EventEmitter {} /** * Enumeration of pool events. */ export const PoolEvents = Object.freeze({ full: 'full', + ready: 'ready', busy: 'busy', error: 'error', taskError: 'taskError' @@ -68,24 +57,38 @@ export type PoolEvent = keyof typeof PoolEvents * Pool information. */ export interface PoolInfo { - version: string - type: PoolType - worker: WorkerType - minSize: number - maxSize: number + readonly version: string + readonly type: PoolType + readonly worker: WorkerType + readonly ready: boolean + readonly strategy: WorkerChoiceStrategy + readonly minSize: number + readonly maxSize: number /** Pool utilization ratio. */ - utilization?: number + readonly utilization?: number /** Pool total worker nodes */ - workerNodes: number + readonly workerNodes: number /** Pool idle worker nodes */ - idleWorkerNodes: number + readonly idleWorkerNodes: number /** Pool busy worker nodes */ - busyWorkerNodes: number - executedTasks: number - executingTasks: number - queuedTasks: number - maxQueuedTasks: number - failedTasks: number + readonly busyWorkerNodes: number + readonly executedTasks: number + readonly executingTasks: number + readonly queuedTasks: number + readonly maxQueuedTasks: number + readonly failedTasks: number + readonly runTime?: { + readonly minimum: number + readonly maximum: number + readonly average: number + readonly median?: number + } + readonly waitTime?: { + readonly minimum: number + readonly maximum: number + readonly average: number + readonly median?: number + } } /** @@ -173,14 +176,15 @@ export interface IPool< /** * Pool worker nodes. */ - readonly workerNodes: Array> + readonly workerNodes: Array> /** * Emitter on which events can be listened to. * * Events that can currently be listened to: * - * - `'full'`: Emitted when the pool is dynamic and full. - * - `'busy'`: Emitted when the pool is busy. + * - `'full'`: Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected. + * - `'ready'`: Emitted when the number of workers created in the pool has reached the maximum size expected and are ready. + * - `'busy'`: Emitted when the number of workers created in the pool has reached the maximum size expected and are executing at least one task. * - `'error'`: Emitted when an uncaught error occurs. * - `'taskError'`: Emitted when an error occurs while executing a task. */ @@ -192,18 +196,18 @@ export interface IPool< * @param name - The name of the worker function to execute. If not specified, the default worker function will be executed. * @returns Promise that will be fulfilled when the task is completed. */ - execute: (data?: Data, name?: string) => Promise + readonly execute: (data?: Data, name?: string) => Promise /** * Terminates every current worker in this pool. */ - destroy: () => Promise + readonly destroy: () => Promise /** * Sets the worker choice strategy in this pool. * * @param workerChoiceStrategy - The worker choice strategy. * @param workerChoiceStrategyOptions - The worker choice strategy options. */ - setWorkerChoiceStrategy: ( + readonly setWorkerChoiceStrategy: ( workerChoiceStrategy: WorkerChoiceStrategy, workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions ) => void @@ -212,7 +216,7 @@ export interface IPool< * * @param workerChoiceStrategyOptions - The worker choice strategy options. */ - setWorkerChoiceStrategyOptions: ( + readonly setWorkerChoiceStrategyOptions: ( workerChoiceStrategyOptions: WorkerChoiceStrategyOptions ) => void /** @@ -221,7 +225,7 @@ export interface IPool< * @param enable - Whether to enable or disable the worker tasks queue. * @param tasksQueueOptions - The worker tasks queue options. */ - enableTasksQueue: ( + readonly enableTasksQueue: ( enable: boolean, tasksQueueOptions?: TasksQueueOptions ) => void @@ -230,5 +234,5 @@ export interface IPool< * * @param tasksQueueOptions - The worker tasks queue options. */ - setTasksQueueOptions: (tasksQueueOptions: TasksQueueOptions) => void + readonly setTasksQueueOptions: (tasksQueueOptions: TasksQueueOptions) => void }