X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fselection-strategies%2Fselection-strategies-types.ts;h=0e549cec338b685d36e80ab1ff3d147ef6a3f83f;hb=08f3f44cef6256fdbab1a2a56842b291fd6dcd42;hp=fb864c5b08ffc31a3cb1336225d31f285b0ce240;hpb=c6bd2650c2690bd84951a2278820adde1b05b41b;p=poolifier.git diff --git a/src/pools/selection-strategies/selection-strategies-types.ts b/src/pools/selection-strategies/selection-strategies-types.ts index fb864c5b..0e549cec 100644 --- a/src/pools/selection-strategies/selection-strategies-types.ts +++ b/src/pools/selection-strategies/selection-strategies-types.ts @@ -30,11 +30,42 @@ export const WorkerChoiceStrategies = Object.freeze({ export type WorkerChoiceStrategy = keyof typeof WorkerChoiceStrategies /** - * Pool tasks usage statistics requirements. + * Worker choice strategy options. + */ +export interface WorkerChoiceStrategyOptions { + /** + * Use tasks median run time instead of average run time. + * + * @defaultValue false + */ + medRunTime?: boolean + /** + * Worker weights to use for weighted round robin worker selection strategy. + * Weight is the tasks maximum average or median runtime in milliseconds. + * + * @defaultValue Computed worker weights automatically given the CPU performance. + */ + weights?: Record +} + +/** + * Pool worker tasks usage statistics requirements. + * + * @internal */ export interface RequiredStatistics { + /** + * Require tasks run time. + */ runTime: boolean + /** + * Require tasks average run time. + */ avgRunTime: boolean + /** + * Require tasks median run time. + */ + medRunTime: boolean } /** @@ -42,11 +73,7 @@ export interface RequiredStatistics { */ export interface IWorkerChoiceStrategy { /** - * Is the pool attached to the strategy dynamic?. - */ - readonly isDynamicPool: boolean - /** - * Required pool tasks usage statistics. + * Required tasks usage statistics. */ readonly requiredStatistics: RequiredStatistics /** @@ -54,13 +81,19 @@ export interface IWorkerChoiceStrategy { */ reset: () => boolean /** - * Chooses a worker in the pool and returns its key. + * Chooses a worker node in the pool and returns its key. */ choose: () => number /** - * Removes a worker reference from strategy internals. + * Removes a worker node key from strategy internals. + * + * @param workerNodeKey - The worker node key. + */ + remove: (workerNodeKey: number) => boolean + /** + * Sets the worker choice strategy options. * - * @param workerKey - The worker key. + * @param opts - The worker choice strategy options. */ - remove: (workerKey: number) => boolean + setOptions: (opts: WorkerChoiceStrategyOptions) => void }