X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FDynamicClusterPool.html;h=8f1bd1a1e3e7ce58653880b74bbdfa7652694865;hb=0e502832d98443e291ea5558423ca0de86b96e13;hp=c32a3c747c89baab5c9a71e97db9b82418cb2c1f;hpb=b08b5fc507f21848c9435380edb7d155e92eaaf5;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index c32a3c74..10e968f8 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -1,15 +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.
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.
+Inherited from 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 promise resolution. +
Hook executed after the worker task execution. Can be overridden.
The received message.
-The worker node key.
+The Promise response.
-Inherited from FixedClusterPool.afterPromiseWorkerResponseHook
-Protected
afterThe received message.
+Inherited from FixedClusterPool.afterTaskExecutionHook
+Protected
afterMethod hooked up after a worker node has been newly created. +Can be overridden.
+Inherited from FixedClusterPool.afterWorkerSetup
-Protected
beforeInherited from FixedClusterPool.afterWorkerNodeSetup
+Protected
beforeHook executed before the worker task promise resolution. +
Hook executed before the worker task execution. Can be overridden.
The worker.
-The worker node key.
+The task to execute.
+Inherited from FixedClusterPool.beforeTaskExecutionHook
+Protected
checkInherited from FixedClusterPool.beforePromiseWorkerResponseHook
+Inherited from FixedClusterPool.checkDynamicPoolSize
Protected
chooseProtected
createChooses a worker for the next task.
-The default implementation uses a round robin algorithm to distribute the load.
- -Worker.
+Creates a new, completely set up dynamic worker node.
Inherited from FixedClusterPool.chooseWorker
-Protected
createCreates a new worker for this pool and sets it up completely.
+New, completely set up dynamic worker node key.
-New, completely set up worker.
+Inherited from FixedClusterPool.createAndSetupDynamicWorkerNode
+Protected
createCreates a new, completely set up worker node.
Inherited from FixedClusterPool.createAndSetupWorker
-Protected
createNew, 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.destroyWorker
-Inherited from FixedClusterPool.destroyWorkerNode
+Enables/disables the worker node tasks queue in this pool.
+Inherited from FixedClusterPool.execute
-Inherited from FixedClusterPool.findFreeWorker
-Whether to enable or disable the worker node tasks queue.
+Optional
tasksQueueOptions: TasksQueueOptionsThe worker node tasks queue options.
+Inherited from FixedClusterPool.enableTasksQueue
+Executes the specified function in the worker constructor with the task data input parameter.
+Inherited from FixedClusterPool.getWorkerAverageTasksRunTime
+Optional
data: DataThe optional task input data for the specified task function. This can only be structured-cloneable data.
+Optional
name: stringThe optional name of the task function to execute. If not specified, the default task function will be executed.
+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.
+Promise that will be fulfilled when the task is completed.
+ +Inherited from FixedClusterPool.execute
Protected
flushInherited from FixedClusterPool.getWorkerIndex
+Inherited from FixedClusterPool.flushTasksQueue
Protected
getGets the worker information given its worker node key.
+Inherited from FixedClusterPool.getWorkerRunningTasks
-Protected
internalThe 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).
+Inherited from FixedClusterPool.internalExecute
-Protected
internaltrue
if the worker node has back pressure, false
otherwise.
Inherited from FixedClusterPool.hasWorkerNodeBackPressure
+Protected
internalInherited from FixedClusterPool.internalGetBusyStatus
-Protected
isWhether worker nodes are executing concurrently their tasks quota or not.
+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
Lists the names of task function available in this pool.
+The names of task function available in this pool.
+ +Inherited from FixedClusterPool.listTaskFunctions
+Protected
registerThe worker node key.
+The message listener callback.
+Inherited from FixedClusterPool.registerWorkerMessageListener
Protected
removeProtected
sendRemoves the given worker from the pool.
+Inherited from FixedClusterPool.sendKillMessageToWorker
+Protected
sendSends the startup message to worker given its worker node key.
The 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 node tasks queue options in this pool.
+The worker node 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
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
.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