* 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.
*/
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<number, number>
+ weights?: Record<number, number>
}
/**
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`.
*/
*
* @param opts - The worker choice strategy options.
*/
- readonly setOptions: (opts: WorkerChoiceStrategyOptions) => void
+ readonly setOptions: (opts: WorkerChoiceStrategyOptions | undefined) => void
}