repositories
/
poolifier.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Merge dependabot/npm_and_yarn/examples/typescript/smtp-client-pool/poolifier-3.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 9f68c22f892c50a3e424b59a3cb0cffe9f61557f..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',
/**
@@
-70,7
+68,13
@@
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.
*/
readonly measurement?: Measurement
/**
*/
readonly measurement?: Measurement
/**
@@
-92,10
+96,10
@@
export interface WorkerChoiceStrategyOptions {
*/
readonly 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.
*/
readonly weights?: Record<number, number>
}
*/
readonly weights?: Record<number, number>
}
@@
-147,13
+151,19
@@
export interface TaskStatisticsRequirements {
*/
export interface StrategyPolicy {
/**
*/
export interface StrategyPolicy {
/**
- * Expects direct usage of dynamic worker.
+ * Expects tasks execution on the newly created dynamic worker.
+ */
+ readonly dynamicWorkerUsage: boolean
+ /**
+ * Expects the newly created dynamic worker to be flagged as ready.
*/
*/
- readonly
useDynamicWorker
: boolean
+ readonly
dynamicWorkerReady
: boolean
}
/**
* Worker choice strategy interface.
}
/**
* Worker choice strategy interface.
+ *
+ * @internal
*/
export interface IWorkerChoiceStrategy {
/**
*/
export interface IWorkerChoiceStrategy {
/**
@@
-169,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
}
}