X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fselection-strategies%2Fselection-strategies-types.ts;h=ac2ee6c3ca6b97f96c0e16a8ccf04e9557246090;hb=3c93feb918b47943d801029fad82a61469e40127;hp=94e2d3e6d3a8df349cf8aea49bb725dbdeaae4d4;hpb=0567595a23237d7b0e4bc0ec70c8e313eb71bb10;p=poolifier.git diff --git a/src/pools/selection-strategies/selection-strategies-types.ts b/src/pools/selection-strategies/selection-strategies-types.ts index 94e2d3e6..ac2ee6c3 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,22 +41,56 @@ export const WorkerChoiceStrategies = Object.freeze({ */ export type WorkerChoiceStrategy = keyof typeof WorkerChoiceStrategies +/** + * Enumeration of measurements. + */ +export const Measurements = Object.freeze({ + runTime: 'runTime', + waitTime: 'waitTime', + elu: 'elu' +} as const) + +/** + * Measurement. + */ +export type Measurement = keyof typeof Measurements + +/** + * Measurement options. + */ +export interface MeasurementOptions { + /** + * Set measurement median. + */ + median: boolean +} + /** * Worker choice strategy options. */ export interface WorkerChoiceStrategyOptions { /** - * Use tasks median run time instead of average run time. + * Measurement to use for worker choice strategy. + */ + measurement?: Measurement + /** + * Runtime options. * - * @defaultValue false + * @defaultValue \{ median: false \} */ - medRunTime?: boolean + runTime?: MeasurementOptions /** - * Use tasks median wait time instead of average run time. + * Wait time options. * - * @defaultValue false + * @defaultValue \{ median: false \} */ - medWaitTime?: 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. @@ -55,35 +101,55 @@ export interface WorkerChoiceStrategyOptions { } /** - * Pool worker tasks usage statistics requirements. + * Measurement statistics requirements. * * @internal */ -export interface RequiredStatistics { +export interface MeasurementStatisticsRequirements { + /** + * Require measurement aggregate. + */ + aggregate: boolean /** - * Require tasks run time. + * Require measurement average. */ - runTime: boolean + average: boolean /** - * Require tasks average run time. + * Require measurement median. */ - avgRunTime: boolean + median: boolean +} + +/** + * Pool worker node worker usage statistics requirements. + * + * @internal + */ +export interface TaskStatisticsRequirements { /** - * Require tasks median run time. + * Tasks runtime requirements. */ - medRunTime: boolean + runTime: MeasurementStatisticsRequirements /** - * Require tasks wait time. + * Tasks wait time requirements. */ - waitTime: boolean + waitTime: MeasurementStatisticsRequirements /** - * Require tasks average wait time. + * Tasks event loop utilization requirements. */ - avgWaitTime: boolean + elu: MeasurementStatisticsRequirements +} + +/** + * Strategy policy. + * + * @internal + */ +export interface StrategyPolicy { /** - * Require tasks median wait time. + * Expects direct usage of dynamic worker. */ - medWaitTime: boolean + useDynamicWorker: boolean } /** @@ -91,9 +157,13 @@ export interface RequiredStatistics { */ export interface IWorkerChoiceStrategy { /** - * Required tasks usage statistics. + * Strategy policy. + */ + readonly strategyPolicy: StrategyPolicy + /** + * Tasks statistics requirements. */ - readonly requiredStatistics: RequiredStatistics + readonly taskStatisticsRequirements: TaskStatisticsRequirements /** * Resets strategy internals. *