X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fselection-strategies%2Fselection-strategies-types.ts;h=b96bb029a0befe39ce438beb368e2c0dbecb87ab;hb=4f487526a63c873d168386250b40ad8103c5a4d8;hp=2c6c2e16d6e4d52e7f19841e6d6f331db3d678f9;hpb=8b4d450024ef06de939fa82f9746b005696914c0;p=poolifier.git

diff --git a/src/pools/selection-strategies/selection-strategies-types.ts b/src/pools/selection-strategies/selection-strategies-types.ts
index 2c6c2e16..b96bb029 100644
--- a/src/pools/selection-strategies/selection-strategies-types.ts
+++ b/src/pools/selection-strategies/selection-strategies-types.ts
@@ -7,13 +7,19 @@ 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',
+  /**
+   * Least ELU worker selection strategy.
+   *
+   * @experimental
+   */
+  LEAST_ELU: 'LEAST_ELU',
   /**
    * Fair share worker selection strategy.
    */
@@ -21,7 +27,13 @@ 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.
+   *
+   * @experimental
+   */
+  INTERLEAVED_WEIGHTED_ROUND_ROBIN: 'INTERLEAVED_WEIGHTED_ROUND_ROBIN'
 } as const)
 
 /**
@@ -29,12 +41,65 @@ export const WorkerChoiceStrategies = Object.freeze({
  */
 export type WorkerChoiceStrategy = keyof typeof WorkerChoiceStrategies
 
+/**
+ * Worker choice strategy options.
+ */
+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>
+}
+
 /**
  * Pool worker tasks usage statistics requirements.
+ *
+ * @internal
  */
-export interface RequiredStatistics {
+export interface TaskStatistics {
+  /**
+   * Require tasks runtime.
+   */
   runTime: boolean
+  /**
+   * Require tasks average runtime.
+   */
   avgRunTime: boolean
+  /**
+   * Require tasks median runtime.
+   */
+  medRunTime: boolean
+  /**
+   * Require tasks wait time.
+   */
+  waitTime: boolean
+  /**
+   * Require tasks average wait time.
+   */
+  avgWaitTime: boolean
+  /**
+   * Require tasks median wait time.
+   */
+  medWaitTime: boolean
+  /**
+   * Event loop utilization.
+   */
+  elu: boolean
 }
 
 /**
@@ -42,21 +107,38 @@ export interface RequiredStatistics {
  */
 export interface IWorkerChoiceStrategy {
   /**
-   * Required pool tasks usage statistics.
+   * Required tasks statistics.
    */
-  readonly requiredStatistics: RequiredStatistics
+  readonly taskStatistics: TaskStatistics
   /**
-   * 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
 }