X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicThreadPool.html;h=75da6d76187e524ab93943581bb7d79a573e2b97;hb=7cd8af0033b35def46016a78ea9be1ee516480bf;hp=66ad9b5b6dc400a2edc002a84b78044da6559b57;hpb=a75da00c7b8dbbb148d2cf2472ce73e4201d9a4a;p=poolifier.git diff --git a/docs/classes/DynamicThreadPool.html b/docs/classes/DynamicThreadPool.html index 66ad9b5b..75da6d76 100644 --- a/docs/classes/DynamicThreadPool.html +++ b/docs/classes/DynamicThreadPool.html @@ -18,7 +18,7 @@
Readonly
optsInherited from FixedThreadPool.opts
Protected
promiseInherited from FixedThreadPool.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 FixedThreadPool.workerChoiceStrategyContext
Readonly
workers{@inheritDoc}
-Inherited from FixedThreadPool.workers
{@inheritDoc}
-Overrides FixedThreadPool.busy
Overrides FixedThreadPool.full
+Private
number{@inheritDoc}
+Number of tasks concurrently running in the pool.
Inherited from FixedThreadPool.numberOfRunningTasks
{@inheritDoc}
-Overrides FixedThreadPool.type
Inherited from FixedThreadPool.afterPromiseResponseHook
Protected
after{@inheritDoc}
-Inherited from FixedThreadPool.afterWorkerSetup
Protected
beforeInherited from FixedThreadPool.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 FixedThreadPool.chooseWorker
Protected
createInherited from FixedThreadPool.createAndSetupWorker
Protected
create{@inheritDoc}
-Inherited from FixedThreadPool.createWorker
{@inheritDoc}
-Inherited from FixedThreadPool.destroy
{@inheritDoc}
-Inherited from FixedThreadPool.destroyWorker
{@inheritDoc}
-Inherited from FixedThreadPool.execute
{@inheritDoc}
-Inherited from FixedThreadPool.findFreeWorkerKey
Protected
internalProtected
internalInherited from FixedThreadPool.internalGetBusyStatus
+Inherited from FixedThreadPool.internalBusy
Protected
is{@inheritDoc}
-Inherited from FixedThreadPool.isMain
{@inheritDoc}
-Inherited from FixedThreadPool.registerWorkerMessageListener
Protected
removeInherited from FixedThreadPool.removeWorker
Protected
send{@inheritDoc}
-Inherited from FixedThreadPool.sendToWorker
{@inheritDoc}
-Inherited from FixedThreadPool.setWorkerChoiceStrategy
Protected
setupSetup hook that can be overridden by a Poolifier pool implementation -to run code before workers are created in the abstract constructor.
+to run code before workers are created in the abstract constructor. +Can be overriddenInherited from FixedThreadPool.setupHook
Protected
workerInherited from FixedThreadPool.workerListener
A thread pool with a dynamic number of threads, but a guaranteed minimum number of threads.
This thread pool creates new threads when the others are busy, up to the maximum number of threads. -When the maximum number of threads is reached, an event is emitted. If you want to listen to this event, use the pool's
+When the maximum number of threads is reached and workers are busy, an event is emitted. If you want to listen to this event, use the pool'semitter
.emitter
.Author
Alessandro Pio Ardizio
@@ -42,7 +42,7 @@ When the maximum number of threads is reached, an event is emitted. If you want@@ -56,7 +56,7 @@ When the maximum number of threads 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 threads 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 threads 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 threads is reached, an event is emitted. If you want
+Defined in src/pools/thread/dynamic.ts:29
emitter?: PoolEmitter
-
+Defined in src/pools/abstract-pool.ts:32
Path
file Path: string
@@ -146,14 +147,14 @@ When the maximum number of threads is reached, an event is emitted. If you want
Properties
Accessors
Returns DynamicThreadPool<Data, Response>
Properties
Optional
Readonly
emitter{@inheritDoc}
-Readonly
fileInherited from FixedThreadPool.filePath
-- Defined in src/pools/abstract-pool.ts:67
+Protected
Readonly
maxReadonly
maxMaximum number of threads that can be created by this pool.
-- Defined in src/pools/thread/dynamic.ts:31
Readonly
numberInherited from FixedThreadPool.numberOfWorkers
-- Defined in src/pools/abstract-pool.ts:66