X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fselection-strategies%2Fselection-strategies-types.ts;h=563b04b00086a7a31a68f7cb25ca4bde6b513c92;hb=43b84974f72aecd75b4b592e0009359bd5baf228;hp=0fbb4d4d43165737d3bd3c0c7378b2c55d7e03d2;hpb=4a59691c9f48b3a6602510aeece809e2a0fe14c1;p=poolifier.git diff --git a/src/pools/selection-strategies/selection-strategies-types.ts b/src/pools/selection-strategies/selection-strategies-types.ts index 0fbb4d4d..563b04b0 100644 --- a/src/pools/selection-strategies/selection-strategies-types.ts +++ b/src/pools/selection-strategies/selection-strategies-types.ts @@ -41,39 +41,63 @@ 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. */ -interface MeasurementOptions { +export interface MeasurementOptions { /** * Set measurement median. */ - median: boolean + readonly median: boolean } /** * Worker choice strategy options. */ export interface WorkerChoiceStrategyOptions { + /** + * Measurement to use for worker choice strategy. + */ + readonly measurement?: Measurement /** * Runtime options. * * @defaultValue \{ median: false \} */ - runTime?: MeasurementOptions + readonly runTime?: MeasurementOptions /** * Wait time options. * * @defaultValue \{ median: false \} */ - waitTime?: MeasurementOptions + readonly waitTime?: MeasurementOptions + /** + * Event loop utilization options. + * + * @defaultValue \{ median: false \} + */ + readonly 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 + readonly weights?: Record } /** @@ -81,17 +105,17 @@ export interface WorkerChoiceStrategyOptions { * * @internal */ -interface MeasurementStatisticsRequirements { +export interface MeasurementStatisticsRequirements { /** - * Require measurement aggregate. + * Requires measurement aggregate. */ aggregate: boolean /** - * Require measurement average. + * Requires measurement average. */ average: boolean /** - * Require measurement median. + * Requires measurement median. */ median: boolean } @@ -105,21 +129,39 @@ export interface TaskStatisticsRequirements { /** * Tasks runtime requirements. */ - runTime: MeasurementStatisticsRequirements + readonly runTime: MeasurementStatisticsRequirements /** * Tasks wait time requirements. */ - waitTime: MeasurementStatisticsRequirements + readonly waitTime: MeasurementStatisticsRequirements /** - * Event loop utilization. + * Tasks event loop utilization requirements. */ - elu: boolean + readonly elu: MeasurementStatisticsRequirements +} + +/** + * Strategy policy. + * + * @internal + */ +export interface StrategyPolicy { + /** + * Expects direct usage of the newly created dynamic worker. + */ + readonly useDynamicWorker: boolean } /** * Worker choice strategy interface. + * + * @internal */ export interface IWorkerChoiceStrategy { + /** + * Strategy policy. + */ + readonly strategyPolicy: StrategyPolicy /** * Tasks statistics requirements. */ @@ -129,30 +171,30 @@ export interface IWorkerChoiceStrategy { * * @returns `true` if the reset is successful, `false` otherwise. */ - reset: () => boolean + readonly reset: () => boolean /** * Updates the worker node key strategy internals. * * @returns `true` if the update is successful, `false` otherwise. */ - update: (workerNodeKey: number) => boolean + readonly update: (workerNodeKey: number) => boolean /** * Chooses a worker node in the pool and returns its key. * * @returns The worker node key. */ - choose: () => number + readonly choose: () => number /** * 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 + readonly remove: (workerNodeKey: number) => boolean /** * Sets the worker choice strategy options. * * @param opts - The worker choice strategy options. */ - setOptions: (opts: WorkerChoiceStrategyOptions) => void + readonly setOptions: (opts: WorkerChoiceStrategyOptions) => void }