repositories
/
poolifier.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
chore: v3.1.0
[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 52e287e72dbf9592b28f181e209e3bb14a586e8d..6990e65fcf365e340b118f2b6fcc0a00c2214a57 100644
(file)
--- a/
src/pools/selection-strategies/selection-strategies-types.ts
+++ b/
src/pools/selection-strategies/selection-strategies-types.ts
@@
-16,8
+16,6
@@
export const WorkerChoiceStrategies = Object.freeze({
LEAST_BUSY: 'LEAST_BUSY',
/**
* Least ELU worker selection strategy.
LEAST_BUSY: 'LEAST_BUSY',
/**
* Least ELU worker selection strategy.
- *
- * @experimental
*/
LEAST_ELU: 'LEAST_ELU',
/**
*/
LEAST_ELU: 'LEAST_ELU',
/**
@@
-62,7
+60,7
@@
export interface MeasurementOptions {
/**
* Set measurement median.
*/
/**
* Set measurement median.
*/
- median: boolean
+
readonly
median: boolean
}
/**
}
/**
@@
-70,34
+68,40
@@
export interface MeasurementOptions {
*/
export interface WorkerChoiceStrategyOptions {
/**
*/
export interface WorkerChoiceStrategyOptions {
/**
- * Measurement to use for worker choice strategy.
+ * Number of worker choice retries to perform if no worker is eligible.
+ *
+ * @defaultValue 6
+ */
+ readonly retries?: number
+ /**
+ * Measurement to use in worker choice strategy supporting it.
*/
*/
- measurement?: Measurement
+
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 \}
*/
/**
* Event loop utilization options.
*
* @defaultValue \{ median: false \}
*/
- elu?: MeasurementOptions
+
readonly
elu?: MeasurementOptions
/**
/**
- * Worker weights to use for weighted round robin worker selection strateg
y
.
- *
Weight is the tasks maximum average or median runtime in milliseconds
.
+ * Worker weights to use for weighted round robin worker selection strateg
ies
.
+ *
A weight is tasks maximum execution time in milliseconds for a worker node
.
*
*
- * @defaultValue
Computed worker weights
automatically given the CPU performance.
+ * @defaultValue
Weights computed
automatically given the CPU performance.
*/
*/
- weights?: Record<number, number>
+
readonly
weights?: Record<number, number>
}
/**
}
/**
@@
-107,15
+111,15
@@
export interface WorkerChoiceStrategyOptions {
*/
export 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
}
@@
-129,29
+133,37
@@
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
/**
* Tasks event loop utilization requirements.
*/
/**
* Tasks event loop utilization requirements.
*/
- elu: MeasurementStatisticsRequirements
+
readonly
elu: MeasurementStatisticsRequirements
}
/**
* Strategy policy.
}
/**
* Strategy policy.
+ *
+ * @internal
*/
export interface StrategyPolicy {
/**
*/
export interface StrategyPolicy {
/**
- * Expect
direct usage of
dynamic worker.
+ * Expect
s tasks execution on the newly created
dynamic worker.
*/
*/
- useDynamicWorker: boolean
+ readonly dynamicWorkerUsage: boolean
+ /**
+ * Expects the newly created dynamic worker to be flagged as ready.
+ */
+ readonly dynamicWorkerReady: boolean
}
/**
* Worker choice strategy interface.
}
/**
* Worker choice strategy interface.
+ *
+ * @internal
*/
export interface IWorkerChoiceStrategy {
/**
*/
export interface IWorkerChoiceStrategy {
/**
@@
-167,30
+179,39
@@
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.
/**
* Updates the worker node key strategy internals.
+ * This is called after a task has been executed on a worker node.
*
* @returns `true` if the update is successful, `false` otherwise.
*/
*
* @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.
/**
* Chooses a worker node in the pool and returns its key.
+ * If no worker nodes are not eligible, `undefined` is returned.
+ * If `undefined` is returned, the caller retry.
*
*
- * @returns The worker node key.
+ * @returns The worker node key
or `undefined`
.
*/
*/
- choose: () => number
+ readonly choose: () => number | undefined
/**
* 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
+ /**
+ * Whether the pool has worker nodes ready or not.
+ *
+ * @returns Whether the pool has worker nodes ready or not.
+ */
+ readonly hasPoolWorkerNodesReady: () => boolean
}
}