fix: ensure worker node cannot be instantiaed without proper arguments

[poolifier.git] / src / pools / pool.ts

diff --git a/src/pools/pool.ts b/src/pools/pool.ts
index 1a05f633250adb8e88c72a63cda565c3265205bc..09d2f229c5bbf02baf00172c494efa3d9df23584 100644 (file)
--- a/src/pools/pool.ts
+++ b/src/pools/pool.ts
@@ -42,11 +42,13 @@ export class PoolEmitter extends EventEmitter {}
  * Enumeration of pool events.
  */
 export const PoolEvents = Object.freeze({
-  full: 'full',
   ready: 'ready',
   busy: 'busy',
+  full: 'full',
+  destroy: 'destroy',
   error: 'error',
-  taskError: 'taskError'
+  taskError: 'taskError',
+  backPressure: 'backPressure'
 } as const)
 
 /**
@@ -77,6 +79,7 @@ export interface PoolInfo {
   readonly executingTasks: number
   readonly queuedTasks?: number
   readonly maxQueuedTasks?: number
+  readonly backPressure?: boolean
   readonly failedTasks: number
   readonly runTime?: {
     readonly minimum: number
@@ -110,6 +113,10 @@ export interface TasksQueueOptions {
  * @typeParam Worker - Type of worker.
  */
 export interface PoolOptions<Worker extends IWorker> {
+  /**
+   * A function that will listen for online event on each worker.
+   */
+  onlineHandler?: OnlineHandler<Worker>
   /**
    * A function that will listen for message event on each worker.
    */
@@ -118,10 +125,6 @@ export interface PoolOptions<Worker extends IWorker> {
    * A function that will listen for error event on each worker.
    */
   errorHandler?: ErrorHandler<Worker>
-  /**
-   * A function that will listen for online event on each worker.
-   */
-  onlineHandler?: OnlineHandler<Worker>
   /**
    * A function that will listen for exit event on each worker.
    */
@@ -176,18 +179,30 @@ export interface IPool<
   readonly info: PoolInfo
   /**
    * Pool worker nodes.
+   *
+   * @internal
    */
   readonly workerNodes: Array<IWorkerNode<Worker, Data>>
+  /**
+   * Whether the worker node has back pressure (i.e. its tasks queue is full).
+   *
+   * @param workerNodeKey - The worker node key.
+   * @returns `true` if the worker node has back pressure, `false` otherwise.
+   * @internal
+   */
+  readonly hasWorkerNodeBackPressure: (workerNodeKey: number) => boolean
   /**
    * Emitter on which events can be listened to.
    *
    * Events that can currently be listened to:
    *
-   * - `'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 minimum 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.
+   * - `'full'`: Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.
+   * - '`destroy`': Emitted when the pool is destroyed.
    * - `'error'`: Emitted when an uncaught error occurs.
    * - `'taskError'`: Emitted when an error occurs while executing a task.
+   * - `'backPressure'`: Emitted when all worker nodes have back pressure (i.e. their tasks queue is full: queue size \>= pool maximum size^2).
    */
   readonly emitter?: PoolEmitter
   /**
@@ -207,6 +222,12 @@ export interface IPool<
    * Terminates all workers in this pool.
    */
   readonly destroy: () => Promise<void>
+  /**
+   * Lists the names of task function available in this pool.
+   *
+   * @returns The names of task function available in this pool.
+   */
+  readonly listTaskFunctions: () => string[]
   /**
    * Sets the worker choice strategy in this pool.
    *