X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FDynamicClusterPool.html;h=0c403e1718a1a44878d560d15c650ccef0054297;hb=0bb3df76aeab8a2af9e99ccf91d9e9cc5e751674;hp=909eb463fafa2a8a77fd8217a6a920f8823018e5;hpb=65632d7d60a45877ab5a8fd02dae3d68eb9853db;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index 909eb463..0c403e17 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -1,4 +1,4 @@ -
Type of data sent to the worker. This can only be serializable data.
-Type of data sent to the worker. This can only be structured-cloneable data.
+Type of execution response. This can only be serializable data.
-Type of execution response. This can only be structured-cloneable data.
+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
emitterOptional
Readonly
emitterEmitter on which events can be listened to.
Events that can currently be listened to:
'full'
: Emitted when the pool is dynamic and full.'busy'
: Emitted when the pool is busy.'ready'
: Emitted when the number of workers created in the pool has reached the minimum size expected and are ready.'busy'
: Emitted when the number of workers created in the pool has reached the maximum size expected and are executing at least one task.'full'
: Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.destroy
': Emitted when the pool is destroyed.'error'
: Emitted when an uncaught error occurs.'taskError'
: Emitted when an error occurs while executing a task.'backPressure'
: Emitted when all worker nodes have back pressure (i.e. their tasks queue is full: queue size >= maximum queue size).Readonly
fileProtected
Readonly
filePath to the worker file.
-Readonly
maxProtected
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 execution response promise map.
+Protected
promiseThe task execution response promise map.
key
: The message id of each submitted task.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 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
Internal
workerPool worker nodes.
-Inherited from FixedClusterPool.workerNodes
Protected
busyProtected
busyWhether the pool is busy or not.
The pool busyness boolean status.
Overrides FixedClusterPool.busy
Protected
fullProtected
fullWhether the pool is full or not.
The pool filling boolean status.
Overrides FixedClusterPool.full
-Private
numberInherited 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
-Inherited from FixedClusterPool.maxSize
+Protected
minThe pool minimum size.
+Inherited from FixedClusterPool.minSize
+Private
readyPool type.
+The 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.
@@ -283,40 +368,45 @@ Can be overridden.The worker.
-The worker node key.
+The received message.
-Inherited from FixedClusterPool.afterTaskExecutionHook
Protected
afterProtected
afterFunction that can be hooked up when a worker has been newly created and moved to the pool worker nodes.
-Can be used to update the maxListeners
or binding the main-worker
<->worker
connection if not bind by default.
Method hooked up after a worker node has been newly created. +Can be overridden.
The newly created worker.
-Inherited from FixedClusterPool.afterWorkerSetup
-Protected
beforeInherited from FixedClusterPool.afterWorkerNodeSetup
+Protected
beforeThe task to execute.
+Inherited from FixedClusterPool.beforeTaskExecutionHook
Protected
chooseProtected
checkChooses a worker node for the next task.
-The default uses a round robin algorithm to distribute the load.
- -[worker node key, worker node].
-Inherited from FixedClusterPool.chooseWorkerNode
+Inherited from FixedClusterPool.checkDynamicPoolSize
Protected
createProtected
createCreates a new worker and sets it up completely in the pool worker nodes.
+Creates a new, completely set up dynamic worker node.
+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
createReturns a newly created worker.
+Creates a new worker.
Newly created worker.
+ +Inherited from FixedClusterPool.createWorker
Shutdowns every current worker in this pool.
+Terminates all workers in this pool.
Inherited from FixedClusterPool.destroy
Protected
destroyProtected
destroyShutdowns the given worker.
+Terminates the worker node given its worker node key.
A worker within workerNodes
.
Inherited from FixedClusterPool.destroyWorker
-The worker node key.
+Inherited from FixedClusterPool.destroyWorkerNode
+Enables/disables the worker tasks queue in this pool.
+Enables/disables the worker node tasks queue in this pool.
Whether to enable or disable the worker tasks queue.
-Whether to enable or disable the worker node tasks queue.
+Optional
tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
-Optional
tasksQueueOptions: TasksQueueOptionsThe worker node tasks queue options.
+Inherited from FixedClusterPool.enableTasksQueue
Executes the function specified in the worker constructor with the task data input parameter.
- -Promise that will be fulfilled when the task is completed.
+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 serializable data.
-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.flushTasksQueue
+Protected
getFinds a free worker node key based on the number of tasks the worker has applied.
-If a worker is found with 0
running tasks, it is detected as free and its worker node key is returned.
If no free worker is found, -1
is returned.
Gets the worker information given its worker node key.
+The worker node key.
+The worker information.
-A worker node key if there is one, -1
otherwise.
Inherited from FixedClusterPool.getWorkerInfo
+Internal
+Whether the worker node has back pressure (i.e. its tasks queue is full).
Inherited from FixedClusterPool.findFreeWorkerNodeKey
-Protected
internalThe 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
isProtected
isShould return whether the worker is the main worker or not.
Inherited from FixedClusterPool.isMain
Protected
registerLists the names of task function available in this pool.
+The names of task function available in this pool.
+ +Inherited from FixedClusterPool.listTaskFunctions
+Protected
registerRegisters a listener callback on the given worker.
+Registers a listener callback on the worker given its worker node key.
The worker which should register a listener.
-The worker node key.
+The message listener callback.
Inherited from FixedClusterPool.registerWorkerMessageListener
Protected
sendProtected
sendInherited from FixedClusterPool.sendKillMessageToWorker
+Protected
sendSends the startup message to worker given its worker node key.
+The worker node key.
+Inherited from FixedClusterPool.sendStartupMessageToWorker
+Protected
sendSends a message to the given worker.
+Sends a message to worker given its worker node key.
The worker which should receive the message.
-The worker node key.
+The message.
-Inherited from FixedClusterPool.sendToWorker
Sets the worker tasks queue options in this pool.
+Sets the worker node tasks queue options in this pool.
The worker tasks queue options.
-The worker node tasks queue options.
+Inherited from FixedClusterPool.setTasksQueueOptions
Sets the worker choice strategy in this pool.
The worker choice strategy.
-Optional
workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsOptional
workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
-Inherited from FixedClusterPool.setWorkerChoiceStrategy
Sets the worker choice strategy options in this pool.
The worker choice strategy options.
-Inherited from FixedClusterPool.setWorkerChoiceStrategyOptions
Protected
setupProtected
setupSetup hook to execute code before worker node are created in the abstract constructor. -Can be overridden
+Setup 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
.