X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fselection-strategies%2Fselection-strategies-types.ts;h=c578ddc3f9fb24e289f5caf8fa542ec402d63834;hb=5df69fabd77b3ec4137a6382e2d84791bf0fe85d;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..c578ddc3 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) /** @@ -29,34 +41,85 @@ export const WorkerChoiceStrategies = Object.freeze({ */ export type WorkerChoiceStrategy = keyof typeof WorkerChoiceStrategies +/** + * Measurement options. + */ +interface MeasurementOptions { + /** + * Set measurement median. + */ + median: boolean +} + /** * Worker choice strategy options. */ export interface WorkerChoiceStrategyOptions { /** - * Use tasks median run time instead of average run time. + * Runtime options. + * + * @defaultValue \{ median: false \} + */ + runTime?: MeasurementOptions + /** + * Wait time options. + * + * @defaultValue \{ median: false \} */ - medRunTime?: boolean + waitTime?: MeasurementOptions + /** + * Event loop utilization options. + * + * @defaultValue \{ median: false \} + */ + elu?: MeasurementOptions + /** + * 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. + * Measurement statistics requirements. * * @internal */ -export interface RequiredStatistics { +interface MeasurementStatisticsRequirements { /** - * Require tasks run time. + * Require measurement aggregate. */ - runTime: boolean + aggregate: boolean /** - * Require tasks average run time. + * Require measurement average. */ - avgRunTime: boolean + average: boolean /** - * Require tasks median run time. + * Require measurement median. */ - medRunTime: boolean + median: boolean +} + +/** + * Pool worker node worker usage statistics requirements. + * + * @internal + */ +export interface TaskStatisticsRequirements { + /** + * Tasks runtime requirements. + */ + runTime: MeasurementStatisticsRequirements + /** + * Tasks wait time requirements. + */ + waitTime: MeasurementStatisticsRequirements + /** + * Tasks event loop utilization requirements. + */ + elu: MeasurementStatisticsRequirements } /** @@ -64,21 +127,32 @@ export interface RequiredStatistics { */ export interface IWorkerChoiceStrategy { /** - * Required tasks usage statistics. + * Tasks statistics requirements. */ - readonly requiredStatistics: RequiredStatistics + readonly taskStatisticsRequirements: TaskStatisticsRequirements /** - * 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 /**