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=114ae8c555141fd08bff0103fcf79d62a65b5f83;hpb=a4958de2101f06e7096b83adbca82fcfd532a721;p=poolifier.git diff --git a/src/pools/selection-strategies/selection-strategies-types.ts b/src/pools/selection-strategies/selection-strategies-types.ts index 114ae8c5..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,16 +41,38 @@ 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 false + * @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. @@ -49,23 +83,43 @@ export interface WorkerChoiceStrategyOptions { } /** - * Pool worker tasks usage statistics requirements. + * Measurement statistics requirements. + * + * @internal + */ +interface MeasurementStatisticsRequirements { + /** + * Require measurement aggregate. + */ + aggregate: boolean + /** + * Require measurement average. + */ + average: boolean + /** + * Require measurement median. + */ + median: boolean +} + +/** + * Pool worker node worker usage statistics requirements. * * @internal */ -export interface RequiredStatistics { +export interface TaskStatisticsRequirements { /** - * Require tasks run time. + * Tasks runtime requirements. */ - runTime: boolean + runTime: MeasurementStatisticsRequirements /** - * Require tasks average run time. + * Tasks wait time requirements. */ - avgRunTime: boolean + waitTime: MeasurementStatisticsRequirements /** - * Require tasks median run time. + * Tasks event loop utilization requirements. */ - medRunTime: boolean + elu: MeasurementStatisticsRequirements } /** @@ -73,9 +127,9 @@ export interface RequiredStatistics { */ export interface IWorkerChoiceStrategy { /** - * Required tasks usage statistics. + * Tasks statistics requirements. */ - readonly requiredStatistics: RequiredStatistics + readonly taskStatisticsRequirements: TaskStatisticsRequirements /** * Resets strategy internals. * @@ -83,7 +137,7 @@ export interface IWorkerChoiceStrategy { */ reset: () => boolean /** - * Updates worker node strategy internals. + * Updates the worker node key strategy internals. * * @returns `true` if the update is successful, `false` otherwise. */ @@ -95,7 +149,7 @@ export interface IWorkerChoiceStrategy { */ 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.