X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Finterfaces%2FIWorkerChoiceStrategy.html;h=94cdc7b53f4a74ea05cfc1ff333d89502f932aa8;hb=f8b3d84c1c95773a1e18d2c025d89d73c4f2ab15;hp=694a3c4c475ccf8a9883756f50acb1d110da2bc0;hpb=a97f9c80aa49c6152547fb6fa8de4b0f089c2353;p=poolifier.git diff --git a/docs/interfaces/IWorkerChoiceStrategy.html b/docs/interfaces/IWorkerChoiceStrategy.html index 694a3c4c..b72eb92e 100644 --- a/docs/interfaces/IWorkerChoiceStrategy.html +++ b/docs/interfaces/IWorkerChoiceStrategy.html @@ -1,255 +1,28 @@ -
Internal
Worker choice strategy interface.
+Chooses a worker node in the pool and returns its key.
-The worker node key.
- -Removes the worker node key from strategy internals.
-The worker node key.
-true
if the worker node key is removed, false
otherwise.
Resets strategy internals.
-true
if the reset is successful, false
otherwise.
Sets the worker choice strategy options.
-The worker choice strategy options.
-Readonly
strategyStrategy policy.
-Readonly
taskTasks statistics requirements.
-Updates 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.
-