Merge branch 'master' of github.com:poolifier/poolifier

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

diff --git a/src/pools/pool-internal.ts b/src/pools/pool-internal.ts
index 71120110f75bfb48c6e005876b8b7715e53f53fb..e0d0534f83a846cbfac77eb87e305e0975c49abf 100644 (file)
--- a/src/pools/pool-internal.ts
+++ b/src/pools/pool-internal.ts
@@ -1,9 +1,8 @@
-import EventEmitter from 'events'
-import type { AbstractPoolWorker } from './abstract-pool-worker'
 import type { IPool } from './pool'
+import type { IPoolWorker } from './pool-worker'
 
 /**
- * Pool types.
+ * Internal pool types.
  */
 export enum PoolType {
   FIXED = 'fixed',
@@ -11,19 +10,24 @@ export enum PoolType {
 }
 
 /**
- * Internal poolifier pool emitter.
+ * Internal tasks usage statistics.
  */
-export class PoolEmitter extends EventEmitter {}
+export interface TasksUsage {
+  run: number
+  running: number
+  runTime: number
+  avgRunTime: number
+}
 
 /**
  * Internal contract definition for a poolifier pool.
  *
- * @template Worker Type of worker which manages this pool.
- * @template Data Type of data sent to the worker.
- * @template Response Type of response of execution.
+ * @typeParam Worker - Type of worker which manages this pool.
+ * @typeParam Data - Type of data sent to the worker.
+ * @typeParam Response - Type of response of execution.
  */
 export interface IPoolInternal<
-  Worker extends AbstractPoolWorker,
+  Worker extends IPoolWorker,
   Data = unknown,
   Response = unknown
 > extends IPool<Data, Response> {
@@ -33,21 +37,12 @@ export interface IPoolInternal<
   readonly workers: Worker[]
 
   /**
-   * The tasks map.
+   * The workers tasks usage map.
    *
-   * - `key`: The `Worker`
-   * - `value`: Number of tasks currently in progress on the worker.
+   *  `key`: The `Worker`
+   *  `value`: Worker tasks usage statistics.
    */
-  readonly tasks: Map<Worker, number>
-
-  /**
-   * Emitter on which events can be listened to.
-   *
-   * Events that can currently be listened to:
-   *
-   * - `'busy'`
-   */
-  readonly emitter?: PoolEmitter
+  readonly workersTasksUsage: Map<Worker, TasksUsage>
 
   /**
    * Pool type.
@@ -56,11 +51,6 @@ export interface IPoolInternal<
    */
   readonly type: PoolType
 
-  /**
-   * Maximum number of workers that can be created by this pool.
-   */
-  readonly max?: number
-
   /**
    * Whether the pool is busy or not.
    *
@@ -74,7 +64,7 @@ export interface IPoolInternal<
   readonly numberOfRunningTasks: number
 
   /**
-   * Find a free worker based on the number of tasks the worker has applied.
+   * Finds a free worker based on the number of tasks the worker has applied.
    *
    * If a worker is found with `0` running tasks, it is detected as free and returned.
    *
@@ -82,21 +72,29 @@ export interface IPoolInternal<
    *
    * @returns A free worker if there is one, otherwise `false`.
    */
-  findFreeWorker(): Worker | false
+  findFreeWorker: () => Worker | false
 
   /**
-   * Get worker index.
+   * Gets worker index.
    *
-   * @param worker The worker.
+   * @param worker - The worker.
    * @returns The worker index.
    */
-  getWorkerIndex(worker: Worker): number
+  getWorkerIndex: (worker: Worker) => number
 
   /**
-   * Get worker running tasks.
+   * Gets worker running tasks.
    *
-   * @param worker The worker.
+   * @param worker - The worker.
    * @returns The number of tasks currently running on the worker.
    */
-  getWorkerRunningTasks(worker: Worker): number | undefined
+  getWorkerRunningTasks: (worker: Worker) => number | undefined
+
+  /**
+   * Gets worker average tasks runtime.
+   *
+   * @param worker - The worker.
+   * @returns The average tasks runtime on the worker.
+   */
+  getWorkerAverageTasksRunTime: (worker: Worker) => number | undefined
 }