X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FDynamicClusterPool.html;h=e2e7da263b2e264ccf64dbf2fd63d77edcfb8cb1;hb=aee467366d8c393b79e7af82c6a7ab12338ee64e;hp=76a15e97be8519bfaa041890ed7f46a001edca14;hpb=cfc6e8df4c903b63514c46cb67b3f5e24079d3ce;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index 76a15e97..e2e7da26 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -18,7 +18,7 @@
Readonly
optsOptions for this fixed cluster pool.
Inherited from FixedClusterPool.opts
Protected
promiseThe promise map.
+Protected
promiseThe promise response 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 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.
+When we receive a message from the worker we get a map entry with the promise resolve/reject bound to the message.
Inherited from FixedClusterPool.promiseMap
+Inherited from FixedClusterPool.promiseResponseMap
Protected
workerWorker choice strategy instance implementing the worker choice algorithm.
-Default to a strategy implementing a round robin algorithm.
+Worker choice strategy context referencing a worker choice algorithm implementation.
+Default to a round robin algorithm.
Inherited from FixedClusterPool.workerChoiceStrategyContext
Readonly
workers{@inheritDoc}
-Inherited from FixedClusterPool.workers
Readonly
workers{@inheritDoc}
-Inherited from FixedClusterPool.workersTasksUsage
-{@inheritDoc}
-Overrides FixedClusterPool.busy
Overrides FixedClusterPool.full
+Private
number{@inheritDoc}
+Number of tasks concurrently running in the pool.
Inherited from FixedClusterPool.numberOfRunningTasks
{@inheritDoc}
-Overrides FixedClusterPool.type
Protected
afterProtected
afterHook executed after the worker task promise resolution. Can be overridden.
@@ -270,24 +261,24 @@ Can be overridden.The received message.
+The worker.
The Promise response.
+The received message.
Inherited from FixedClusterPool.afterPromiseWorkerResponseHook
+Inherited from FixedClusterPool.afterPromiseResponseHook
Protected
after{@inheritDoc}
-Inherited from FixedClusterPool.afterWorkerSetup
Protected
beforeProtected
beforeHook executed before the worker task promise resolution. Can be overridden.
@@ -309,27 +300,27 @@ Can be overridden.The worker.
+The worker key.
Inherited from FixedClusterPool.beforePromiseWorkerResponseHook
+Inherited from FixedClusterPool.beforePromiseResponseHook
Protected
chooseChooses a worker for the next task.
-The default implementation uses a round robin algorithm to distribute the load.
+The default uses a round robin algorithm to distribute the load.
-Worker.
+[worker key, worker].
Inherited from FixedClusterPool.chooseWorker
Protected
createInherited from FixedClusterPool.createAndSetupWorker
Protected
create{@inheritDoc}
-Inherited from FixedClusterPool.createWorker
{@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
+Inherited from FixedClusterPool.findFreeWorkerKey
{@inheritDoc}
-Inherited from FixedClusterPool.getWorkerRunningTasks
-Protected
internalProtected
internalInherited from FixedClusterPool.internalGetBusyStatus
+Inherited from FixedClusterPool.internalBusy
Protected
is{@inheritDoc}
-Inherited from FixedClusterPool.isMain
{@inheritDoc}
-Inherited from FixedClusterPool.registerWorkerMessageListener
Protected
removeInherited 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
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
+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
.emitter
.Author
Christopher Quadflieg
@@ -42,7 +42,7 @@ When the maximum number of workers is reached, an event is emitted. If you want@@ -56,37 +56,33 @@ When the maximum number of workers is reached, an event is emitted. If you wantemitter?
file Path
-max
-next Message Id
+max
number Of Workers
opts
-promise Map
+promise Response Map
worker Choice Strategy Context
workers
-workers Tasks Usage
Properties
Accessors
Methods
-Path to an implementation of a
ClusterWorker
file, which can be relative or absolute.opts: ClusterPoolOptions = EMPTY_OBJECT_LITERAL
+opts: ClusterPoolOptions = {}
Options for this dynamic cluster pool.
Returns DynamicClusterPool<Data, Response>
+Properties
Optional
Readonly
emitter{@inheritDoc}
-Readonly
fileInherited from FixedClusterPool.filePath
-- Defined in src/pools/abstract-pool.ts:80
+Protected
Readonly
maxPrivate
Readonly
maxMaximum number of workers that can be created by this pool.
-- Defined in src/pools/cluster/dynamic.ts:31
Message Id
-Protected
nextId of the next message.
-Inherited from FixedClusterPool.nextMessageId
--- Defined in src/pools/abstract-pool.ts:58
Readonly
numberInherited from FixedClusterPool.numberOfWorkers
-- Defined in src/pools/abstract-pool.ts:79