X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fpool.ts;h=a8d8849b0797f9e8a16f71058fbca0046d782c73;hb=cd312fe991ae10e66137fe4f70525076bbe4a04d;hp=b5eec21c714798099076be2dab22f64aec4722ac;hpb=dbd73092cca6cabb2b41e18b944656fc43f8757b;p=poolifier.git diff --git a/src/pools/pool.ts b/src/pools/pool.ts index b5eec21c..a8d8849b 100644 --- a/src/pools/pool.ts +++ b/src/pools/pool.ts @@ -1,5 +1,6 @@ -import { EventEmitter } from 'node:events' -import { type TransferListItem } from 'node:worker_threads' +import { EventEmitterAsyncResource } from 'node:events' +import type { TransferListItem } from 'node:worker_threads' +import type { TaskFunction } from '../worker/task-functions' import type { ErrorHandler, ExitHandler, @@ -34,9 +35,9 @@ export const PoolTypes = Object.freeze({ export type PoolType = keyof typeof PoolTypes /** - * Pool events emitter. + * Pool event emitter integrated with async resource. */ -export class PoolEmitter extends EventEmitter {} +export class PoolEmitter extends EventEmitterAsyncResource {} /** * Enumeration of pool events. @@ -135,24 +136,32 @@ export interface TasksQueueOptions { export interface PoolOptions { /** * A function that will listen for online event on each worker. + * + * @defaultValue `() => {}` */ onlineHandler?: OnlineHandler /** * A function that will listen for message event on each worker. + * + * @defaultValue `() => {}` */ messageHandler?: MessageHandler /** * A function that will listen for error event on each worker. + * + * @defaultValue `() => {}` */ errorHandler?: ErrorHandler /** * A function that will listen for exit event on each worker. + * + * @defaultValue `() => {}` */ exitHandler?: ExitHandler /** * Whether to start the minimum number of workers at pool initialization. * - * @defaultValue false + * @defaultValue true */ startWorkers?: boolean /** @@ -170,7 +179,7 @@ export interface PoolOptions { */ restartWorkerOnError?: boolean /** - * Pool events emission. + * Pool events integrated with async resource emission. * * @defaultValue true */ @@ -218,7 +227,8 @@ export interface IPool< */ readonly hasWorkerNodeBackPressure: (workerNodeKey: number) => boolean /** - * Emitter on which events can be listened to. + * Event emitter integrated with async resource on which events can be listened to. + * The async tracking tooling identifier is `poolifier:--pool`. * * Events that can currently be listened to: * @@ -252,12 +262,47 @@ export interface IPool< * Terminates all workers in this pool. */ readonly destroy: () => Promise + /** + * Whether the specified task function exists in this pool. + * + * @param name - The name of the task function. + * @returns `true` if the task function exists, `false` otherwise. + */ + readonly hasTaskFunction: (name: string) => boolean + /** + * Adds a task function to this pool. + * If a task function with the same name already exists, it will be overwritten. + * + * @param name - The name of the task function. + * @param fn - The task function. + * @returns `true` if the task function was added, `false` otherwise. + * @throws {@link https://nodejs.org/api/errors.html#class-typeerror} If the `name` parameter is not a string or an empty string. + * @throws {@link https://nodejs.org/api/errors.html#class-typeerror} If the `fn` parameter is not a function. + */ + readonly addTaskFunction: ( + name: string, + fn: TaskFunction + ) => Promise + /** + * Removes a task function from this pool. + * + * @param name - The name of the task function. + * @returns `true` if the task function was removed, `false` otherwise. + */ + readonly removeTaskFunction: (name: string) => Promise /** * Lists the names of task function available in this pool. * * @returns The names of task function available in this pool. */ - readonly listTaskFunctions: () => string[] + readonly listTaskFunctionNames: () => string[] + /** + * Sets the default task function in this pool. + * + * @param name - The name of the task function. + * @returns `true` if the default task function was set, `false` otherwise. + */ + readonly setDefaultTaskFunction: (name: string) => Promise /** * Sets the worker choice strategy in this pool. *