repositories
/
poolifier.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
fix: ensure worker node destroy semantic is always the same
[poolifier.git]
/
src
/
pools
/
selection-strategies
/
selection-strategies-types.ts
diff --git
a/src/pools/selection-strategies/selection-strategies-types.ts
b/src/pools/selection-strategies/selection-strategies-types.ts
index 0fbb4d4d43165737d3bd3c0c7378b2c55d7e03d2..563b04b00086a7a31a68f7cb25ca4bde6b513c92 100644
(file)
--- 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
*/
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.
*/
/**
* Measurement options.
*/
-interface MeasurementOptions {
+
export
interface MeasurementOptions {
/**
* Set measurement median.
*/
/**
* Set measurement median.
*/
- median: boolean
+
readonly
median: boolean
}
/**
* Worker choice strategy options.
*/
export interface WorkerChoiceStrategyOptions {
}
/**
* Worker choice strategy options.
*/
export interface WorkerChoiceStrategyOptions {
+ /**
+ * Measurement to use for worker choice strategy.
+ */
+ readonly measurement?: Measurement
/**
* Runtime options.
*
* @defaultValue \{ median: false \}
*/
/**
* Runtime options.
*
* @defaultValue \{ median: false \}
*/
- runTime?: MeasurementOptions
+ r
eadonly r
unTime?: MeasurementOptions
/**
* Wait time options.
*
* @defaultValue \{ median: false \}
*/
/**
* 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.
*/
/**
* 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>
+
readonly
weights?: Record<number, number>
}
/**
}
/**
@@
-81,17
+105,17
@@
export interface WorkerChoiceStrategyOptions {
*
* @internal
*/
*
* @internal
*/
-interface MeasurementStatisticsRequirements {
+
export
interface MeasurementStatisticsRequirements {
/**
/**
- * Require measurement aggregate.
+ * Require
s
measurement aggregate.
*/
aggregate: boolean
/**
*/
aggregate: boolean
/**
- * Require measurement average.
+ * Require
s
measurement average.
*/
average: boolean
/**
*/
average: boolean
/**
- * Require measurement median.
+ * Require
s
measurement median.
*/
median: boolean
}
*/
median: boolean
}
@@
-105,21
+129,39
@@
export interface TaskStatisticsRequirements {
/**
* Tasks runtime requirements.
*/
/**
* Tasks runtime requirements.
*/
- runTime: MeasurementStatisticsRequirements
+ r
eadonly r
unTime: MeasurementStatisticsRequirements
/**
* Tasks wait time requirements.
*/
/**
* 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.
}
/**
* Worker choice strategy interface.
+ *
+ * @internal
*/
export interface IWorkerChoiceStrategy {
*/
export interface IWorkerChoiceStrategy {
+ /**
+ * Strategy policy.
+ */
+ readonly strategyPolicy: StrategyPolicy
/**
* Tasks statistics requirements.
*/
/**
* Tasks statistics requirements.
*/
@@
-129,30
+171,30
@@
export interface IWorkerChoiceStrategy {
*
* @returns `true` if the reset is successful, `false` otherwise.
*/
*
* @returns `true` if the reset is successful, `false` otherwise.
*/
- reset: () => boolean
+ re
adonly re
set: () => boolean
/**
* Updates the worker node key strategy internals.
*
* @returns `true` if the update is successful, `false` otherwise.
*/
/**
* 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.
*/
/**
* 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.
*/
/**
* 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
+ re
adonly re
move: (workerNodeKey: number) => boolean
/**
* Sets the worker choice strategy options.
*
* @param opts - The worker choice strategy options.
*/
/**
* Sets the worker choice strategy options.
*
* @param opts - The worker choice strategy options.
*/
- setOptions: (opts: WorkerChoiceStrategyOptions) => void
+
readonly
setOptions: (opts: WorkerChoiceStrategyOptions) => void
}
}