X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FDynamicClusterPool.html;h=e2e7da263b2e264ccf64dbf2fd63d77edcfb8cb1;hb=aee467366d8c393b79e7af82c6a7ab12338ee64e;hp=77cdcd29be25504d72f3344b91605c6c7ea39394;hpb=a75da00c7b8dbbb148d2cf2472ce73e4201d9a4a;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index 77cdcd29..e2e7da26 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -18,7 +18,7 @@
Readonly
optsInherited from FixedClusterPool.opts
Protected
promiseInherited 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
{@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
Inherited from FixedClusterPool.afterPromiseResponseHook
Protected
after{@inheritDoc}
-Inherited from FixedClusterPool.afterWorkerSetup
Protected
beforeInherited 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 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.findFreeWorkerKey
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,7 +56,7 @@ When the maximum number of workers is reached, an event is emitted. If you wantemitter?
file Path
-max
+max
number Of Workers
opts
promise Response Map
@@ -66,7 +66,8 @@ When the maximum number of workers is reached, an event is emitted. If you want
busy
-number Of Running Tasks
+full
+number Of Running Tasks
type
@@ -81,7 +82,7 @@ When the maximum number of workers is reached, an event is emitted. If you want
destroy Worker
execute
find Free Worker Key
-internal Get Busy Status
+internal Busy
is Main
register Worker Message Listener
remove Worker
@@ -128,17 +129,17 @@ When the maximum number of workers is reached, an event is emitted. If you want
+Defined in src/pools/cluster/dynamic.ts:28
emitter?: PoolEmitter
-
+Defined in src/pools/abstract-pool.ts:32
Path
file Path: string
@@ -146,14 +147,14 @@ When the maximum number of workers is reached, an event is emitted. If you want
Properties
Accessors
Returns DynamicClusterPool<Data, Response>
Properties
Optional
Readonly
emitter{@inheritDoc}
-Readonly
fileInherited from FixedClusterPool.filePath
-- Defined in src/pools/abstract-pool.ts:67
+Protected
Readonly
maxPrivate
Readonly
maxMaximum number of workers that can be created by this pool.
-- Defined in src/pools/cluster/dynamic.ts:30
Readonly
numberInherited from FixedClusterPool.numberOfWorkers
-- Defined in src/pools/abstract-pool.ts:66