X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FDynamicClusterPool.html;h=8f1bd1a1e3e7ce58653880b74bbdfa7652694865;hb=0e502832d98443e291ea5558423ca0de86b96e13;hp=09bddee613cddcf688eac0525f44ba4128bb51e8;hpb=79458fb6e10234a237757111e710f8f71424fa06;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index 09bddee6..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
emitter{@inheritDoc}
-Protected
Readonly
maxMaximum number of workers that can be created by this pool.
-Inherited from FixedClusterPool.max
Readonly
numberProtected
Readonly
numberNumber of workers that this pool should manage.
-Inherited from FixedClusterPool.numberOfWorkers
Readonly
optsProtected
Readonly
optsOptions for this fixed cluster pool.
-Inherited from FixedClusterPool.opts
Protected
promiseThe promise response map.
+Protected
promiseThe task execution response promise map.
key
: The message id of each submitted task.value
: An object that contains the worker, the promise resolve and reject callbacks.value
: An object that contains the worker, the execution response promise resolve and reject callbacks.When we receive a message from the worker we get a map entry with the promise resolve/reject bound to the message.
-When we receive a message from the worker, we get a map entry with the promise resolve/reject bound to the message id.
+Inherited from FixedClusterPool.promiseResponseMap
Protected
workerWorker choice strategy instance implementing the worker choice algorithm.
-Default to a strategy implementing a round robin algorithm.
-Protected
workerWorker choice strategy context referencing a worker choice algorithm implementation.
+Inherited from FixedClusterPool.workerChoiceStrategyContext
Readonly
workers{@inheritDoc}
-Inherited from FixedClusterPool.workers
+Readonly
Internal
workerPool worker nodes.
+Inherited from FixedClusterPool.workerNodes
Protected
busy{@inheritDoc}
+Whether the pool is busy or not.
+The pool busyness boolean status.
Overrides FixedClusterPool.busy
Protected
full{@inheritDoc}
+Whether the pool is full or not.
+The pool filling boolean status.
Inherited from FixedClusterPool.numberOfRunningTasks
-Inherited from FixedClusterPool.full
+{@inheritDoc}
+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 worker.
-The worker node key.
+The received message.
-Inherited from FixedClusterPool.afterPromiseResponseHook
-Protected
afterInherited from FixedClusterPool.afterTaskExecutionHook
+Protected
after{@inheritDoc}
+Method 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 key.
-The worker node key.
+The task to execute.
+Inherited from FixedClusterPool.beforeTaskExecutionHook
+Protected
checkInherited from FixedClusterPool.beforePromiseResponseHook
+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 key, 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
create{@inheritDoc}
+Creates a new worker.
Newly created worker.
+ +Inherited from FixedClusterPool.createWorker
{@inheritDoc}
+Terminates all workers in this pool.
Inherited from FixedClusterPool.destroy
Protected
destroy{@inheritDoc}
+Terminates the worker node given its worker node key.
Inherited from FixedClusterPool.destroyWorker
-Inherited from FixedClusterPool.destroyWorkerNode
+{@inheritDoc}
+Enables/disables the worker node tasks queue in this pool.
Inherited from FixedClusterPool.execute
-Whether to enable or disable the worker node tasks queue.
+Optional
tasksQueueOptions: TasksQueueOptionsThe worker node tasks queue options.
+Inherited from FixedClusterPool.enableTasksQueue
+{@inheritDoc}
+Executes the specified function in the worker constructor with the task data input parameter.
+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.
Inherited from FixedClusterPool.findFreeWorkerKey
+Promise that will be fulfilled when the task is completed.
+ +Inherited from FixedClusterPool.execute
Protected
internalProtected
flushInherited from FixedClusterPool.internalGetBusyStatus
+Inherited from FixedClusterPool.flushTasksQueue
Protected
isProtected
get{@inheritDoc}
+Gets 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 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
register{@inheritDoc}
+Registers a listener callback on the worker given its worker node key.
The worker node key.
+The message listener callback.
+Inherited from FixedClusterPool.registerWorkerMessageListener
Protected
removeProtected
sendInherited from FixedClusterPool.sendKillMessageToWorker
+Protected
sendRemoves the given worker from the pool.
+Sends 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
send{@inheritDoc}
+Sends a message to worker given its worker node key.
The worker node key.
+The message.
+Inherited from FixedClusterPool.sendToWorker
{@inheritDoc}
+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
setup{@inheritDoc}
+Sets 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