X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=docs%2Fclasses%2FDynamicClusterPool.html;h=0386e65b205229b799bc4793b2b3dddfe5c7d8bb;hb=842d8918a19fc2720d4436789a2e373bc623452e;hp=3667203261acef2973265b71a0b76d1e465e4173;hpb=812ad701baefad24cad2df8f9a60bf4d581d8697;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index 36672032..0386e65b 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -42,7 +42,7 @@ When the maximum number of workers is reached and workers are busy, an event is
Optional
Readonly
emitterReadonly
fileInherited from FixedClusterPool.filePath
Readonly
maxMaximum number of workers that can be created by this pool.
Readonly
numberInherited from FixedClusterPool.numberOfWorkers
Readonly
optsInherited from FixedClusterPool.opts
Protected
promiseThe execution response promise map.
key
: The message id of each submitted task.Inherited from FixedClusterPool.promiseResponseMap
Protected
workerWorker choice strategy context referencing a worker choice algorithm implementation.
Default to a round robin algorithm.
Inherited from FixedClusterPool.workerChoiceStrategyContext
Readonly
workerPool worker nodes.
+Inherited from FixedClusterPool.workerNodes
Whether the pool is busy or not.
+The pool busyness boolean status.
+Overrides FixedClusterPool.busy
Whether the pool is full or not.
+The pool filling boolean status.
+Overrides FixedClusterPool.full
Private
numberInherited from FixedClusterPool.numberOfQueuedTasks
Private
numberInherited from FixedClusterPool.numberOfRunningTasks
Pool type.
+If it is 'dynamic'
, it provides the max
property.
Overrides FixedClusterPool.type
Protected
afterHook executed after the worker task execution. Can be overridden.
@@ -276,29 +284,32 @@ Can be overridden.The worker.
The received message.
Inherited from FixedClusterPool.afterTaskExecutionHook
Protected
afterFunction that can be hooked up when a worker has been newly created and moved to the pool worker nodes.
+Can be used to update the maxListeners
or binding the main-worker
<->worker
connection if not bind by default.
The newly created worker.
+Inherited from FixedClusterPool.afterWorkerSetup
Protected
beforeInherited from FixedClusterPool.beforeTaskExecutionHook
Protected
chooseChooses a worker node for the next task.
The default uses a round robin algorithm to distribute the load.
[worker node key, worker node].
Inherited from FixedClusterPool.chooseWorkerNode
Protected
createInherited from FixedClusterPool.createAndSetupWorker
Protected
createReturns a newly created worker.
+Inherited from FixedClusterPool.createWorker
Shutdowns every current worker in this pool.
+Inherited from FixedClusterPool.destroy
Shutdowns the given worker.
+A worker within workerNodes
.
Inherited from FixedClusterPool.destroyWorker
Performs the task specified in the constructor with the data parameter.
+ +Promise that will be resolved when the task is successfully completed.
+The input for the specified task. This can only be serializable data.
+Inherited from FixedClusterPool.execute
Finds a free worker node key based on the number of tasks the worker has applied.
+If a worker is found with 0
running tasks, it is detected as free and its worker node key is returned.
If no free worker is found, -1
is returned.
A worker node key if there is one, -1
otherwise.
Inherited from FixedClusterPool.findFreeWorkerNodeKey
Protected
internalInherited from FixedClusterPool.internalBusy
Protected
isShould return whether the worker is the main worker or not.
+Inherited from FixedClusterPool.isMain
Registers a listener callback on the given worker.
+The worker which should register a listener.
+The message listener callback.
+Inherited from FixedClusterPool.registerWorkerMessageListener
Protected
sendSends a message to the given worker.
+The worker which should receive the message.
+The message.
+Inherited from FixedClusterPool.sendToWorker
Sets the worker choice strategy in this pool.
+The worker choice strategy.
+Inherited from FixedClusterPool.setWorkerChoiceStrategy
Protected
setupSetup hook to execute code before worker node are created in the abstract constructor. +Can be overridden
+Inherited from FixedClusterPool.setupHook
Protected
workerThis function is the listener registered for each worker message.
The listener function to execute when a message is received from a worker.
This function is the listener registered for each worker message.
@@ -532,11 +564,11 @@ Can be overridden.Inherited from FixedClusterPool.workerListener
Inherit Doc