X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fselection-strategies%2Fselection-strategies-types.ts;h=f2b401d6faf5bfe879225a71ab635fe4e2c625dc;hb=297f3bbe14ff67d6e7bf27bd9dd4088170151ce5;hp=7fbe40f28fa3b5d9cc1b8e976a3f46ec45ed9974;hpb=243a550a93e278669fe5602aeba92dc8ba11260e;p=poolifier.git

diff --git a/src/pools/selection-strategies/selection-strategies-types.ts b/src/pools/selection-strategies/selection-strategies-types.ts
index 7fbe40f2..f2b401d6 100644
--- a/src/pools/selection-strategies/selection-strategies-types.ts
+++ b/src/pools/selection-strategies/selection-strategies-types.ts
@@ -21,7 +21,11 @@ export const WorkerChoiceStrategies = Object.freeze({
   /**
    * Weighted round robin worker selection strategy.
    */
-  WEIGHTED_ROUND_ROBIN: 'WEIGHTED_ROUND_ROBIN'
+  WEIGHTED_ROUND_ROBIN: 'WEIGHTED_ROUND_ROBIN',
+  /**
+   * Interleaved weighted round robin worker selection strategy.
+   */
+  INTERLEAVED_WEIGHTED_ROUND_ROBIN: 'INTERLEAVED_WEIGHTED_ROUND_ROBIN'
 } as const)
 
 /**
@@ -35,12 +39,23 @@ export type WorkerChoiceStrategy = keyof typeof WorkerChoiceStrategies
 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 {
   /**
@@ -66,17 +81,34 @@ export interface IWorkerChoiceStrategy {
    */
   readonly requiredStatistics: RequiredStatistics
   /**
-   * Resets strategy internals (counters, statistics, etc.).
+   * Resets strategy internals.
+   *
+   * @returns `true` if the reset is successful, `false` otherwise.
    */
   reset: () => boolean
+  /**
+   * 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 node key 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 opts - The worker choice strategy options.
+   */
+  setOptions: (opts: WorkerChoiceStrategyOptions) => void
 }