X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fpool.ts;h=257b0d64b0844d664ba00763b1dcde79c4711ee7;hb=dc32abbbbd36504ce933a0403cc245899c25a828;hp=14b30812d14bd21e55c0af4aee77db5daf8bc7e4;hpb=9e45c2c437217612e71b46b207a994f9106dff23;p=poolifier.git diff --git a/src/pools/pool.ts b/src/pools/pool.ts index 14b30812..257b0d64 100644 --- a/src/pools/pool.ts +++ b/src/pools/pool.ts @@ -13,21 +13,36 @@ 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. @@ -39,7 +54,9 @@ export class PoolEmitter extends EventEmitterAsyncResource {} */ export const PoolEvents = Object.freeze({ full: 'full', - busy: 'busy' + busy: 'busy', + error: 'error', + taskError: 'taskError' } as const) /** @@ -47,6 +64,24 @@ 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 + executedTasks: number + executingTasks: number + queuedTasks: number + maxQueuedTasks: number + failedTasks: number +} + /** * Worker tasks queue options. */ @@ -91,6 +126,10 @@ export interface PoolOptions { * The worker choice strategy options. */ workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions + /** + * Restart worker on error. + */ + restartWorkerOnError?: boolean /** * Pool events emission. * @@ -122,15 +161,9 @@ export interface IPool< Response = unknown > { /** - * Pool type. - * - * If it is `'dynamic'`, it provides the `max` property. - */ - readonly type: PoolType - /** - * Pool maximum size. + * Pool information. */ - readonly size: number + readonly info: PoolInfo /** * Pool worker nodes. */ @@ -142,6 +175,8 @@ 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 /** @@ -153,7 +188,7 @@ export interface IPool< */ execute: (data?: Data, name?: string) => Promise /** - * Shutdowns every current worker in this pool. + * Terminate every current worker in this pool. */ destroy: () => Promise /**