X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fselection-strategies%2Fselection-strategies-types.ts;h=0fbb4d4d43165737d3bd3c0c7378b2c55d7e03d2;hb=4eb9e75a6d47a08541d38b70505e5ba1126aa2f1;hp=b96bb029a0befe39ce438beb368e2c0dbecb87ab;hpb=06161b78c9818840be1a8287694b25e3797ecadf;p=poolifier.git diff --git a/src/pools/selection-strategies/selection-strategies-types.ts b/src/pools/selection-strategies/selection-strategies-types.ts index b96bb029..0fbb4d4d 100644 --- a/src/pools/selection-strategies/selection-strategies-types.ts +++ b/src/pools/selection-strategies/selection-strategies-types.ts @@ -41,22 +41,32 @@ 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 runtime instead of average runtime. + * Runtime options. * - * @defaultValue false + * @defaultValue \{ median: false \} */ - medRunTime?: boolean + runTime?: MeasurementOptions /** - * Use tasks median wait time instead of average runtime. + * Wait time options. * - * @defaultValue false + * @defaultValue \{ median: false \} */ - medWaitTime?: boolean + waitTime?: MeasurementOptions /** * Worker weights to use for weighted round robin worker selection strategy. * Weight is the tasks maximum average or median runtime in milliseconds. @@ -67,35 +77,39 @@ export interface WorkerChoiceStrategyOptions { } /** - * Pool worker tasks usage statistics requirements. + * Measurement statistics requirements. * * @internal */ -export interface TaskStatistics { - /** - * Require tasks runtime. - */ - runTime: boolean +interface MeasurementStatisticsRequirements { /** - * Require tasks average runtime. + * Require measurement aggregate. */ - avgRunTime: boolean + aggregate: boolean /** - * Require tasks median runtime. + * Require measurement average. */ - medRunTime: boolean + average: boolean /** - * Require tasks wait time. + * Require measurement median. */ - waitTime: boolean + median: boolean +} + +/** + * Pool worker node worker usage statistics requirements. + * + * @internal + */ +export interface TaskStatisticsRequirements { /** - * Require tasks average wait time. + * Tasks runtime requirements. */ - avgWaitTime: boolean + runTime: MeasurementStatisticsRequirements /** - * Require tasks median wait time. + * Tasks wait time requirements. */ - medWaitTime: boolean + waitTime: MeasurementStatisticsRequirements /** * Event loop utilization. */ @@ -107,9 +121,9 @@ export interface TaskStatistics { */ export interface IWorkerChoiceStrategy { /** - * Required tasks statistics. + * Tasks statistics requirements. */ - readonly taskStatistics: TaskStatistics + readonly taskStatisticsRequirements: TaskStatisticsRequirements /** * Resets strategy internals. *