X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fselection-strategies%2Fselection-strategies-types.ts;h=c90036fe6f269dd7757482064a3fdba0b7a97e97;hb=78ebe9d5933520d55ba8d025bb124e8beca01a4c;hp=f9a504351a4bbbe9d33bddc145c457a7ce27ef78;hpb=a20f0ba5aa9c6946254aa197286ad9b70b6a0319;p=poolifier.git diff --git a/src/pools/selection-strategies/selection-strategies-types.ts b/src/pools/selection-strategies/selection-strategies-types.ts index f9a50435..c90036fe 100644 --- a/src/pools/selection-strategies/selection-strategies-types.ts +++ b/src/pools/selection-strategies/selection-strategies-types.ts @@ -7,13 +7,13 @@ export const WorkerChoiceStrategies = Object.freeze({ */ ROUND_ROBIN: 'ROUND_ROBIN', /** - * Less used worker selection strategy. + * Least used worker selection strategy. */ - LESS_USED: 'LESS_USED', + LEAST_USED: 'LEAST_USED', /** - * Less busy worker selection strategy. + * Least busy worker selection strategy. */ - LESS_BUSY: 'LESS_BUSY', + LEAST_BUSY: 'LEAST_BUSY', /** * Fair share worker selection strategy. */ @@ -34,9 +34,24 @@ export type WorkerChoiceStrategy = keyof typeof WorkerChoiceStrategies */ export interface WorkerChoiceStrategyOptions { /** - * Use tasks median run time instead of average run time. + * Use tasks median runtime instead of average runtime. + * + * @defaultValue false */ medRunTime?: boolean + /** + * Use tasks median wait time instead of average runtime. + * + * @defaultValue false + */ + medWaitTime?: 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 } /** @@ -46,17 +61,29 @@ export interface WorkerChoiceStrategyOptions { */ export interface RequiredStatistics { /** - * Require tasks run time. + * Require tasks runtime. */ runTime: boolean /** - * Require tasks average run time. + * Require tasks average runtime. */ avgRunTime: boolean /** - * Require tasks median run time. + * Require tasks median runtime. */ medRunTime: boolean + /** + * Require tasks wait time. + */ + waitTime: boolean + /** + * Require tasks average wait time. + */ + avgWaitTime: boolean + /** + * Require tasks median wait time. + */ + medWaitTime: boolean } /** @@ -68,17 +95,28 @@ export interface IWorkerChoiceStrategy { */ readonly requiredStatistics: RequiredStatistics /** - * Resets strategy internals (counters, statistics, etc.). + * Resets strategy internals. + * + * @returns `true` if the reset is successful, `false` otherwise. */ reset: () => boolean + /** + * Updates the worker node key strategy internals. + * + * @returns `true` if the update is successful, `false` otherwise. + */ + update: (workerNodeKey: number) => boolean /** * Chooses a worker node in the pool and returns its key. + * + * @returns The worker node key. */ choose: () => number /** - * Removes a worker node key from strategy internals. + * 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 /**