X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicClusterPool.html;h=7a747ac53a3ee00436d4a0f6cd444f9aecf6beec;hb=8974e0633f6c99528bf3590e7c76820b2c69d3e2;hp=25c5175756c1fed342a8016e704c7fb9929891ca;hpb=c065162cbd0458f984708314dcf5e80c7777077a;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index 25c51757..7a747ac5 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -1,4 +1,4 @@ -
Maximum number of workers that can be created by this pool.
-Path to an implementation of a ClusterWorker
file, which can be relative or absolute.
Options for this dynamic cluster pool.
-Emitter on which events can be listened to.
Events that can currently be listened to:
'full'
: Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.'ready'
: Emitted when the number of workers created in the pool has reached the minimum size expected and are ready.'busy'
: Emitted when the number of workers created in the pool has reached the maximum size expected and are executing at least one task.'busy'
: Emitted when the number of workers created in the pool has reached the maximum size expected and are executing concurrently their tasks quota.'full'
: Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.'destroy'
: Emitted when the pool is destroyed.'error'
: Emitted when an uncaught error occurs.'taskError'
: Emitted when an error occurs while executing a task.'backPressure'
: Emitted when all worker nodes have back pressure (i.e. their tasks queue is full: queue size >= maximum queue size).Protected
Readonly
fileProtected
Readonly
maxMaximum number of workers that can be created by this pool.
Protected
Readonly
numberProtected
Readonly
optsProtected
promiseThe execution response promise map.
+ +The task execution response promise map.
key
: The message id of each submitted task.value
: An object that contains the worker, the execution response promise resolve and reject callbacks.Protected
workerReadonly
workerReadonly
Internal
workerPool worker nodes.
Protected
fullProtected
maxPool maximum size.
+The pool maximum size.
Protected
minPool minimum size.
+The pool minimum size.
Private
readyProtected
typePool type.
+The pool type.
If it is 'dynamic'
, it provides the max
property.
Overrides FixedClusterPool.type
Private
utilizationGets the approximate pool utilization.
+The approximate pool utilization.
The pool utilization.
Inherited from FixedClusterPool.utilization
Protected
workerGets the worker type.
+The worker type.
Inherited from FixedClusterPool.worker
Protected
afterHook executed after the worker task execution. Can be overridden.
@@ -355,41 +364,38 @@ Can be overridden.The worker.
-The worker node key.
+The received message.
-Inherited from FixedClusterPool.afterTaskExecutionHook
Protected
afterProtected
afterFunction that can be hooked up when a worker has been newly created and moved to the pool worker nodes. +
Method hooked up after a worker node has been newly created. Can be overridden.
The newly created worker.
-The newly created worker node key.
+Inherited from FixedClusterPool.afterWorkerSetup
+Inherited from FixedClusterPool.afterWorkerNodeSetup
Protected
beforeThe worker node key.
-The task to execute.
-Inherited from FixedClusterPool.beforeTaskExecutionHook
Protected
checkInherited from FixedClusterPool.checkDynamicPoolSize
Protected
createProtected
createCreates a new dynamic worker and sets it up completely in the pool worker nodes.
+Creates a new, completely set up dynamic worker node.
New, completely set up dynamic worker.
+New, completely set up dynamic worker node key.
Inherited from FixedClusterPool.createAndSetupDynamicWorker
+Inherited from FixedClusterPool.createAndSetupDynamicWorkerNode
Protected
createProtected
createCreates a new worker and sets it up completely in the pool worker nodes.
+Creates a new, completely set up worker node.
New, completely set up worker.
+New, completely set up worker node key.
Inherited from FixedClusterPool.createAndSetupWorker
+Inherited from FixedClusterPool.createAndSetupWorkerNode
Protected
createInherited from FixedClusterPool.createWorker
Terminates every current worker in this pool.
+Terminates all workers in this pool.
Inherited from FixedClusterPool.destroy
Protected
destroyProtected
destroyTerminates the given worker.
+Terminates the worker node given its worker node key.
A worker within workerNodes
.
The worker node key.
+Inherited from FixedClusterPool.destroyWorker
+Inherited from FixedClusterPool.destroyWorkerNode
Enables/disables the worker tasks queue in this pool.
+Enables/disables the worker node tasks queue in this pool.
Whether to enable or disable the worker tasks queue.
-Whether to enable or disable the worker node tasks queue.
+Optional
tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
-The worker node tasks queue options.
+Optional
Inherited from FixedClusterPool.enableTasksQueue
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 structured-cloneable data.
-The optional task input data for the specified task function. This can only be structured-cloneable data.
+Optional
Optional
name: stringThe name of the worker function to execute. If not specified, the default worker function will be executed.
-The optional name of the task function to execute. If not specified, the default task function will be executed.
+Optional
Optional
transferList: TransferListItem[]An optional array of transferable objects to transfer ownership of. Ownership of the transferred objects is given to the pool's worker_threads worker and they should not be used in the main thread afterwards.
+Optional
Promise that will be fulfilled when the task is completed.
Inherited from FixedClusterPool.execute
Protected
flushInherited from FixedClusterPool.flushTasksQueue
+Protected
getGets the worker information given its worker node key.
+The worker node key.
+The worker information.
+ +Inherited from FixedClusterPool.getWorkerInfo
+Internal
+Whether the worker node has back pressure (i.e. its tasks queue is full).
+The worker node key.
+true
if the worker node has back pressure, false
otherwise.
Inherited from FixedClusterPool.hasWorkerNodeBackPressure
+Protected
internalWhether worker nodes are executing at least one task.
+Whether worker nodes are executing concurrently their tasks quota or not.
Worker nodes busyness boolean status.
Inherited from FixedClusterPool.internalBusy
Protected
isInherited from FixedClusterPool.isMain
Lists the names of task function available in this pool.
+The names of task function available in this pool.
+ +Inherited from FixedClusterPool.listTaskFunctions
+Protected
registerRegisters a listener callback on the worker given its worker node key.
+The worker node key.
+The message listener callback.
+Inherited from FixedClusterPool.registerWorkerMessageListener
+Protected
sendInherited from FixedClusterPool.sendKillMessageToWorker
+Protected
sendSends the startup message to worker given its worker node key.
+The worker node key.
+Inherited from FixedClusterPool.sendStartupMessageToWorker
+Protected
sendSends a message to the given worker.
+Sends a message to worker given its worker node key.
The worker which should receive the message.
-The worker node key.
+The message.
-Inherited from FixedClusterPool.sendToWorker
Sets the worker tasks queue options in this pool.
+Sets the worker node tasks queue options in this pool.
The worker tasks queue options.
-The worker node tasks queue options.
+Inherited from FixedClusterPool.setTasksQueueOptions
The worker choice strategy.
-Optional
workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
-Optional
Inherited from FixedClusterPool.setWorkerChoiceStrategy
The worker choice strategy options.
-Inherited from FixedClusterPool.setWorkerChoiceStrategyOptions
Protected
setupInherited from FixedClusterPool.setupHook
Protected
workerThis function is the listener registered for each worker message.
+This method is the listener registered for each worker message.
The listener function to execute when a message is received from a worker.
@@ -696,7 +834,7 @@ Can be overridden.This function is the listener registered for each worker message.
+This method is the listener registered for each worker message.
Inherited from FixedClusterPool.workerListener
Generated using TypeDoc
Generated using TypeDoc
\ No newline at end of file
Minimum number of workers which are always active.
-