-import type { AbstractPoolWorker } from '../abstract-pool-worker'
-
/**
* Enumeration of worker choice strategies.
*/
*/
ROUND_ROBIN: 'ROUND_ROBIN',
/**
- * Less recently used worker selection strategy.
+ * Less used worker selection strategy.
+ */
+ LESS_USED: 'LESS_USED',
+ /**
+ * Less busy worker selection strategy.
*/
- LESS_RECENTLY_USED: 'LESS_RECENTLY_USED',
+ LESS_BUSY: 'LESS_BUSY',
/**
* Fair share worker selection strategy.
*/
/**
* 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)
/**
export type WorkerChoiceStrategy = keyof typeof WorkerChoiceStrategies
/**
- * Tasks usage statistics requirements.
+ * Worker choice strategy options.
*/
-export type RequiredStatistics = {
- runTime: boolean
+export interface WorkerChoiceStrategyOptions {
+ /**
+ * Use tasks median run time instead of average run time.
+ *
+ * @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<number, number>
}
/**
- * Worker choice strategy interface.
+ * Pool worker tasks usage statistics requirements.
*
- * @template Worker Type of worker which manages the strategy.
+ * @internal
*/
-export interface IWorkerChoiceStrategy<Worker extends AbstractPoolWorker> {
+export interface RequiredStatistics {
/**
- * Is the pool attached to the strategy dynamic?.
+ * Require tasks run time.
*/
- isDynamicPool: boolean
+ runTime: boolean
+ /**
+ * Require tasks average run time.
+ */
+ avgRunTime: boolean
+ /**
+ * Require tasks median run time.
+ */
+ medRunTime: boolean
+}
+
+/**
+ * Worker choice strategy interface.
+ */
+export interface IWorkerChoiceStrategy {
/**
* Required tasks usage statistics.
*/
- requiredStatistics: RequiredStatistics
+ readonly requiredStatistics: RequiredStatistics
+ /**
+ * Resets strategy internals.
+ *
+ * @returns `true` if the reset is successful, `false` otherwise.
+ */
+ reset: () => boolean
+ /**
+ * Updates the worker node key strategy internals.
+ *
+ * @returns `true` if the update is successful, `false` otherwise.
+ */
+ update: (workerNodeKey: number) => boolean
+ /**
+ * Chooses a worker node in the pool and returns its key.
+ *
+ * @returns The worker node key.
+ */
+ 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
/**
- * Chooses a worker in the pool.
+ * Sets the worker choice strategy options.
+ *
+ * @param opts - The worker choice strategy options.
*/
- choose(): Worker
+ setOptions: (opts: WorkerChoiceStrategyOptions) => void
}