X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FDynamicClusterPool.html;h=e27ae5eda86ac56158af4280a219e76c1938e18a;hb=23a6c28d3cc6edb778653a4d9d9a4d36f9a961c3;hp=0fcdc4ccc02f2cdf0249c85164582b2b69721bf6;hpb=fe9f25b5ac98c7c7fccd1849a200c5054a77cf03;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index 0fcdc4cc..e27ae5ed 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -1,13 +1,15 @@ -
Constructs a new poolifier dynamic cluster pool.
Minimum number of workers which are always active.
-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.
Optional
opts: ClusterPoolOptions = {}Options for this dynamic cluster pool.
-Optional
Readonly
emitterProtected
busyWhether the pool is busy or not.
+The pool busyness boolean status.
+Overrides FixedClusterPool.busy
Protected
fullInherited from FixedClusterPool.numberOfRunningTasks
-Whether the pool is full or not.
+The pool filling boolean status.
+Inherited from FixedClusterPool.full
+Pool information.
+Inherited from FixedClusterPool.info
+Protected
maxThe pool maximum size.
+Overrides FixedClusterPool.maxSize
+Protected
minThe pool minimum size.
+Inherited from FixedClusterPool.minSize
+Private
readyThe pool readiness boolean status.
+Inherited from FixedClusterPool.ready
+Protected
typeThe pool type.
+If it is 'dynamic'
, it provides the max
property.
Overrides FixedClusterPool.type
Private
utilizationThe approximate pool utilization.
+The pool utilization.
+ +Inherited from FixedClusterPool.utilization
+Protected
workerThe worker type.
+Inherited from FixedClusterPool.worker
+Protected
afterProtected
afterHook executed after the worker task execution. +Can be overridden.
+Inherited from FixedClusterPool.afterWorkerSetup
-Protected
chooseChoose a worker for the next task.
-The default implementation uses a round robin algorithm to distribute the load.
- -Worker.
+The worker node key.
Inherited from FixedClusterPool.chooseWorker
-Protected
createCreates a new worker for this pool and sets it up completely.
- -New, completely set up worker.
+ +The received message.
Inherited from FixedClusterPool.createAndSetupWorker
-Protected
createInherited from FixedClusterPool.afterTaskExecutionHook
+Protected
afterInherited from FixedClusterPool.createWorker
-Protected
decreaseDecrease the number of tasks that the given worker has applied.
+Method hooked up after a worker node has been newly created. +Can be overridden.
Worker whose tasks are decreased.
-Inherited from FixedClusterPool.decreaseWorkersTasks
-Inherited from FixedClusterPool.destroy
-Inherited from FixedClusterPool.afterWorkerNodeSetup
+Protected
beforeHook executed before the worker task execution. +Can be overridden.
+Inherited from FixedClusterPool.destroyWorker
-The worker node key.
+The task to execute.
+Inherited from FixedClusterPool.beforeTaskExecutionHook
+Protected
checkInherited from FixedClusterPool.execute
+Inherited from FixedClusterPool.checkDynamicPoolSize
Protected
createInherited from FixedClusterPool.findFreeWorker
+Creates a new, completely set up dynamic worker node.
+New, completely set up dynamic worker node key.
+ +Inherited from FixedClusterPool.createAndSetupDynamicWorkerNode
+Protected
createCreates a new, completely set up worker node.
+New, completely set up worker node key.
+ +Inherited from FixedClusterPool.createAndSetupWorkerNode
+Protected
createCreates a new worker.
+Newly created worker.
+ +Inherited from FixedClusterPool.createWorker
Terminates all workers in this pool.
+Inherited from FixedClusterPool.destroy
+Protected
destroyTerminates the worker node given its worker node key.
+Inherited from FixedClusterPool.getWorkerIndex
-Inherited from FixedClusterPool.destroyWorkerNode
+Enables/disables the worker tasks queue in this pool.
+Inherited from FixedClusterPool.getWorkerRunningTasks
-Protected
increaseWhether to enable or disable the worker tasks queue.
+Optional
tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
+Inherited from FixedClusterPool.enableTasksQueue
+Increase the number of tasks that the given worker has applied.
+Executes the specified function in the worker constructor with the task data input parameter.
Worker whose tasks are increased.
-Inherited from FixedClusterPool.increaseWorkersTask
+Optional
data: DataThe task input data for the specified worker function. This can only be structured-cloneable 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
internalProtected
flushInherited from FixedClusterPool.internalExecute
+Inherited from FixedClusterPool.flushTasksQueue
Protected
internalProtected
getInherited from FixedClusterPool.internalGetBusyStatus
-Protected
isGets the worker information given its worker node key.
+The worker node key.
+The worker information.
+ +Inherited from FixedClusterPool.getWorkerInfo
+Protected
internalWhether worker nodes are executing at least one task.
+Worker nodes busyness boolean status.
+ +Inherited from FixedClusterPool.internalBusy
+Protected
isShould return whether the worker is the main worker or not.
+Inherited from FixedClusterPool.isMain
Protected
registerThe worker node key.
+The message listener callback.
+Inherited from FixedClusterPool.registerWorkerMessageListener
Protected
removeProtected
sendRemoves the given worker from the pool.
+Sends the startup message to worker given its worker node key.
Worker that will be removed.
-Inherited from FixedClusterPool.removeWorker
-Protected
sendInherited from FixedClusterPool.sendStartupMessageToWorker
+Protected
sendSends a message to worker given its worker node key.
+The worker node key.
+The message.
+Inherited from FixedClusterPool.sendToWorker
Sets the worker tasks queue options in this pool.
+The worker tasks queue options.
+Inherited from FixedClusterPool.setTasksQueueOptions
+Sets the worker choice strategy in this pool.
+The worker choice strategy.
+Optional
workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
+Inherited from FixedClusterPool.setWorkerChoiceStrategy
Protected
setupSets the worker choice strategy options in this pool.
+The worker choice strategy options.
+Inherited from FixedClusterPool.setWorkerChoiceStrategyOptions
+Protected
setupSetup hook to execute code before worker nodes are created in the abstract constructor. +Can be overridden.
+Inherited from FixedClusterPool.setupHook
Protected
workerProtected
workerThis function is the listener registered for each worker.
- -The listener function to execute when a message is received from a worker.
+This method 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.
- -The listener function to execute when a message is received from a worker.
+This method is the listener registered for each worker message.
The listener function to execute when a message is received from a worker.
+ +Inherited from FixedClusterPool.workerListener
Generated using TypeDoc
A cluster pool with a dynamic number of workers, but a guaranteed minimum number of workers.
This cluster pool creates new workers when the others are busy, up to the maximum number of workers. -When the maximum number of workers is reached, an event is emitted. If you want to listen to this event, use the pool's
- -emitter
.Template
of data sent to the worker. This can only be serializable data.
- -Template
of response of execution. This can only be serializable data.
- -Author
Christopher Quadflieg
+When the maximum number of workers is reached and workers are busy, an event is emitted. If you want to listen to this event, use the pool'semitter
. +Author
Christopher Quadflieg
-Since
2.0.0
+Since
2.0.0