-import type { AbstractPoolWorker } from '../abstract-pool-worker'
-
/**
* Enumeration of worker choice strategies.
*/
*/
ROUND_ROBIN: 'ROUND_ROBIN',
/**
- * Less recently used worker selection strategy.
+ * Least used worker selection strategy.
+ */
+ LEAST_USED: 'LEAST_USED',
+ /**
+ * Least busy worker selection strategy.
+ */
+ LEAST_BUSY: 'LEAST_BUSY',
+ /**
+ * Least ELU worker selection strategy.
+ *
+ * @experimental
*/
- LESS_RECENTLY_USED: 'LESS_RECENTLY_USED',
+ LEAST_ELU: 'LEAST_ELU',
+ /**
+ * Fair share worker selection strategy.
+ */
+ FAIR_SHARE: 'FAIR_SHARE',
/**
* 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
+/**
+ * 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.
+ */
+ 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 \}
+ */
+ readonly runTime?: MeasurementOptions
+ /**
+ * Wait time options.
+ *
+ * @defaultValue \{ median: false \}
+ */
+ 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.
+ */
+ readonly weights?: Record<number, number>
+}
+
+/**
+ * Measurement statistics requirements.
+ *
+ * @internal
+ */
+export interface MeasurementStatisticsRequirements {
+ /**
+ * Requires measurement aggregate.
+ */
+ aggregate: boolean
+ /**
+ * Requires measurement average.
+ */
+ average: boolean
+ /**
+ * Requires measurement median.
+ */
+ median: boolean
+}
+
+/**
+ * Pool worker node worker usage statistics requirements.
+ *
+ * @internal
+ */
+export interface TaskStatisticsRequirements {
+ /**
+ * Tasks runtime requirements.
+ */
+ readonly runTime: MeasurementStatisticsRequirements
+ /**
+ * Tasks wait time requirements.
+ */
+ readonly waitTime: MeasurementStatisticsRequirements
+ /**
+ * Tasks event loop utilization requirements.
+ */
+ 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.
*
- * @template Worker Type of worker which manages the strategy.
+ * @internal
*/
-export interface IWorkerChoiceStrategy<Worker extends AbstractPoolWorker> {
+export interface IWorkerChoiceStrategy {
+ /**
+ * Strategy policy.
+ */
+ readonly strategyPolicy: StrategyPolicy
+ /**
+ * Tasks statistics requirements.
+ */
+ readonly taskStatisticsRequirements: TaskStatisticsRequirements
+ /**
+ * Resets strategy internals.
+ *
+ * @returns `true` if the reset is successful, `false` otherwise.
+ */
+ readonly reset: () => boolean
+ /**
+ * Updates the worker node key strategy internals.
+ *
+ * @returns `true` if the update is successful, `false` otherwise.
+ */
+ readonly update: (workerNodeKey: number) => boolean
+ /**
+ * Chooses a worker node in the pool and returns its key.
+ *
+ * @returns The worker node key.
+ */
+ readonly choose: () => number
/**
- * Is the pool attached to the strategy dynamic?.
+ * 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.
*/
- isDynamicPool: boolean
+ readonly remove: (workerNodeKey: number) => boolean
/**
- * Choose a worker in the pool.
+ * Sets the worker choice strategy options.
+ *
+ * @param opts - The worker choice strategy options.
*/
- choose(): Worker
+ readonly setOptions: (opts: WorkerChoiceStrategyOptions) => void
}