docs: enhance documentation

[poolifier.git] / src / pools / thread / dynamic.ts

diff --git a/src/pools/thread/dynamic.ts b/src/pools/thread/dynamic.ts
index 3e74a4ea4b7fe053445f3c204104b13f28e43e65..7bf477dd837c0ce3e30cb65ad308c32ca0774f48 100644 (file)
--- a/src/pools/thread/dynamic.ts
+++ b/src/pools/thread/dynamic.ts
@@ -1,5 +1,5 @@
-import { isKillBehavior, KillBehaviors } from '../../worker/worker-options'
-import type { PoolOptions } from '../abstract-pool'
+import type { PoolOptions } from '../pool'
+import { PoolType } from '../pool'
 import type { ThreadWorkerWithMessageChannel } from './fixed'
 import { FixedThreadPool } from './fixed'
 
@@ -7,11 +7,10 @@ import { FixedThreadPool } from './fixed'
  * A thread pool with a dynamic number of threads, but a guaranteed minimum number of threads.
  *
  * This thread pool creates new threads when the others are busy, up to the maximum number of threads.
- * When the maximum number of threads is reached, an event is emitted. If you want to listen to this event, use the pool's `emitter`.
- *
- * @template Data Type of data sent to the worker. This can only be serializable data.
- * @template Response Type of response of execution. This can only be serializable data.
+ * When the maximum number of threads is reached and workers are busy, an event is emitted. If you want to listen to this event, use the pool's `emitter`.
  *
+ * @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.
  * @author [Alessandro Pio Ardizio](https://github.com/pioardi)
  * @since 0.0.1
  */
@@ -22,54 +21,32 @@ export class DynamicThreadPool<
   /**
    * Constructs a new poolifier dynamic thread pool.
    *
-   * @param min Minimum number of threads which are always active.
-   * @param max Maximum number of threads that can be created by this pool.
-   * @param filePath Path to an implementation of a `ThreadWorker` file, which can be relative or absolute.
-   * @param opts Options for this dynamic thread pool. Default: `{ maxTasks: 1000 }`
+   * @param min - Minimum number of threads which are always active.
+   * @param max - Maximum number of threads that can be created by this pool.
+   * @param filePath - Path to an implementation of a `ThreadWorker` file, which can be relative or absolute.
+   * @param opts - Options for this dynamic thread pool.
    */
   public constructor (
     min: number,
     public readonly max: number,
     filePath: string,
-    opts: PoolOptions<ThreadWorkerWithMessageChannel> = { maxTasks: 1000 }
+    opts: PoolOptions<ThreadWorkerWithMessageChannel> = {}
   ) {
     super(min, filePath, opts)
   }
 
-  /**
-   * Choose a thread for the next task.
-   *
-   * It will first check for and return an idle thread.
-   * If all threads are busy, then it will try to create a new one up to the `max` thread count.
-   * If the max thread count is reached, the emitter will emit a `FullPool` event and it will fall back to using a round robin algorithm to distribute the load.
-   *
-   * @returns Thread worker.
-   */
-  protected chooseWorker (): ThreadWorkerWithMessageChannel {
-    for (const [worker, numberOfTasks] of this.tasks) {
-      if (numberOfTasks === 0) {
-        // A worker is free, use it
-        return worker
-      }
-    }
+  /** @inheritDoc */
+  public get type (): PoolType {
+    return PoolType.DYNAMIC
+  }
 
-    if (this.workers.length === this.max) {
-      this.emitter.emit('FullPool')
-      return super.chooseWorker()
-    }
+  /** @inheritDoc */
+  protected get full (): boolean {
+    return this.workerNodes.length === this.max
+  }
 
-    // All workers are busy, create a new worker
-    const workerCreated = this.createAndSetupWorker()
-    this.registerWorkerMessageListener<Data>(workerCreated, message => {
-      const tasksInProgress = this.tasks.get(workerCreated)
-      if (
-        isKillBehavior(KillBehaviors.HARD, message.kill) ||
-        tasksInProgress === 0
-      ) {
-        // Kill received from the worker, means that no new tasks are submitted to that worker for a while ( > maxInactiveTime)
-        void this.destroyWorker(workerCreated)
-      }
-    })
-    return workerCreated
+  /** @inheritDoc */
+  protected get busy (): boolean {
+    return this.full && this.internalBusy()
   }
 }