X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Finterfaces%2FIWorkerChoiceStrategy.html;h=94cdc7b53f4a74ea05cfc1ff333d89502f932aa8;hb=f8b3d84c1c95773a1e18d2c025d89d73c4f2ab15;hp=d87f0c3d2043b7f61bd382241eb28b24562e95a4;hpb=13aa72e5091fcfe52dcd2acf1039091e1d55ea32;p=poolifier.git diff --git a/docs/interfaces/IWorkerChoiceStrategy.html b/docs/interfaces/IWorkerChoiceStrategy.html index d87f0c3d..b72eb92e 100644 --- a/docs/interfaces/IWorkerChoiceStrategy.html +++ b/docs/interfaces/IWorkerChoiceStrategy.html @@ -1,193 +1,28 @@ -
Chooses a worker node in the pool and returns its key.
-Removes a worker node key from strategy internals.
-The worker node key.
-Readonly
requiredRequired tasks usage statistics.
-Resets strategy internals (counters, statistics, etc.).
-Sets the worker choice strategy options.
-The worker choice strategy options.
-Generated using TypeDoc
Internal
Worker choice strategy interface.
+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.
-