X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FDynamicClusterPool.html;h=4c52051dbdaeb51f9b1d96183e4b4ca914536052;hb=3abeb14de6a5845deeb027ccc69c3feeec8f4a3a;hp=d12c5c0ec1fd026208c99d09e4515a5b1572ece6;hpb=1b0aa06b3ab5cf8ae8bd135087143165889901cc;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index d12c5c0e..4c52051d 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 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.
+Pool maximum size.
Inherited from FixedClusterPool.numberOfRunningTasks
-Overrides FixedClusterPool.maxSize
+Protected
minPool minimum size.
+Inherited from FixedClusterPool.minSize
+Protected
typePool type.
+If it is 'dynamic'
, it provides the max
property.
Overrides FixedClusterPool.type
Private
utilizationGets the approximate pool utilization.
+The pool utilization.
+ +Inherited from FixedClusterPool.utilization
+Protected
workerGets the 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 received message.
-Inherited from FixedClusterPool.afterPromiseResponseHook
-Protected
afterInherited 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.
+The newly created worker.
+Inherited from FixedClusterPool.afterWorkerSetup
Protected
beforeProtected
beforeHook executed before the worker task promise resolution. +
Hook executed before the worker task execution. Can be overridden.
The worker node key.
-Inherited from FixedClusterPool.beforePromiseResponseHook
-Protected
chooseThe task to execute.
+Inherited from FixedClusterPool.beforeTaskExecutionHook
+Protected
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 dynamic worker and sets it up completely in the pool worker nodes.
Inherited from FixedClusterPool.chooseWorkerNode
-Protected
createNew, 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.
New, completely set up worker.
+ +Inherited from FixedClusterPool.createAndSetupWorker
Protected
createProtected
createCreates a new worker.
+Newly created worker.
+ +Inherited from FixedClusterPool.createWorker
Protected
dequeueInherited from FixedClusterPool.dequeueTask
-Terminates every current worker in this pool.
+Inherited from FixedClusterPool.destroy
Protected
destroyInherited from FixedClusterPool.destroyWorker
Protected
enqueueEnables/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 task input data for the specified worker function. This can only be structured-cloneable data.
+Optional
name: stringThe name of the worker function to execute. If not specified, the default worker function will be executed.
+Promise that will be fulfilled when the task is completed.
+ +Inherited from FixedClusterPool.execute
Inherited from FixedClusterPool.findFreeWorkerNodeKey
-Protected
flushInherited from FixedClusterPool.flushTasksQueue
-Protected
flushInherited from FixedClusterPool.flushTasksQueueByWorker
-Protected
internalProtected
internalWhether worker nodes are executing at least one task.
+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
sendSends a message to the given worker.
+The worker which should receive the message.
+Inherited from FixedClusterPool.registerWorkerMessageListener
-Protected
removeInherited from FixedClusterPool.sendToWorker
+Removes the given worker from the pool worker nodes.
+Sets the worker tasks queue options in this pool.
The worker.
-Inherited from FixedClusterPool.removeWorkerNode
-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
tasksInherited from FixedClusterPool.tasksQueueLength
-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.
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.
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
.