X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FDynamicClusterPool.html;h=de3365bb6a6b661d1426de672c8d9d6104be3001;hb=a6d9dccfaf39e185c896747260d668fcb683a8ed;hp=3e421373a21db07a80264558cd01a3a152be85b9;hpb=b45edd35eec0fb1d5fd8fa979ff00f17f4e3c24e;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index 3e421373..de3365bb 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -1,4 +1,4 @@ -
Readonly
filePath to the worker-file.
-Protected
Readonly
filePath to the worker file.
+Readonly
maxProtected
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
promiseProtected
promiseThe 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
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.
+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
Protected
workerGets the worker type.
+Inherited from FixedClusterPool.worker
+Protected
afterProtected
afterHook executed after the worker task execution. Can be overridden.
@@ -280,40 +329,45 @@ Can be overridden.The worker.
-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.
Function 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 execution. Can be overridden.
@@ -322,258 +376,303 @@ Can be overridden.The worker node key.
-The task to execute.
+Inherited from FixedClusterPool.beforeTaskExecutionHook
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 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
createReturns a newly created worker.
+Creates a new worker.
Newly created worker.
+ +Inherited from FixedClusterPool.createWorker
Shutdowns every current worker in this pool.
+Terminate every current worker in this pool.
Inherited from FixedClusterPool.destroy
Protected
destroyProtected
destroyInherited from FixedClusterPool.destroyWorker
Performs the task specified in the constructor with the data parameter.
- -Promise that will be resolved when the task is successfully completed.
+Enables/disables the worker tasks queue in this pool.
The input for the specified task. This can only be serializable data.
-Inherited from FixedClusterPool.execute
-Whether to enable or disable the worker tasks queue.
+Optional
tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
+Inherited from FixedClusterPool.enableTasksQueue
+Finds 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.
A worker node key if there is one, -1
otherwise.
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.
Inherited from FixedClusterPool.findFreeWorkerNodeKey
+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
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
registerProtected
sendRegisters a listener callback on the given worker.
+Sends a message to the given worker.
The worker which should register a listener.
-The worker which should receive the message.
+The message listener callback.
+The message.
Inherited from FixedClusterPool.sendToWorker
+Sets the worker tasks queue options in this pool.
+Inherited from FixedClusterPool.registerWorkerMessageListener
-Protected
sendThe worker tasks queue options.
+Inherited from FixedClusterPool.setTasksQueueOptions
+Sends a message to the given worker.
+Sets the worker choice strategy in this pool.
The worker which should receive the message.
-The worker choice strategy.
+The message.
-Inherited from FixedClusterPool.sendToWorker
+Optional
workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
+Inherited from FixedClusterPool.setWorkerChoiceStrategy
Sets the worker choice strategy in this pool.
+Sets the worker choice strategy options in this pool.
The worker choice strategy.
-Inherited from FixedClusterPool.setWorkerChoiceStrategy
-Protected
setupThe worker choice strategy options.
+Inherited from FixedClusterPool.setWorkerChoiceStrategyOptions
+Protected
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.
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
.