X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fselection-strategies%2Fselection-strategies-types.ts;h=b95cf7f3ae22b6338fcf48940415e23337307715;hb=49be33feded000ed776ee589274e154fa519b263;hp=9acf819b8b858900a1d42a5a681d7f001b152edf;hpb=17393ac83cbf0eacf68ea9efb0a577cc30a5c685;p=poolifier.git

diff --git a/src/pools/selection-strategies/selection-strategies-types.ts b/src/pools/selection-strategies/selection-strategies-types.ts
index 9acf819b..b95cf7f3 100644
--- a/src/pools/selection-strategies/selection-strategies-types.ts
+++ b/src/pools/selection-strategies/selection-strategies-types.ts
@@ -29,12 +29,43 @@ export const WorkerChoiceStrategies = Object.freeze({
  */
 export type WorkerChoiceStrategy = keyof typeof WorkerChoiceStrategies
 
+/**
+ * Worker choice strategy options.
+ */
+export interface WorkerChoiceStrategyOptions {
+  /**
+   * Use tasks median run time instead of average run time.
+   *
+   * @defaultValue false
+   */
+  medRunTime?: 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>
+}
+
 /**
  * Pool worker tasks usage statistics requirements.
+ *
+ * @internal
  */
 export interface RequiredStatistics {
+  /**
+   * Require tasks run time.
+   */
   runTime: boolean
+  /**
+   * Require tasks average run time.
+   */
   avgRunTime: boolean
+  /**
+   * Require tasks median run time.
+   */
+  medRunTime: boolean
 }
 
 /**
@@ -42,25 +73,38 @@ export interface RequiredStatistics {
  */
 export interface IWorkerChoiceStrategy {
   /**
-   * Is the pool bound to the strategy dynamic?.
-   */
-  readonly isDynamicPool: boolean
-  /**
-   * Required pool tasks usage statistics.
+   * 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 and returns its key.
+   * 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 a worker reference from strategy internals.
+   * 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 workerKey - The worker key.
+   * @param opts - The worker choice strategy options.
    */
-  remove: (workerKey: number) => boolean
+  setOptions: (opts: WorkerChoiceStrategyOptions) => void
 }