X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fpool.ts;h=2cdf9b748db6350b0bfa7c9e64aedd8b32b296cf;hb=243a550a93e278669fe5602aeba92dc8ba11260e;hp=dbbb5969ebd920022e31d64d156f087065aa9d12;hpb=38e795c12f0e9daeff7b025147f36f85f486366e;p=poolifier.git diff --git a/src/pools/pool.ts b/src/pools/pool.ts index dbbb5969..2cdf9b74 100644 --- a/src/pools/pool.ts +++ b/src/pools/pool.ts @@ -1,21 +1,50 @@ -import EventEmitter from 'events' +import EventEmitter from 'node:events' import type { ErrorHandler, ExitHandler, + IWorker, MessageHandler, OnlineHandler -} from './pool-worker' -import type { WorkerChoiceStrategy } from './selection-strategies/selection-strategies-types' +} from './worker' +import type { + WorkerChoiceStrategy, + WorkerChoiceStrategyOptions +} from './selection-strategies/selection-strategies-types' /** * Pool events emitter. */ export class PoolEmitter extends EventEmitter {} +/** + * Enumeration of pool events. + */ +export const PoolEvents = Object.freeze({ + full: 'full', + busy: 'busy' +} as const) + +/** + * Pool event. + */ +export type PoolEvent = keyof typeof PoolEvents + +/** + * Worker tasks queue options. + */ +export interface TasksQueueOptions { + /** + * Maximum number of tasks that can be executed concurrently on a worker. + * + * @defaultValue 1 + */ + concurrency?: number +} + /** * Options for a poolifier pool. */ -export interface PoolOptions { +export interface PoolOptions { /** * A function that will listen for message event on each worker. */ @@ -36,12 +65,30 @@ export interface PoolOptions { * The worker choice strategy to use in this pool. */ workerChoiceStrategy?: WorkerChoiceStrategy + /** + * The worker choice strategy options. + */ + workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions /** * Pool events emission. * * @defaultValue true */ enableEvents?: boolean + /** + * Pool worker tasks queue. + * + * @experimental + * @defaultValue false + */ + enableTasksQueue?: boolean + /** + * Pool worker tasks queue options. + * + * @experimental + * @defaultValue \{ concurrency: 1 \} + */ + tasksQueueOptions?: TasksQueueOptions } /** @@ -56,7 +103,8 @@ export interface IPool { * * Events that can currently be listened to: * - * - `'busy'` + * - `'full'`: Emitted when the pool is dynamic and full. + * - `'busy'`: Emitted when the pool is busy. */ readonly emitter?: PoolEmitter /**