X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIWorkerChoiceStrategy.html;h=a5d3659cb4c07061c2bd57454c20cacb21e78cc7;hb=5e133e82f086deb4b1ad5803b5df64ff924c69f1;hp=153e6513a232970458cf160be99a84ac55a12c26;hpb=717e9363ccc3cfdbd24bda1bd019d31274163b10;p=poolifier.git diff --git a/docs/interfaces/IWorkerChoiceStrategy.html b/docs/interfaces/IWorkerChoiceStrategy.html index 153e6513..a5d3659c 100644 --- a/docs/interfaces/IWorkerChoiceStrategy.html +++ b/docs/interfaces/IWorkerChoiceStrategy.html @@ -1,220 +1,28 @@ -
Internal
Internal
Worker choice strategy interface.
+Readonly
chooseChooses a worker node in the pool and returns its key.
-If the worker node is not eligible, undefined
is returned.
The worker node key or undefined
.
Readonly
removeRemoves the worker node key from strategy internals.
-The worker node key.
-true
if the worker node key is removed, false
otherwise.
Readonly
resetResets strategy internals.
-true
if the reset is successful, false
otherwise.
Readonly
setSets the worker choice strategy options.
-The worker choice strategy options.
-Readonly
strategyStrategy policy.
-Readonly
taskTasks statistics requirements.
-Readonly
updateUpdates the worker node key strategy internals.
-true
if the update is successful, false
otherwise.
Generated using TypeDoc
Readonly
chooseChooses 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.
The worker node key or undefined
.
Readonly
hasWhether the pool has worker nodes ready or not.
+Whether the pool has worker nodes ready or not.
+Readonly
removeRemoves the worker node key from strategy internals.
+The worker node key.
+true
if the worker node key is removed, false
otherwise.
Readonly
resetResets strategy internals.
+true
if the reset is successful, false
otherwise.
Readonly
setSets the worker choice strategy options.
+The worker choice strategy options.
+Readonly
strategyStrategy policy.
+Readonly
taskTasks statistics requirements.
+Readonly
updateUpdates the worker node key strategy internals. +This is called after a task has been executed on a worker node.
+true
if the update is successful, false
otherwise.
Generated using TypeDoc
Worker choice strategy interface.
-