X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FDynamicClusterPool.html;h=4c52051dbdaeb51f9b1d96183e4b4ca914536052;hb=3abeb14de6a5845deeb027ccc69c3feeec8f4a3a;hp=5e8ceb76f84d47a8c1fd4f1d335bec4060a9200f;hpb=248bc34b348a7d8d2b90eecff49d60a3b465da9e;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index 5e8ceb76..4c52051d 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
+Overrides FixedClusterPool.type
-Protected
afterPool information.
+Inherited from FixedClusterPool.info
+Protected
maxInherited from FixedClusterPool.afterWorkerSetup
-Protected
choosePool maximum size.
+Overrides FixedClusterPool.maxSize
+Protected
minChoose a worker for the next task.
-The default implementation uses a round robin algorithm to distribute the load.
- -Worker.
+Pool minimum size.
Inherited from FixedClusterPool.chooseWorker
-Protected
createInherited from FixedClusterPool.minSize
+Protected
typeCreates a new worker for this pool and sets it up completely.
- -New, completely set up worker.
+Pool type.
+If it is 'dynamic'
, it provides the max
property.
Inherited from FixedClusterPool.createAndSetupWorker
+Overrides FixedClusterPool.type
Protected
createPrivate
utilizationInherited from FixedClusterPool.createWorker
+Gets the approximate pool utilization.
+The pool utilization.
+ +Inherited from FixedClusterPool.utilization
+Protected
workerGets the worker type.
+Inherited from FixedClusterPool.worker
Protected
decreaseProtected
afterDecrease the number of tasks that the given worker has applied.
+Hook executed after the worker task execution. +Can be overridden.
Worker whose tasks are decreased.
-Inherited from FixedClusterPool.decreaseWorkersTasks
-Inherited from FixedClusterPool.destroy
-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 overridden.
+Inherited from FixedClusterPool.destroyWorker
+The newly created worker.
+Inherited from FixedClusterPool.afterWorkerSetup
Protected
beforeHook executed before the worker task execution. +Can be overridden.
+Inherited from FixedClusterPool.execute
+The worker node key.
+The task to execute.
+Inherited from FixedClusterPool.beforeTaskExecutionHook
+Protected
createCreates a new dynamic worker and sets it up completely in the pool worker nodes.
+New, completely set up dynamic worker.
+ +Inherited from FixedClusterPool.createAndSetupDynamicWorker
+Protected
createCreates a new worker and sets it up completely in the pool worker nodes.
+New, completely set up worker.
+ +Inherited from FixedClusterPool.createAndSetupWorker
Protected
createInherited from FixedClusterPool.findFreeWorker
-Creates a new worker.
+Newly created worker.
+ +Inherited from FixedClusterPool.createWorker
+Inherited from FixedClusterPool.getWorkerIndex
-Terminates every current worker in this pool.
+Inherited from FixedClusterPool.destroy
+Protected
destroyTerminates the given worker.
+Inherited from FixedClusterPool.getWorkerRunningTasks
-Protected
increaseInherited from FixedClusterPool.destroyWorker
+Increase the number of tasks that the given worker has applied.
+Enables/disables the worker tasks queue in this pool.
Worker whose tasks are increased.
-Inherited from FixedClusterPool.increaseWorkersTask
-Protected
internalWhether to enable or disable the worker tasks queue.
+Optional
tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
+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.
+Inherited from FixedClusterPool.internalExecute
-Protected
internalPromise that will be fulfilled when the task is completed.
+ +Inherited from FixedClusterPool.execute
+Protected
internalInherited from FixedClusterPool.internalGetBusyStatus
-Protected
isWhether 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
sendSends a message to the given worker.
+The worker which should receive the message.
+Inherited from FixedClusterPool.registerWorkerMessageListener
-Protected
removeThe message.
+Inherited from FixedClusterPool.sendToWorker
+Removes the given worker from the pool.
+Sets the worker tasks queue options in this pool.
Worker that will be removed.
-Inherited from FixedClusterPool.removeWorker
-Protected
sendThe worker tasks queue options.
+Inherited from FixedClusterPool.setTasksQueueOptions
+Sets the worker choice strategy in this pool.
+The worker choice strategy.
+Inherited from FixedClusterPool.sendToWorker
+Optional
workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
+Inherited from FixedClusterPool.setWorkerChoiceStrategy
Sets the worker choice strategy options in this pool.
+Inherited from FixedClusterPool.setWorkerChoiceStrategy
-Protected
setupThe 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 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.
- -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.
+ +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