X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fselection-strategies%2Fselection-strategies-types.ts;h=b96bb029a0befe39ce438beb368e2c0dbecb87ab;hb=4f487526a63c873d168386250b40ad8103c5a4d8;hp=0e549cec338b685d36e80ab1ff3d147ef6a3f83f;hpb=08f3f44cef6256fdbab1a2a56842b291fd6dcd42;p=poolifier.git diff --git a/src/pools/selection-strategies/selection-strategies-types.ts b/src/pools/selection-strategies/selection-strategies-types.ts index 0e549cec..b96bb029 100644 --- a/src/pools/selection-strategies/selection-strategies-types.ts +++ b/src/pools/selection-strategies/selection-strategies-types.ts @@ -7,13 +7,19 @@ 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', + /** + * Least ELU worker selection strategy. + * + * @experimental + */ + LEAST_ELU: 'LEAST_ELU', /** * Fair share worker selection strategy. */ @@ -21,7 +27,13 @@ export const WorkerChoiceStrategies = Object.freeze({ /** * Weighted round robin worker selection strategy. */ - WEIGHTED_ROUND_ROBIN: 'WEIGHTED_ROUND_ROBIN' + WEIGHTED_ROUND_ROBIN: 'WEIGHTED_ROUND_ROBIN', + /** + * Interleaved weighted round robin worker selection strategy. + * + * @experimental + */ + INTERLEAVED_WEIGHTED_ROUND_ROBIN: 'INTERLEAVED_WEIGHTED_ROUND_ROBIN' } as const) /** @@ -34,11 +46,17 @@ 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. @@ -53,19 +71,35 @@ export interface WorkerChoiceStrategyOptions { * * @internal */ -export interface RequiredStatistics { +export interface TaskStatistics { /** - * 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 + /** + * Event loop utilization. + */ + elu: boolean } /** @@ -73,21 +107,32 @@ export interface RequiredStatistics { */ export interface IWorkerChoiceStrategy { /** - * Required tasks usage statistics. + * Required tasks statistics. */ - readonly requiredStatistics: RequiredStatistics + readonly taskStatistics: TaskStatistics /** - * 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 /**