X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FDynamicThreadPool.html;h=af5ecbce6469b1600298b58e061f53ddc575d1c7;hb=14a2e530e555fa52f98454e182d0094e0ff5d86f;hp=8e381bd07b203c21ce9a92f44b61570f7cabfa08;hpb=f06d10306cf1bfffb90048cf6e96c8507cd0e916;p=poolifier.git diff --git a/docs/classes/DynamicThreadPool.html b/docs/classes/DynamicThreadPool.html index 8e381bd0..af5ecbce 100644 --- a/docs/classes/DynamicThreadPool.html +++ b/docs/classes/DynamicThreadPool.html @@ -1,4 +1,4 @@ -
Protected
promiseThe promise map.
+Protected
promiseThe execution response promise 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 execution response 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 id.
Inherited from FixedThreadPool.promiseMap
+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}
+Readonly
workerPool worker nodes.
Inherited from FixedThreadPool.workers
+Inherited from FixedThreadPool.workerNodes
Readonly
workers{@inheritDoc}
-Inherited from FixedThreadPool.workersTasksUsage
-{@inheritDoc}
+Whether the pool is busy or not.
+The pool busyness boolean status.
Overrides FixedThreadPool.busy
Whether the pool is full or not.
+The pool filling boolean status.
+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}
+Pool type.
+If it is 'dynamic'
, it provides the max
property.
Overrides FixedThreadPool.type
Protected
afterProtected
afterHook executed after the worker task promise resolution. +
Hook executed after the worker task execution. Can be overridden.
The received message.
+The worker.
Inherited from FixedThreadPool.afterPromiseWorkerResponseHook
+Inherited from FixedThreadPool.afterTaskExecutionHook
Protected
after{@inheritDoc}
+Function that can be hooked up when a worker has been newly created and moved to the pool worker nodes.
+Can be used to update the maxListeners
or binding the main-worker
<->worker
connection if not bind by default.
The newly created worker.
+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.
+The worker node key.
Inherited from FixedThreadPool.beforePromiseWorkerResponseHook
+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.
+[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}
+Returns a newly created worker.
Inherited from FixedThreadPool.createWorker
{@inheritDoc}
+Shutdowns every current worker in this pool.
Inherited from FixedThreadPool.destroy
{@inheritDoc}
+Shutdowns the given worker.
A worker within workerNodes
.
Inherited from FixedThreadPool.destroyWorker
{@inheritDoc}
+Performs the task specified in the constructor with the data parameter.
+ +Promise that will be resolved when the task is successfully completed.
The input for the specified task. This can only be serializable data.
+Inherited from FixedThreadPool.execute
{@inheritDoc}
-Inherited from FixedThreadPool.findFreeWorker
-{@inheritDoc}
-Inherited from FixedThreadPool.getWorkerAverageTasksRunTime
-{@inheritDoc}
+Finds a free worker node key based on the number of tasks the worker has applied.
+If a worker is found with 0
running tasks, it is detected as free and its worker node key is returned.
If no free worker is found, -1
is returned.
A worker node key if there is one, -1
otherwise.
Inherited from FixedThreadPool.getWorkerIndex
-{@inheritDoc}
-Inherited from FixedThreadPool.getWorkerRunningTasks
+Inherited from FixedThreadPool.findFreeWorkerNodeKey
Protected
internalProtected
internalInherited from FixedThreadPool.internalGetBusyStatus
+Inherited from FixedThreadPool.internalBusy
Protected
is{@inheritDoc}
+Should return whether the worker is the main worker or not.
Inherited from FixedThreadPool.isMain
{@inheritDoc}
+Registers a listener callback on the given worker.
The worker which should register a listener.
+The message listener callback.
+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}
+Sends a message to the given worker.
The worker which should receive the message.
+The message.
+Inherited from FixedThreadPool.sendToWorker
{@inheritDoc}
+Sets the worker choice strategy in this pool.
The worker choice strategy.
+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,40 +56,36 @@ When the maximum number of threads 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
+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>
-
@@ -130,20 +126,25 @@ 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}
+Emitter on which events can be listened to.
+Events that can currently be listened to:
++
+
+
'full'
: Emitted when the pool is dynamic and full.'busy'
: Emitted when the pool is busy.Inherited from FixedThreadPool.emitter
-- Defined in src/pools/abstract-pool.ts:40
Readonly
fileInherited from FixedThreadPool.filePath
-- Defined in src/pools/abstract-pool.ts:80
+Protected
Readonly
maxReadonly
maxMaximum number of threads that can be created by this pool.
-- Defined in src/pools/thread/dynamic.ts:31
Message Id
-Protected
nextId of the next message.
-Inherited from FixedThreadPool.nextMessageId
--- Defined in src/pools/abstract-pool.ts:58
Readonly
numberInherited from FixedThreadPool.numberOfWorkers
-- Defined in src/pools/abstract-pool.ts:79
Readonly
optsInherited from FixedThreadPool.opts
-- Defined in src/pools/abstract-pool.ts:81