X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fselection-strategies%2Fselection-strategies-types.ts;h=b476592ac59e17c3c6c3b64cc4481fcca6bb79cb;hb=64f97d12e2027203715ee0129d036e1d2b42e2a2;hp=9f68c22f892c50a3e424b59a3cb0cffe9f61557f;hpb=6d1d4d956de1d48e51517014bc0b4c276bbf876a;p=poolifier.git

diff --git a/src/pools/selection-strategies/selection-strategies-types.ts b/src/pools/selection-strategies/selection-strategies-types.ts
index 9f68c22f..b476592a 100644
--- a/src/pools/selection-strategies/selection-strategies-types.ts
+++ b/src/pools/selection-strategies/selection-strategies-types.ts
@@ -16,8 +16,6 @@ export const WorkerChoiceStrategies = Object.freeze({
   LEAST_BUSY: 'LEAST_BUSY',
   /**
    * Least ELU worker selection strategy.
-   *
-   * @experimental
    */
   LEAST_ELU: 'LEAST_ELU',
   /**
@@ -70,7 +68,13 @@ export interface MeasurementOptions {
  */
 export interface WorkerChoiceStrategyOptions {
   /**
-   * Measurement to use for worker choice strategy.
+   * Number of worker choice retries to perform if no worker is eligible.
+   *
+   * @defaultValue 6
+   */
+  readonly retries?: number
+  /**
+   * Measurement to use in worker choice strategy supporting it.
    */
   readonly measurement?: Measurement
   /**
@@ -92,10 +96,10 @@ 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>
 }
@@ -147,13 +151,19 @@ export interface TaskStatisticsRequirements {
  */
 export interface StrategyPolicy {
   /**
-   * Expects direct usage of dynamic worker.
+   * Expects tasks execution on the newly created dynamic worker.
    */
-  readonly useDynamicWorker: boolean
+  readonly dynamicWorkerUsage: boolean
+  /**
+   * Expects the newly created dynamic worker to be flagged as ready.
+   */
+  readonly dynamicWorkerReady: boolean
 }
 
 /**
  * Worker choice strategy interface.
+ *
+ * @internal
  */
 export interface IWorkerChoiceStrategy {
   /**
@@ -169,30 +179,31 @@ export interface IWorkerChoiceStrategy {
    *
    * @returns `true` if the reset is successful, `false` otherwise.
    */
-  reset: () => boolean
+  readonly reset: () => boolean
   /**
    * Updates the worker node key strategy internals.
    *
    * @returns `true` if the update is successful, `false` otherwise.
    */
-  update: (workerNodeKey: number) => boolean
+  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.
    *
-   * @returns The worker node key.
+   * @returns The worker node key or `undefined`.
    */
-  choose: () => number
+  readonly choose: () => number | undefined
   /**
    * 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
+  readonly remove: (workerNodeKey: number) => boolean
   /**
    * Sets the worker choice strategy options.
    *
    * @param opts - The worker choice strategy options.
    */
-  setOptions: (opts: WorkerChoiceStrategyOptions) => void
+  readonly setOptions: (opts: WorkerChoiceStrategyOptions) => void
 }