docs: enhance error message

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

diff --git a/src/pools/pool-internal.ts b/src/pools/pool-internal.ts
index d641fcf9d9fec246ee26a92a67a78d348b3dacf3..b245e360df704ee1e7fde5ce4e114da060cc70fd 100644 (file)
--- a/src/pools/pool-internal.ts
+++ b/src/pools/pool-internal.ts
@@ -1,19 +1,28 @@
-import EventEmitter from 'events'
-import type { MessageValue } from '../utility-types'
-import type { IWorker } from './abstract-pool'
 import type { IPool } from './pool'
+import type { IWorker, WorkerNode } from './worker'
 
 /**
- * Internal poolifier pool emitter.
+ * Internal pool types.
+ *
+ * @enum
  */
-export class PoolEmitter extends EventEmitter {}
+export enum PoolType {
+  /**
+   * Fixed pool type.
+   */
+  FIXED = 'fixed',
+  /**
+   * Dynamic pool type.
+   */
+  DYNAMIC = 'dynamic'
+}
 
 /**
  * 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. This can only be serializable data.
+ * @typeParam Response - Type of response of execution. This can only be serializable data.
  */
 export interface IPoolInternal<
   Worker extends IWorker,
@@ -21,61 +30,39 @@ export interface IPoolInternal<
   Response = unknown
 > extends IPool<Data, Response> {
   /**
-   * List of currently available workers.
+   * Pool worker nodes.
    */
-  readonly workers: Worker[]
+  readonly workerNodes: Array<WorkerNode<Worker, Data>>
 
   /**
-   * The tasks map.
+   * Pool type.
    *
-   * - `key`: The `Worker`
-   * - `value`: Number of tasks currently in progress on the worker.
+   * If it is `'dynamic'`, it provides the `max` property.
    */
-  readonly tasks: Map<Worker, number>
+  readonly type: PoolType
 
   /**
-   * Emitter on which events can be listened to.
+   * Whether the pool is full or not.
    *
-   * Events that can currently be listened to:
-   *
-   * - `'FullPool'`
+   * The pool filling boolean status.
    */
-  readonly emitter: PoolEmitter
+  readonly full: boolean
 
   /**
-   * Whether the pool is dynamic or not.
+   * Whether the pool is busy or not.
    *
-   * If it is dynamic, it provides the `max` property.
-   */
-  readonly dynamic: boolean
-
-  /**
-   * Maximum number of workers that can be created by this pool.
+   * The pool busyness boolean status.
    */
-  readonly max?: number
+  readonly busy: boolean
 
   /**
-   * Creates a new worker for this pool and sets it up completely.
+   * Finds a free worker node key based on the number of tasks the worker has applied.
    *
-   * @returns New, completely set up worker.
-   */
-  createAndSetupWorker(): Worker
-
-  /**
-   * Shut down given worker.
+   * If a worker is found with `0` running tasks, it is detected as free and its worker node key is returned.
    *
-   * @param worker A worker within `workers`.
-   */
-  destroyWorker(worker: Worker): void | Promise<void>
-
-  /**
-   * Register a listener callback on a given worker.
+   * If no free worker is found, `-1` is returned.
    *
-   * @param worker A worker.
-   * @param listener A message listener callback.
+   * @returns A worker node key if there is one, `-1` otherwise.
    */
-  registerWorkerMessageListener<Message extends Data | Response>(
-    worker: Worker,
-    listener: (message: MessageValue<Message>) => void
-  ): void
+  findFreeWorkerNodeKey: () => number
 }