X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fselection-strategies%2Fselection-strategies-types.ts;h=ddfe915d2e3c215f9365693c81754155c2c10bc5;hb=9e775f96c71628a400c029d69d28150defe4186c;hp=4fb2f3584aadffcc0f5224fdfb8ce6521a2979a8;hpb=3300e7bcb155358c2cc1eed6e4ac11581457616f;p=poolifier.git diff --git a/src/pools/selection-strategies/selection-strategies-types.ts b/src/pools/selection-strategies/selection-strategies-types.ts index 4fb2f358..ddfe915d 100644 --- a/src/pools/selection-strategies/selection-strategies-types.ts +++ b/src/pools/selection-strategies/selection-strategies-types.ts @@ -1,6 +1,3 @@ -import type { IPoolInternal } from '../pool-internal' -import type { IPoolWorker } from '../pool-worker' - /** * Enumeration of worker choice strategies. */ @@ -32,49 +29,82 @@ export const WorkerChoiceStrategies = Object.freeze({ */ export type WorkerChoiceStrategy = keyof typeof WorkerChoiceStrategies +/** + * Worker choice strategy options. + */ +export interface WorkerChoiceStrategyOptions { + /** + * Use tasks median runtime instead of average runtime. + * + * @defaultValue false + */ + medRunTime?: boolean + /** + * 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. + * + * @internal */ export interface RequiredStatistics { + /** + * Require tasks runtime. + */ runTime: boolean + /** + * Require tasks average runtime. + */ avgRunTime: boolean + /** + * Require tasks median runtime. + */ + medRunTime: boolean } /** * Worker choice strategy interface. */ -export interface IWorkerChoiceStrategy< - Worker extends IPoolWorker, - Data = unknown, - Response = unknown -> { +export interface IWorkerChoiceStrategy { /** - * The pool instance. - * @readonly + * Required tasks usage statistics. */ - readonly pool: IPoolInternal + readonly requiredStatistics: RequiredStatistics /** - * Is the pool attached to the strategy dynamic?. - * @readonly + * Resets strategy internals. + * + * @returns `true` if the reset is successful, `false` otherwise. */ - readonly isDynamicPool: boolean + reset: () => boolean /** - * Required pool tasks usage statistics. - * @readonly + * Updates the worker node key strategy internals. + * + * @returns `true` if the update is successful, `false` otherwise. */ - readonly requiredStatistics: RequiredStatistics + update: (workerNodeKey: number) => boolean /** - * Resets strategy internals (counters, statistics, etc.). + * Chooses a worker node in the pool and returns its key. + * + * @returns The worker node key. */ - reset: () => boolean + choose: () => number /** - * Chooses a worker in the pool and returns its key. + * 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. */ - choose: () => number + remove: (workerNodeKey: number) => boolean /** - * Removes a worker reference from strategy internals. + * Sets the worker choice strategy options. * - * @param workerKey - The worker key. + * @param opts - The worker choice strategy options. */ - remove: (workerKey: number) => boolean + setOptions: (opts: WorkerChoiceStrategyOptions) => void }