X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fpool.ts;h=f16c54694ab37240e22d47fca1d97fb3d2ec7196;hb=184855e69fea29f1018024a34be10de2c8e3141a;hp=992aaaf1099c7e341daf3bd1c6a937597018b5ea;hpb=a86b6df187001e7e2e5c248ddb828286f985096c;p=poolifier.git diff --git a/src/pools/pool.ts b/src/pools/pool.ts index 992aaaf1..f16c5469 100644 --- a/src/pools/pool.ts +++ b/src/pools/pool.ts @@ -1,4 +1,4 @@ -import EventEmitter from 'node:events' +import EventEmitterAsyncResource from 'node:events' import type { ErrorHandler, ExitHandler, @@ -13,33 +13,50 @@ import type { } from './selection-strategies/selection-strategies-types' /** - * Pool types. - * - * @enum - * @internal + * Enumeration of pool types. */ -export enum PoolType { +export const PoolTypes = Object.freeze({ /** * Fixed pool type. */ - FIXED = 'fixed', + fixed: 'fixed', /** * Dynamic pool type. */ - DYNAMIC = 'dynamic' -} + dynamic: 'dynamic' +} as const) + +/** + * Pool type. + */ +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 EventEmitter {} +export class PoolEmitter extends EventEmitterAsyncResource {} /** * Enumeration of pool events. */ export const PoolEvents = Object.freeze({ full: 'full', - busy: 'busy' + busy: 'busy', + error: 'error', + taskError: 'taskError' } as const) /** @@ -47,6 +64,22 @@ export const PoolEvents = Object.freeze({ */ export type PoolEvent = keyof typeof PoolEvents +/** + * Pool information. + */ +export interface PoolInfo { + type: PoolType + worker: WorkerType + minSize: number + maxSize: number + workerNodes: number + idleWorkerNodes: number + busyWorkerNodes: number + runningTasks: number + queuedTasks: number + maxQueuedTasks: number +} + /** * Worker tasks queue options. */ @@ -91,6 +124,10 @@ export interface PoolOptions { * The worker choice strategy options. */ workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions + /** + * Restart worker on error. + */ + restartWorkerOnError?: boolean /** * Pool events emission. * @@ -127,6 +164,10 @@ export interface IPool< * If it is `'dynamic'`, it provides the `max` property. */ readonly type: PoolType + /** + * Pool information. + */ + readonly info: PoolInfo /** * Pool worker nodes. */ @@ -138,10 +179,12 @@ export interface IPool< * * - `'full'`: Emitted when the pool is dynamic and full. * - `'busy'`: Emitted when the pool is busy. + * - `'error'`: Emitted when an uncaught error occurs. + * - `'taskError'`: Emitted when an error occurs while executing a task. */ readonly emitter?: PoolEmitter /** - * Executes the function specified in the worker constructor with the task data input parameter. + * Executes the specified function in the worker constructor with the task data input parameter. * * @param data - The task input data for the specified worker function. This can only be serializable data. * @param name - The name of the worker function to execute. If not specified, the default worker function will be executed.