X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=docs%2Fclasses%2FDynamicClusterPool.html;h=5f346787bea4cbc0136c612864f6cfee22e741b3;hb=027063571693f211b35c8851566a063201adb9af;hp=c2a71928d2e7e05a2fd0822e52d4553862b13786;hpb=7cd8af0033b35def46016a78ea9be1ee516480bf;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index c2a71928..5f346787 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -1,4 +1,4 @@ -
Options for this dynamic cluster pool.
Optional
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.Inherited from FixedClusterPool.emitter
Readonly
fileInherited from FixedClusterPool.filePath
Readonly
maxMaximum number of workers that can be created by this pool.
Readonly
numberInherited from FixedClusterPool.numberOfWorkers
Readonly
optsInherited from FixedClusterPool.opts
Protected
promiseThe promise response map.
+ +The 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
workerWorker choice strategy context referencing a worker choice algorithm implementation.
Default to a round robin algorithm.
Inherited from FixedClusterPool.workerChoiceStrategyContext
Readonly
workersInherited from FixedClusterPool.workers
+Readonly
workerPool worker nodes.
+Inherited from FixedClusterPool.workerNodes
Protected
busyWhether the pool is busy or not.
+The pool busyness boolean status.
+Overrides FixedClusterPool.busy
Protected
fullWhether the pool is full or not.
+The pool filling boolean status.
+Overrides FixedClusterPool.full
Private
numberNumber of tasks queued in the pool.
+Inherited from FixedClusterPool.numberOfQueuedTasks
+Private
numberNumber of tasks concurrently running in the pool.
+Number of tasks running in the pool.
Inherited from FixedClusterPool.numberOfRunningTasks
Pool type.
+If it is 'dynamic'
, it provides the max
property.
Overrides FixedClusterPool.type
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
+Inherited 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 used to update the maxListeners
or binding the main-worker
<->worker
connection if not bind by default.
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 key.
+The worker node key.
Inherited from FixedClusterPool.beforePromiseResponseHook
+Inherited from FixedClusterPool.beforeTaskExecutionHook
Protected
chooseProtected
chooseChooses a worker for the next task.
+Chooses a worker node for the next task.
The default uses a round robin algorithm to distribute the load.
-[worker key, worker].
+[worker node key, worker node].
Inherited from FixedClusterPool.chooseWorker
+Inherited from FixedClusterPool.chooseWorkerNode
Protected
createCreates a new worker for this pool and sets it up completely.
+Creates a new worker and sets it up completely in the pool worker nodes.
New, completely set up worker.
Inherited from FixedClusterPool.createAndSetupWorker
Protected
createReturns a newly created worker.
+Inherited from FixedClusterPool.createWorker
Shutdowns every current worker in this pool.
+Inherited from FixedClusterPool.destroy
Protected
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.
+The input for the specified task. This can only be serializable data.
+Inherited from FixedClusterPool.execute
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.
Inherited from FixedClusterPool.findFreeWorkerKey
+Inherited from FixedClusterPool.findFreeWorkerNodeKey
Protected
internalInherited from FixedClusterPool.internalBusy
Protected
isShould return whether the worker is the main worker or not.
+Inherited from FixedClusterPool.isMain
Protected
registerRegisters a listener callback on the given worker.
+The worker which should register a listener.
+The message listener callback.
+Inherited from FixedClusterPool.registerWorkerMessageListener
Protected
removeRemoves the given worker from the pool.
-The worker that will be removed.
-Inherited from FixedClusterPool.removeWorker
-Protected
sendSends a message to the given worker.
+The worker which should receive the message.
+The message.
+Inherited from FixedClusterPool.sendToWorker
Sets the worker choice strategy in this pool.
+The worker choice strategy.
+Inherited from FixedClusterPool.setWorkerChoiceStrategy
Protected
setupSetup hook to execute code before worker node are created in the abstract constructor. +Can be overridden
+Inherited from FixedClusterPool.setupHook
Protected
workerThis function is the listener registered for each 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.
+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
Constructs a new poolifier dynamic cluster pool.