X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FFixedClusterPool.html;h=a206c71efbfc60a0aec7c21c6cc31ed391d65a4b;hb=e8dacfb2833a6682fad27f857b1127a1e04b2f04;hp=d0a02fba56a34d3aabe6ce206e18532fe7ddf551;hpb=8d1797ad15cb2d87ac3c9904ce6df3db45c0c742;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index d0a02fba..a206c71e 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -24,9 +24,9 @@
2.0.0
-Constructs a new poolifier fixed cluster pool.
Readonly
fileReadonly
numberReadonly
optsProtected
promiseProtected
workerReadonly
workerProtected
fullPrivate
numberPrivate
numberPool maximum size.
+The worker.
The received message.
Protected
afterProtected
beforeProtected
chooseChooses a worker node for the next task.
The default uses a round robin algorithm to distribute the load.
- -[worker node key, worker node].
Protected
createCreates a new worker and sets it up completely in the pool worker nodes.
- -New, completely set up worker.
New, completely set up worker.
+Inherited from AbstractPool.createAndSetupWorker
Protected
createOverrides AbstractPool.createWorker
Inherited from AbstractPool.destroy
Protected
destroyOverrides AbstractPool.destroyWorker
Inherited from AbstractPool.enableTasksQueue
Executes the function specified in the worker constructor with the task data input parameter.
- -Promise that will be fulfilled when the task is completed.
+Executes the specified function in the worker constructor with the task data input parameter.
Optional
data: DataThe task input data for the specified worker function. This can only be serializable data.
+Optional
name: stringThe name of the worker function to execute. If not specified, the default worker function will be executed.
Promise that will be fulfilled when the task is completed.
+Inherited from AbstractPool.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 AbstractPool.findFreeWorkerNodeKey
-Protected
internalInherited from AbstractPool.internalBusy
Protected
isOverrides AbstractPool.isMain
Protected
registerRegisters a listener callback on the given worker.
Overrides AbstractPool.registerWorkerMessageListener
Protected
sendThe worker which should receive the message.
The message.
Overrides AbstractPool.sendToWorker
Inherited from AbstractPool.setTasksQueueOptions
Inherited from AbstractPool.setWorkerChoiceStrategy
Inherited from AbstractPool.setWorkerChoiceStrategyOptions
Protected
setupOverrides AbstractPool.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.
The listener function to execute when a message is received from a worker.
+This function is the listener registered for each worker message.
- -The listener function to execute when a message is received from a worker.
The listener function to execute when a message is received from a worker.
+Inherited from AbstractPool.workerListener
Type of data sent to the worker. This can only be serializable data.
@@ -44,7 +44,7 @@@@ -70,6 +70,7 @@ full number Of Queued Tasks
number Of Running Tasks
+size
type