X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FDynamicClusterPool.html;h=0a537f5fc23a9f2b64d36ae71c21a33bb122d696;hb=797996a92f40d5779cd31314b59462e41d529989;hp=80576199ce10c7c89f64b236a836a750f5a942bd;hpb=a76fac14098cf2138cf8d6997ac7c89d8c3ae508;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index 80576199..0a537f5f 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -1,11 +1,13 @@
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
.
of data sent to the worker. This can only be serializable data.
- -of response of execution. This can only be serializable data.
-2.0.0
@@ -30,9 +28,13 @@ When the maximum number of workers is reached, an event is emitted. If you wantType of response of execution. This can only be serializable data.
+Constructs a new poolifier dynamic cluster pool.
Path to an implementation of a ClusterWorker
file, which can be relative or absolute.
Optional
opts: ClusterPoolOptions = {}Options for this dynamic cluster pool.
Optional
Readonly
emitterReadonly
filePath to the worker-file.
+Inherited from FixedClusterPool.filePath
Readonly
maxProtected
Readonly
maxInherited from FixedClusterPool.max
+Maximum number of workers that can be created by this pool.
+Protected
nextInherited from FixedClusterPool.nextMessageId
Readonly
numberNumber of workers that this pool should manage.
+Inherited from FixedClusterPool.numberOfWorkers
Readonly
optsOptions for this fixed cluster pool.
+Inherited from FixedClusterPool.opts
Protected
promiseInherited from FixedClusterPool.promiseMap
Readonly
tasksInherited from FixedClusterPool.tasks
-Protected
workerInherited from FixedClusterPool.workerChoiceStrategyContext
Readonly
workers{@inheritDoc}
+Inherited from FixedClusterPool.workers
Readonly
workers{@inheritDoc}
+Inherited from FixedClusterPool.workersTasksUsage
+{@inheritDoc}
+Overrides FixedClusterPool.busy
{@inheritDoc}
+Inherited from FixedClusterPool.numberOfRunningTasks
{@inheritDoc}
+Overrides FixedClusterPool.type
Protected
afterHook executed after the worker task promise resolution. +Can be overridden.
+The received message.
+The Promise response.
+Inherited from FixedClusterPool.afterPromiseWorkerResponseHook
+Protected
after{@inheritDoc}
+Inherited from FixedClusterPool.afterWorkerSetup
Protected
beforeHook executed before the worker task promise resolution. +Can be overridden.
+The worker.
+Inherited from FixedClusterPool.beforePromiseWorkerResponseHook
+Protected
chooseChoose a worker for the next task.
+Chooses a worker for the next task.
The default implementation uses a round robin algorithm to distribute the load.
Worker.
@@ -280,7 +329,7 @@ When the maximum number of workers is reached, an event is emitted. If you wantInherited from FixedClusterPool.chooseWorker
Protected
createInherited from FixedClusterPool.createAndSetupWorker
Protected
create{@inheritDoc}
+Inherited from FixedClusterPool.createWorker
Protected
decreaseDecrease the number of tasks that the given worker has applied.
-Worker whose tasks are decreased.
-Inherited from FixedClusterPool.decreaseWorkersTasks
-{@inheritDoc}
+Inherited from FixedClusterPool.destroy
{@inheritDoc}
+Inherited from FixedClusterPool.destroyWorker
{@inheritDoc}
+Inherited from FixedClusterPool.execute
{@inheritDoc}
+Inherited from FixedClusterPool.findFreeWorker
{@inheritDoc}
+Inherited from FixedClusterPool.getWorkerAverageTasksRunTime
+{@inheritDoc}
+Inherited from FixedClusterPool.getWorkerIndex
{@inheritDoc}
+Inherited from FixedClusterPool.getWorkerRunningTasks
Protected
increaseIncrease the number of tasks that the given worker has applied.
-Worker whose tasks are increased.
-Inherited from FixedClusterPool.increaseWorkersTask
-Protected
internalInherited from FixedClusterPool.internalExecute
-Protected
internalInherited from FixedClusterPool.internalGetBusyStatus
Protected
is{@inheritDoc}
+Inherited from FixedClusterPool.isMain
{@inheritDoc}
+Inherited from FixedClusterPool.registerWorkerMessageListener
Protected
removeWorker that will be removed.
+The worker that will be removed.
Inherited from FixedClusterPool.removeWorker
Protected
send{@inheritDoc}
+Inherited from FixedClusterPool.sendToWorker
{@inheritDoc}
+Inherited from FixedClusterPool.setWorkerChoiceStrategy
Protected
setup{@inheritDoc}
+Inherited from FixedClusterPool.setupHook
Protected
workerInherited from FixedClusterPool.workerListener
Type of data sent to the worker. This can only be serializable data.
+