X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=src%2Fpools%2Fpool.ts;h=87f4a8fa03f781aab2a17926fd98ab088387bf1b;hb=64383951fbf11fdf6a804fc6d081635fb925e403;hp=89559d2c9a1bf0e6694709d3908a0263af0c448e;hpb=1f68cedebde2cf95b6345300ac52cf7ca3ecbdff;p=poolifier.git

diff --git a/src/pools/pool.ts b/src/pools/pool.ts
index 89559d2c..87f4a8fa 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.
@@ -40,7 +55,8 @@ export class PoolEmitter extends EventEmitterAsyncResource {}
 export const PoolEvents = Object.freeze({
   full: 'full',
   busy: 'busy',
-  error: 'error'
+  error: 'error',
+  taskError: 'taskError'
 } as const)
 
 /**
@@ -48,6 +64,29 @@ export const PoolEvents = Object.freeze({
  */
 export type PoolEvent = keyof typeof PoolEvents
 
+/**
+ * Pool information.
+ */
+export interface PoolInfo {
+  type: PoolType
+  worker: WorkerType
+  minSize: number
+  maxSize: number
+  /** Pool utilization ratio. */
+  utilization: number
+  /** Pool total worker nodes */
+  workerNodes: number
+  /** Pool idle worker nodes */
+  idleWorkerNodes: number
+  /** Pool busy worker nodes */
+  busyWorkerNodes: number
+  executedTasks: number
+  executingTasks: number
+  queuedTasks: number
+  maxQueuedTasks: number
+  failedTasks: number
+}
+
 /**
  * Worker tasks queue options.
  */
@@ -118,8 +157,8 @@ export interface PoolOptions<Worker extends IWorker> {
  * Contract definition for a poolifier pool.
  *
  * @typeParam Worker - Type of worker which manages this pool.
- * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
- * @typeParam Response - Type of execution response. This can only be serializable data.
+ * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
+ * @typeParam Response - Type of execution response. This can only be structured-cloneable data.
  */
 export interface IPool<
   Worker extends IWorker,
@@ -127,15 +166,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.
    */
@@ -147,19 +180,20 @@ export interface IPool<
    *
    * - `'full'`: Emitted when the pool is dynamic and full.
    * - `'busy'`: Emitted when the pool is busy.
-   * - `'error'`: Emitted when an error occurs.
+   * - `'error'`: Emitted when an uncaught error occurs.
+   * - `'taskError'`: Emitted when an error occurs while executing a task.
    */
   readonly emitter?: PoolEmitter
   /**
    * 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 data - The task input data for the specified worker function. This can only be structured-cloneable data.
    * @param name - The name of the worker function to execute. If not specified, the default worker function will be executed.
    * @returns Promise that will be fulfilled when the task is completed.
    */
   execute: (data?: Data, name?: string) => Promise<Response>
   /**
-   * Shutdowns every current worker in this pool.
+   * Terminates every current worker in this pool.
    */
   destroy: () => Promise<void>
   /**