X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fselection-strategies%2Fselection-strategies-types.ts;h=59b6a84f90e29dbd05a08dec2020428b7e2fe436;hb=c004ececb19646937d2bf9e6431f51fd4108b782;hp=e7bf0e1e9ba94503d8dc302a84d3c5e058486d6e;hpb=98446b391031d7add0e0d7f7e310e25a014370e2;p=poolifier.git diff --git a/src/pools/selection-strategies/selection-strategies-types.ts b/src/pools/selection-strategies/selection-strategies-types.ts index e7bf0e1e..59b6a84f 100644 --- a/src/pools/selection-strategies/selection-strategies-types.ts +++ b/src/pools/selection-strategies/selection-strategies-types.ts @@ -67,12 +67,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. */ @@ -104,6 +98,21 @@ export interface WorkerChoiceStrategyOptions { readonly weights?: Record } +/** + * Worker choice strategy internal options. + * + * @internal + */ +export interface InternalWorkerChoiceStrategyOptions + extends WorkerChoiceStrategyOptions { + /** + * Number of worker choice retries to perform if no worker is eligible. + * + * @defaultValue pool maximum size + */ + readonly retries?: number +} + /** * Measurement statistics requirements. * @@ -182,13 +191,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`. */ @@ -206,4 +217,10 @@ export interface IWorkerChoiceStrategy { * @param opts - The worker choice strategy options. */ readonly setOptions: (opts: WorkerChoiceStrategyOptions) => void + /** + * Whether the pool has worker nodes ready or not. + * + * @returns Whether the pool has worker nodes ready or not. + */ + readonly hasPoolWorkerNodesReady: () => boolean }