feat: add tasks wait time account per worker

[poolifier.git] / src / pools / selection-strategies / selection-strategies-types.ts

diff --git a/src/pools/selection-strategies/selection-strategies-types.ts b/src/pools/selection-strategies/selection-strategies-types.ts
index f5f06a6ef6afece164a4367a3026fc6db679adc3..94e2d3e6d3a8df349cf8aea49bb725dbdeaae4d4 100644 (file)
--- a/src/pools/selection-strategies/selection-strategies-types.ts
+++ b/src/pools/selection-strategies/selection-strategies-types.ts
@@ -29,13 +29,61 @@ 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
+  /**
+   * Use tasks median wait time instead of average run time.
+   *
+   * @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>
+}
+
 /**
  * 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
+  /**
+   * Require tasks wait time.
+   */
+  waitTime: boolean
+  /**
+   * Require tasks average wait time.
+   */
+  avgWaitTime: boolean
+  /**
+   * Require tasks median wait time.
+   */
+  medWaitTime: boolean
 }
 
 /**
@@ -47,17 +95,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
 }