refactor: untangle worker choosing code from worker creation code
[poolifier.git] / src / pools / selection-strategies / selection-strategies-types.ts
index edefcfaac429d8c0d24fa897300650d141ab7f3c..9acf819b8b858900a1d42a5a681d7f001b152edf 100644 (file)
@@ -1,5 +1,3 @@
-import type { AbstractPoolWorker } from '../abstract-pool-worker'
-
 /**
  * Enumeration of worker choice strategies.
  */
@@ -9,9 +7,21 @@ export const WorkerChoiceStrategies = Object.freeze({
    */
   ROUND_ROBIN: 'ROUND_ROBIN',
   /**
-   * Less recently used worker selection strategy.
+   * Less used worker selection strategy.
+   */
+  LESS_USED: 'LESS_USED',
+  /**
+   * Less busy worker selection strategy.
+   */
+  LESS_BUSY: 'LESS_BUSY',
+  /**
+   * Fair share worker selection strategy.
    */
-  LESS_RECENTLY_USED: 'LESS_RECENTLY_USED'
+  FAIR_SHARE: 'FAIR_SHARE',
+  /**
+   * Weighted round robin worker selection strategy.
+   */
+  WEIGHTED_ROUND_ROBIN: 'WEIGHTED_ROUND_ROBIN'
 } as const)
 
 /**
@@ -19,18 +29,38 @@ export const WorkerChoiceStrategies = Object.freeze({
  */
 export type WorkerChoiceStrategy = keyof typeof WorkerChoiceStrategies
 
+/**
+ * Pool worker tasks usage statistics requirements.
+ */
+export interface RequiredStatistics {
+  runTime: boolean
+  avgRunTime: boolean
+}
+
 /**
  * Worker choice strategy interface.
- *
- * @template Worker Type of worker which manages the strategy.
  */
-export interface IWorkerChoiceStrategy<Worker extends AbstractPoolWorker> {
+export interface IWorkerChoiceStrategy {
+  /**
+   * Is the pool bound to the strategy dynamic?.
+   */
+  readonly isDynamicPool: boolean
+  /**
+   * Required pool tasks usage statistics.
+   */
+  readonly requiredStatistics: RequiredStatistics
+  /**
+   * Resets strategy internals (counters, statistics, etc.).
+   */
+  reset: () => boolean
   /**
-   * Is the pool attached to the strategy dynamic?.
+   * Chooses a worker in the pool and returns its key.
    */
-  isDynamicPool: boolean
+  choose: () => number
   /**
-   * Choose a worker in the pool.
+   * Removes a worker reference from strategy internals.
+   *
+   * @param workerKey - The worker key.
    */
-  choose(): Worker
+  remove: (workerKey: number) => boolean
 }