X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fselection-strategies%2Fselection-strategies-types.ts;h=1a8ea298198d842bd8cd622f74abb6a30f7b28fc;hb=e334515bf28581c234d6b9f5239425c9a0c6a7ec;hp=4377624e97a1d316dba60687870ac6308d44b158;hpb=936fa0fb8e70b2c297938cc9455444486b6daa3e;p=poolifier.git

diff --git a/src/pools/selection-strategies/selection-strategies-types.ts b/src/pools/selection-strategies/selection-strategies-types.ts
index 4377624e..1a8ea298 100644
--- a/src/pools/selection-strategies/selection-strategies-types.ts
+++ b/src/pools/selection-strategies/selection-strategies-types.ts
@@ -1,7 +1,15 @@
 /**
  * Enumeration of worker choice strategies.
  */
-export const WorkerChoiceStrategies = Object.freeze({
+export const WorkerChoiceStrategies: Readonly<{
+  ROUND_ROBIN: 'ROUND_ROBIN'
+  LEAST_USED: 'LEAST_USED'
+  LEAST_BUSY: 'LEAST_BUSY'
+  LEAST_ELU: 'LEAST_ELU'
+  FAIR_SHARE: 'FAIR_SHARE'
+  WEIGHTED_ROUND_ROBIN: 'WEIGHTED_ROUND_ROBIN'
+  INTERLEAVED_WEIGHTED_ROUND_ROBIN: 'INTERLEAVED_WEIGHTED_ROUND_ROBIN'
+}> = Object.freeze({
   /**
    * Round robin worker selection strategy.
    */
@@ -16,8 +24,6 @@ export const WorkerChoiceStrategies = Object.freeze({
   LEAST_BUSY: 'LEAST_BUSY',
   /**
    * Least ELU worker selection strategy.
-   *
-   * @experimental
    */
   LEAST_ELU: 'LEAST_ELU',
   /**
@@ -44,7 +50,11 @@ export type WorkerChoiceStrategy = keyof typeof WorkerChoiceStrategies
 /**
  * Enumeration of measurements.
  */
-export const Measurements = Object.freeze({
+export const Measurements: Readonly<{
+  runTime: 'runTime'
+  waitTime: 'waitTime'
+  elu: 'elu'
+}> = Object.freeze({
   runTime: 'runTime',
   waitTime: 'waitTime',
   elu: 'elu'
@@ -69,12 +79,6 @@ export interface MeasurementOptions {
  * Worker choice strategy options.
  */
 export interface WorkerChoiceStrategyOptions {
-  /**
-   * Number of worker choice retries to perform if no worker is eligible.
-   *
-   * @defaultValue 6
-   */
-  readonly choiceRetries?: number
   /**
    * Measurement to use in worker choice strategy supporting it.
    */
@@ -98,12 +102,12 @@ export interface WorkerChoiceStrategyOptions {
    */
   readonly elu?: MeasurementOptions
   /**
-   * Worker weights to use for weighted round robin worker selection strategy.
-   * Weight is the tasks maximum average or median runtime in milliseconds.
+   * Worker weights to use for weighted round robin worker selection strategies.
+   * A weight is tasks maximum execution time in milliseconds for a worker node.
    *
-   * @defaultValue Computed worker weights automatically given the CPU performance.
+   * @defaultValue Weights computed automatically given the CPU performance.
    */
-  readonly weights?: Record<number, number>
+  weights?: Record<number, number>
 }
 
 /**
@@ -184,13 +188,15 @@ export interface IWorkerChoiceStrategy {
   readonly reset: () => boolean
   /**
    * Updates the worker node key strategy internals.
+   * This is called after a task has been executed on a worker node.
    *
    * @returns `true` if the update is successful, `false` otherwise.
    */
   readonly update: (workerNodeKey: number) => boolean
   /**
    * Chooses a worker node in the pool and returns its key.
-   * If the worker node is not eligible, `undefined` is returned.
+   * If no worker nodes are not eligible, `undefined` is returned.
+   * If `undefined` is returned, the caller retry.
    *
    * @returns The worker node key or `undefined`.
    */
@@ -207,5 +213,5 @@ export interface IWorkerChoiceStrategy {
    *
    * @param opts - The worker choice strategy options.
    */
-  readonly setOptions: (opts: WorkerChoiceStrategyOptions) => void
+  readonly setOptions: (opts: WorkerChoiceStrategyOptions | undefined) => void
 }