X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fselection-strategies%2Fselection-strategies-types.ts;h=f499da7fc9d58458f9977910a18cc9246870ba7b;hb=76ae94ffbe0d293daee778f0e885866242059450;hp=5f2edb25b010f9961fcf870c6e661d98abaf0663;hpb=313f98acb018dfdff5f2846d8e1f0e987af16956;p=poolifier.git diff --git a/src/pools/selection-strategies/selection-strategies-types.ts b/src/pools/selection-strategies/selection-strategies-types.ts index 5f2edb25..f499da7f 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. */ @@ -97,11 +91,11 @@ export interface WorkerChoiceStrategyOptions { readonly elu?: MeasurementOptions /** * Worker weights to use for weighted round robin worker selection strategies. - * A weight is the tasks maximum execution in milliseconds for each worker node. + * A weight is tasks maximum execution time in milliseconds for a worker node. * * @defaultValue Weights computed automatically given the CPU performance. */ - readonly weights?: Record + weights?: Record } /** @@ -182,13 +176,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`. */ @@ -205,5 +201,5 @@ export interface IWorkerChoiceStrategy { * * @param opts - The worker choice strategy options. */ - readonly setOptions: (opts: WorkerChoiceStrategyOptions) => void + readonly setOptions: (opts: WorkerChoiceStrategyOptions | undefined) => void }