X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FDynamicClusterPool.html;h=4c52051dbdaeb51f9b1d96183e4b4ca914536052;hb=3abeb14de6a5845deeb027ccc69c3feeec8f4a3a;hp=72689ccd9e8dcde7d2904ba2a6c0a9e280c5ee14;hpb=e1230e386080ae19766e2a7863c807a90f13a3ef;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index 72689ccd..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
emitter{@inheritDoc}
-Protected
Readonly
maxMaximum number of workers that can be created by this pool.
-Protected
nextId of the next message.
-Inherited from FixedClusterPool.nextMessageId
-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 map.
+Protected
promiseThe execution response promise map.
key
: This is the message Id of each submitted task.value
: An object that contains the worker, the resolve function and the reject function.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 and resolve/reject the promise based on the message.
-Inherited from FixedClusterPool.promiseMap
-Protected
workerWorker choice strategy instance implementing the worker choice algorithm.
-Default to a strategy implementing a round robin algorithm.
-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 context referencing a worker choice algorithm implementation.
+Inherited from FixedClusterPool.workerChoiceStrategyContext
Readonly
workers{@inheritDoc}
-Inherited from FixedClusterPool.workers
-Readonly
workers{@inheritDoc}
-Inherited from FixedClusterPool.workersTasksUsage
-Readonly
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
+Pool information.
+Inherited from FixedClusterPool.info
+Protected
maxPool maximum size.
+Overrides FixedClusterPool.maxSize
+Protected
min{@inheritDoc}
+Pool 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 received message.
-The worker.
+The Promise response.
-Inherited from FixedClusterPool.afterPromiseWorkerResponseHook
-Protected
afterThe received message.
+Inherited from FixedClusterPool.afterTaskExecutionHook
+Protected
after{@inheritDoc}
+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 promise resolution. +
Hook executed before the worker task execution. Can be overridden.
The worker.
-Inherited from FixedClusterPool.beforePromiseWorkerResponseHook
-Protected
chooseChooses a worker for the next task.
-The default implementation uses a round robin algorithm to distribute the load.
- -Worker.
+The worker node key.
Inherited from FixedClusterPool.chooseWorker
-Protected
createThe task to execute.
+Inherited from FixedClusterPool.beforeTaskExecutionHook
+Protected
createCreates a new worker for this pool and sets it up completely.
+Creates a new dynamic worker and sets it up completely in the pool worker nodes.
+New, completely set up dynamic worker.
-New, completely set up 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.
+ +Inherited from FixedClusterPool.createAndSetupWorker
Protected
createProtected
create{@inheritDoc}
+Creates a new worker.
Newly created worker.
+ +Inherited from FixedClusterPool.createWorker
{@inheritDoc}
+Terminates every current worker in this pool.
Inherited from FixedClusterPool.destroy
Protected
destroy{@inheritDoc}
+Terminates the given worker.
A worker within workerNodes
.
Inherited from FixedClusterPool.destroyWorker
{@inheritDoc}
+Enables/disables the worker tasks queue in this pool.
Inherited from FixedClusterPool.execute
-{@inheritDoc}
-Inherited from FixedClusterPool.findFreeWorker
-{@inheritDoc}
+Whether to enable or disable the worker tasks queue.
Inherited from FixedClusterPool.getWorkerAverageTasksRunTime
-Optional
tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
+Inherited from FixedClusterPool.enableTasksQueue
+{@inheritDoc}
+Executes the specified function in the worker constructor with the task data input parameter.
Inherited from FixedClusterPool.getWorkerIndex
-{@inheritDoc}
+Optional
data: DataThe task input data for the specified worker function. This can only be structured-cloneable data.
Inherited from FixedClusterPool.getWorkerRunningTasks
-Protected
internalPromise that will be fulfilled when the task is completed.
+ +Inherited from FixedClusterPool.execute
+Protected
internalInherited from FixedClusterPool.internalGetBusyStatus
-Protected
isWhether worker nodes are executing at least one task.
+Worker nodes busyness boolean status.
+ +Inherited from FixedClusterPool.internalBusy
+Protected
is{@inheritDoc}
+Should return whether the worker is the main worker or not.
Inherited from FixedClusterPool.isMain
Protected
send{@inheritDoc}
+Sends a message to the given worker.
The worker which should receive the message.
+Inherited from FixedClusterPool.registerWorkerMessageListener
-Protected
removeThe message.
+Inherited from FixedClusterPool.sendToWorker
+Removes the given worker from the pool.
+Sets the worker tasks queue options in this pool.
The worker that will be removed.
-Inherited from FixedClusterPool.removeWorker
-Protected
sendThe worker tasks queue options.
+Inherited from FixedClusterPool.setTasksQueueOptions
+{@inheritDoc}
+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
{@inheritDoc}
+Sets the worker choice strategy options in this pool.
Inherited from FixedClusterPool.setWorkerChoiceStrategy
-Protected
setupThe worker choice strategy options.
+Inherited from FixedClusterPool.setWorkerChoiceStrategyOptions
+Protected
setup{@inheritDoc}
+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.
- -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 function is the listener registered for each 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.
+ +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, 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