X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fselection-strategies%2Fselection-strategies-types.ts;h=c90036fe6f269dd7757482064a3fdba0b7a97e97;hb=ace229a1b5029d3acaeeb4e8abdab415de5318f1;hp=9ae6676550be28564a12eae35f6e64ce15db640d;hpb=168c526f6e6913506e56f7d5107335c3d3d42938;p=poolifier.git

diff --git a/src/pools/selection-strategies/selection-strategies-types.ts b/src/pools/selection-strategies/selection-strategies-types.ts
index 9ae66765..c90036fe 100644
--- a/src/pools/selection-strategies/selection-strategies-types.ts
+++ b/src/pools/selection-strategies/selection-strategies-types.ts
@@ -1,5 +1,3 @@
-import type { IPoolWorker } from '../pool-worker'
-
 /**
  * Enumeration of worker choice strategies.
  */
@@ -9,13 +7,13 @@ export const WorkerChoiceStrategies = Object.freeze({
    */
   ROUND_ROBIN: 'ROUND_ROBIN',
   /**
-   * Less used worker selection strategy.
+   * Least used worker selection strategy.
    */
-  LESS_USED: 'LESS_USED',
+  LEAST_USED: 'LEAST_USED',
   /**
-   * Less busy worker selection strategy.
+   * Least busy worker selection strategy.
    */
-  LESS_BUSY: 'LESS_BUSY',
+  LEAST_BUSY: 'LEAST_BUSY',
   /**
    * Fair share worker selection strategy.
    */
@@ -32,32 +30,99 @@ export const WorkerChoiceStrategies = Object.freeze({
 export type WorkerChoiceStrategy = keyof typeof WorkerChoiceStrategies
 
 /**
- * Pool tasks usage statistics requirements.
+ * Worker choice strategy options.
  */
-export interface RequiredStatistics {
-  runTime: boolean
+export interface WorkerChoiceStrategyOptions {
+  /**
+   * Use tasks median runtime instead of average runtime.
+   *
+   * @defaultValue false
+   */
+  medRunTime?: boolean
+  /**
+   * Use tasks median wait time instead of average runtime.
+   *
+   * @defaultValue false
+   */
+  medWaitTime?: boolean
+  /**
+   * Worker weights to use for weighted round robin worker selection strategy.
+   * Weight is the tasks maximum average or median runtime in milliseconds.
+   *
+   * @defaultValue Computed worker weights automatically given the CPU performance.
+   */
+  weights?: Record<number, number>
 }
 
 /**
- * Worker choice strategy interface.
+ * Pool worker tasks usage statistics requirements.
  *
- * @typeParam Worker - Type of worker which manages the strategy.
+ * @internal
  */
-export interface IWorkerChoiceStrategy<Worker extends IPoolWorker> {
+export interface RequiredStatistics {
+  /**
+   * Require tasks runtime.
+   */
+  runTime: boolean
+  /**
+   * Require tasks average runtime.
+   */
+  avgRunTime: boolean
   /**
-   * Is the pool attached to the strategy dynamic?.
+   * Require tasks median runtime.
    */
-  readonly isDynamicPool: boolean
+  medRunTime: boolean
   /**
-   * Required pool tasks usage statistics.
+   * Require tasks wait time.
+   */
+  waitTime: boolean
+  /**
+   * Require tasks average wait time.
+   */
+  avgWaitTime: boolean
+  /**
+   * Require tasks median wait time.
+   */
+  medWaitTime: boolean
+}
+
+/**
+ * Worker choice strategy interface.
+ */
+export interface IWorkerChoiceStrategy {
+  /**
+   * Required tasks usage statistics.
    */
   readonly requiredStatistics: RequiredStatistics
   /**
-   * Resets strategy internals (counters, statistics, etc.).
+   * Resets strategy internals.
+   *
+   * @returns `true` if the reset is successful, `false` otherwise.
    */
   reset: () => boolean
   /**
-   * Chooses a worker in the pool.
+   * Updates the worker node key strategy internals.
+   *
+   * @returns `true` if the update is successful, `false` otherwise.
+   */
+  update: (workerNodeKey: number) => boolean
+  /**
+   * Chooses a worker node in the pool and returns its key.
+   *
+   * @returns The worker node key.
+   */
+  choose: () => number
+  /**
+   * Removes the worker node key from strategy internals.
+   *
+   * @param workerNodeKey - The worker node key.
+   * @returns `true` if the worker node key is removed, `false` otherwise.
+   */
+  remove: (workerNodeKey: number) => boolean
+  /**
+   * Sets the worker choice strategy options.
+   *
+   * @param opts - The worker choice strategy options.
    */
-  choose: () => Worker
+  setOptions: (opts: WorkerChoiceStrategyOptions) => void
 }