X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FDynamicClusterPool.html;h=a42be2e59ed2533434f53f77419ebc8375e14bf1;hb=507628c63a572335e0d852256fdac48cc2e52fa4;hp=ad510028a372d4cc16cff5cda8b1d5f17f73bee4;hpb=74f29142ea20199700ef7021402616ea9de714a8;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index ad510028..a42be2e5 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -1,4 +1,4 @@ -
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
Readonly
maxMaximum number of workers that can be created by this pool.
-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
workerProtected
workerWorker choice strategy context referencing a worker choice algorithm implementation.
-Default to a round robin algorithm.
-Inherited from FixedClusterPool.workerChoiceStrategyContext
Readonly
workerReadonly
workerPool worker nodes.
+Inherited from FixedClusterPool.workerNodes
Protected
busyWhether the pool is busy or not.
+The pool busyness boolean status.
+Overrides FixedClusterPool.busy
Protected
fullOverrides FixedClusterPool.full
-Private
numberWhether the pool is full or not.
+The pool filling boolean status.
+Inherited from FixedClusterPool.full
+Number of tasks queued in the pool.
+Pool information.
Inherited from FixedClusterPool.numberOfQueuedTasks
-Private
numberInherited from FixedClusterPool.info
+Protected
maxNumber of tasks running in the pool.
+The pool maximum size.
Inherited from FixedClusterPool.numberOfRunningTasks
-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 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
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 node key.
-The task to execute.
+Inherited from FixedClusterPool.beforeTaskExecutionHook
+Protected
checkInherited from FixedClusterPool.beforePromiseResponseHook
+Inherited from FixedClusterPool.checkDynamicPoolSize
Protected
chooseProtected
createChooses a worker node for the next task.
-The default uses a round robin algorithm to distribute the load.
- -[worker node key, worker node].
+Creates a new, completely set up dynamic worker node.
Inherited from FixedClusterPool.chooseWorkerNode
-Protected
createCreates a new worker and sets it up completely in the pool worker nodes.
+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
Protected
dequeueInherited from FixedClusterPool.dequeueTask
-Terminates all workers in this pool.
+Inherited from FixedClusterPool.destroy
Protected
destroyTerminates the worker node given its worker node key.
+Inherited from FixedClusterPool.destroyWorker
-Protected
enqueueInherited from FixedClusterPool.destroyWorkerNode
+Enables/disables the worker tasks queue in this pool.
+Whether to enable or disable the worker tasks queue.
+Inherited from FixedClusterPool.enqueueTask
-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 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
Inherited from FixedClusterPool.findFreeWorkerNodeKey
-Protected
flushProtected
flushInherited from FixedClusterPool.flushTasksQueue
Protected
flushProtected
getGets the worker information given its worker node key.
+Inherited from FixedClusterPool.flushTasksQueueByWorker
-Protected
internalThe worker information.
+ +Inherited from FixedClusterPool.getWorkerInfo
+Protected
internalWhether worker nodes are executing concurrently their tasks quota or not.
+Worker nodes busyness boolean status.
+ +Inherited from FixedClusterPool.internalBusy
Protected
isProtected
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
sendInherited from FixedClusterPool.sendKillMessageToWorker
+Protected
sendRemoves the given worker from the pool worker nodes.
+Sends the startup message to worker given its worker node key.
The worker.
-Inherited from FixedClusterPool.removeWorkerNode
-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.
+Inherited from FixedClusterPool.setWorkerChoiceStrategy
-Protected
setupInherited from FixedClusterPool.setTasksQueueOptions
+Inherited from FixedClusterPool.setupHook
+Sets the worker choice strategy in this pool.
+The worker choice strategy.
+Optional
workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
+Inherited from FixedClusterPool.setWorkerChoiceStrategy
Protected
tasksSets the worker choice strategy options in this pool.
+Inherited from FixedClusterPool.tasksQueueLength
+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 message.
- -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 message.
- -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 and workers are busy, an event is emitted. If you want to listen to this event, use the pool's
+emitter
.