X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicClusterPool.html;h=33d2afd58c6e9a31091c177e8a41426704b705cf;hb=184d530faf6acf70e116cb4a3fb831938b73e2c0;hp=65a333459c280bc7558a283dd5731f49b4b54ccc;hpb=ec74f6ae420613c4430428a5cadfa1c36acabc6e;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index 65a33345..33d2afd5 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
'full'
: Emitted when the pool is dynamic and full.'busy'
: Emitted when the pool is busy.'error'
: Emitted when an uncaught error occurs.'taskError'
: Emitted when an error occurs while executing a task.Readonly
fileProtected
Readonly
fileReadonly
maxProtected
Readonly
maxMaximum number of workers that can be created by this pool.
Readonly
numberProtected
Readonly
numberNumber of workers that this pool should manage.
Readonly
optsProtected
Readonly
optsOptions for this fixed cluster pool.
Protected
promiseProtected
workerReadonly
workerProtected
fullWhether the pool is full or not.
The pool filling boolean status.
Private
numberProtected
maxNumber of tasks queued in the pool.
+Pool maximum size.
Private
numberProtected
minNumber of tasks running in the pool.
+Pool minimum size.
Protected
typePool type.
If it is 'dynamic'
, it provides the max
property.
Protected
workerGets the worker type.
+Inherited from FixedClusterPool.worker
+The worker.
The received message.
Inherited from FixedClusterPool.afterTaskExecutionHook
Protected
afterInherited 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.
+The default worker choice strategy uses a round robin algorithm to distribute the load.
[worker node key, worker node].
+The worker node key
Inherited from FixedClusterPool.chooseWorkerNode
Protected
createInherited from FixedClusterPool.createAndSetupWorker
Protected
createInherited from FixedClusterPool.createWorker
Inherited from FixedClusterPool.destroy
Protected
destroyInherited from FixedClusterPool.destroyWorker
Inherited from FixedClusterPool.enableTasksQueue
Executes the function specified in the worker constructor with the task data input parameter.
+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 FixedClusterPool.execute
Protected
internalInherited from FixedClusterPool.internalBusy
Protected
isInherited from FixedClusterPool.isMain
Protected
registerInherited from FixedClusterPool.registerWorkerMessageListener
Protected
sendThe worker which should receive the message.
The message.
Inherited from FixedClusterPool.sendToWorker
Inherited from FixedClusterPool.setTasksQueueOptions
The worker choice strategy.
Inherited from FixedClusterPool.setWorkerChoiceStrategy
Inherited from FixedClusterPool.setWorkerChoiceStrategyOptions
Protected
setupInherited from FixedClusterPool.setupHook
Protected
workerThe listener function to execute when a message is received from a worker.
Inherited from FixedClusterPool.workerListener
Generated using TypeDoc
Path to the worker file.