X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicThreadPool.html;h=f6495e279a204f5ba19c7dc378617f980e5bffea;hb=812ad701baefad24cad2df8f9a60bf4d581d8697;hp=66ad9b5b6dc400a2edc002a84b78044da6559b57;hpb=a75da00c7b8dbbb148d2cf2472ce73e4201d9a4a;p=poolifier.git diff --git a/docs/classes/DynamicThreadPool.html b/docs/classes/DynamicThreadPool.html index 66ad9b5b..f6495e27 100644 --- a/docs/classes/DynamicThreadPool.html +++ b/docs/classes/DynamicThreadPool.html @@ -1,4 +1,4 @@ -
Readonly
optsInherited from FixedThreadPool.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 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
+Readonly
workerInherited from FixedThreadPool.workerNodes
{@inheritDoc}
-Overrides FixedThreadPool.busy
Overrides FixedThreadPool.full
+Private
numberNumber of tasks queued in the pool.
+Inherited from FixedThreadPool.numberOfQueuedTasks
+Private
number{@inheritDoc}
+Number of tasks running in the pool.
Inherited from FixedThreadPool.numberOfRunningTasks
{@inheritDoc}
-Overrides FixedThreadPool.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 FixedThreadPool.afterPromiseResponseHook
+Inherited from FixedThreadPool.afterTaskExecutionHook
Protected
after{@inheritDoc}
-Inherited from FixedThreadPool.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 FixedThreadPool.beforePromiseResponseHook
+Inherited from FixedThreadPool.beforeTaskExecutionHook
Protected
chooseProtected
chooseChooses a worker for the next task.
-The default implementation uses a round robin algorithm to distribute the load.
+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 FixedThreadPool.chooseWorker
+Inherited from FixedThreadPool.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 FixedThreadPool.createAndSetupWorker
Protected
create{@inheritDoc}
-Inherited from FixedThreadPool.createWorker
{@inheritDoc}
-Inherited from FixedThreadPool.destroy
{@inheritDoc}
-Inherited from FixedThreadPool.destroyWorker
Inherited from FixedThreadPool.execute
{@inheritDoc}
-Inherited from FixedThreadPool.findFreeWorkerKey
+Inherited from FixedThreadPool.findFreeWorkerNodeKey
Protected
internalProtected
internalInherited from FixedThreadPool.internalGetBusyStatus
+Inherited from FixedThreadPool.internalBusy
Protected
is{@inheritDoc}
-Inherited from FixedThreadPool.isMain
{@inheritDoc}
-Inherited from FixedThreadPool.registerWorkerMessageListener
Protected
removeRemoves the given worker from the pool.
-The worker that will be removed.
-Inherited 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.
+Setup hook to execute code before worker node are created in the abstract constructor. +Can be overridden
Inherited from FixedThreadPool.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 FixedThreadPool.workerListener
Generated using TypeDoc
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
@@ -38,11 +38,11 @@ When the maximum number of threads is reached, an event is emitted. If you wantHierarchy
-- FixedThreadPool<Data, Response>
+
- FixedThreadPool<Data, Response>
- DynamicThreadPool
@@ -56,35 +56,36 @@ 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
worker Choice Strategy Context
-workers
+worker Nodes
Properties
Accessors
Methods
-constructor
-- new
Dynamic Thread Pool<Data, Response>(min: number, max: number, filePath: string, opts?: PoolOptions<ThreadWorkerWithMessageChannel>): DynamicThreadPool<Data, Response>
+- new
Dynamic Thread Pool<Data, Response>(min: number, max: number, filePath: string, opts?: PoolOptions<ThreadWorkerWithMessageChannel>): DynamicThreadPool<Data, Response>
-
@@ -125,20 +126,20 @@ When the maximum number of threads is reached, an event is emitted. If you want
Constructs a new poolifier dynamic thread pool.
opts: PoolOptions<ThreadWorkerWithMessageChannel> = {}
Options for this dynamic thread pool.
Returns DynamicThreadPool<Data, Response>
Properties
Optional
Readonly
emitter{@inheritDoc}
-Inherit Doc
Inherited from FixedThreadPool.emitter
-- Defined in src/pools/abstract-pool.ts:32
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