X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FDynamicThreadPool.html;h=b80a2d14a3c079503b6a9d57c7dff00d0c83e8a0;hb=23d03397abcbf7274ba08acf89728bcaf32f0f6f;hp=d263e3e982c78a2db847dfa57f67ef41f10b2e29;hpb=71a64eca52278c2396cf7cb6e6c53fce3704f5ab;p=poolifier.git diff --git a/docs/classes/DynamicThreadPool.html b/docs/classes/DynamicThreadPool.html index d263e3e9..b80a2d14 100644 --- a/docs/classes/DynamicThreadPool.html +++ b/docs/classes/DynamicThreadPool.html @@ -1,4 +1,4 @@ -
Inherited 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 context referencing a worker choice algorithm implementation.
Default to a round robin algorithm.
Inherited from FixedThreadPool.workerChoiceStrategyContext
Readonly
workersInherited from FixedThreadPool.workers
+Readonly
workerPool worker nodes.
+Inherited from FixedThreadPool.workerNodes
Protected
busyWhether the pool is busy or not.
+The pool busyness boolean status.
+Overrides FixedThreadPool.busy
Protected
fullWhether 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
numberNumber of tasks concurrently running in the pool.
+Number of tasks running in the pool.
Inherited from FixedThreadPool.numberOfRunningTasks
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 worker.
The received message.
Inherited from FixedThreadPool.afterPromiseResponseHook
+Inherited from FixedThreadPool.afterTaskExecutionHook
Protected
afterFunction 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 key.
+The worker node key.
Inherited from FixedThreadPool.beforePromiseResponseHook
+Inherited from FixedThreadPool.beforeTaskExecutionHook
Protected
chooseProtected
chooseChooses a worker for the next task.
+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
createReturns a newly created worker.
+Inherited from FixedThreadPool.createWorker
Shutdowns every current worker in this pool.
+Inherited from FixedThreadPool.destroy
Protected
destroyShutdowns the given worker.
+A worker within workerNodes
.
Inherited from FixedThreadPool.destroyWorker
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
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.findFreeWorkerKey
+Inherited from FixedThreadPool.findFreeWorkerNodeKey
Protected
internalInherited from FixedThreadPool.internalBusy
Protected
isShould return whether the worker is the main worker or not.
+Inherited from FixedThreadPool.isMain
Protected
registerRegisters 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
sendSends a message to the given worker.
+The worker which should receive the message.
+The message.
+Inherited from FixedThreadPool.sendToWorker
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
Type of response of execution. This can only be serializable data.
+Type of execution response. This can only be serializable data.
Hierarchy
-- FixedThreadPool<Data, Response>
+
- FixedThreadPool<Data, Response>
- DynamicThreadPool
@@ -56,36 +56,36 @@ When the maximum number of threads is reached and workers are busy, an event isemitter?
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>
-
@@ -126,20 +126,25 @@ When the maximum number of threads is reached and workers are busy, an event is
Constructs a new poolifier dynamic thread pool.
opts: PoolOptions<ThreadWorkerWithMessageChannel> = {}
Options for this dynamic thread pool.
Returns DynamicThreadPool<Data, Response>
Properties
Optional
Readonly
emitterInherit Doc
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:32
Readonly
fileInherited from FixedThreadPool.filePath
-- Defined in src/pools/abstract-pool.ts:67
+Private
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
Readonly
opts