X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIWorkerChoiceStrategy.html;h=ce4505d30df6d0a6d875dedf823d880953e61da4;hb=be55f2ca8b4792c645c4aaee38f0e3471a1efcb2;hp=35995dd4a8e7bc34bf310e2c1372f9ec420389f2;hpb=749e1fa387ba832c85f789337b3c2e679331cb64;p=poolifier.git diff --git a/docs/interfaces/IWorkerChoiceStrategy.html b/docs/interfaces/IWorkerChoiceStrategy.html index 35995dd4..ce4505d3 100644 --- a/docs/interfaces/IWorkerChoiceStrategy.html +++ b/docs/interfaces/IWorkerChoiceStrategy.html @@ -1,193 +1,25 @@ -
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
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.
-