X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicThreadPool.html;h=f6495e279a204f5ba19c7dc378617f980e5bffea;hb=812ad701baefad24cad2df8f9a60bf4d581d8697;hp=9fb9a13138f25bdbf311c1dd0aac26050f07a4ca;hpb=fa6436344997918dbda3e94063b4c2e2e4a892c3;p=poolifier.git diff --git a/docs/classes/DynamicThreadPool.html b/docs/classes/DynamicThreadPool.html index 9fb9a131..f6495e27 100644 --- a/docs/classes/DynamicThreadPool.html +++ b/docs/classes/DynamicThreadPool.html @@ -1,4 +1,4 @@ -
Options for this dynamic thread pool.
Inherited from FixedThreadPool.emitter
Readonly
fileInherited from FixedThreadPool.filePath
Private
Readonly
maxReadonly
maxMaximum number of threads that can be created by this pool.
Readonly
numberInherited from FixedThreadPool.numberOfWorkers
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 context referencing a worker choice algorithm implementation.
Default to a round robin algorithm.
Inherited from FixedThreadPool.workerChoiceStrategyContext
Readonly
workersReadonly
workerInherited from FixedThreadPool.workers
+Inherited from FixedThreadPool.workerNodes
Overrides FixedThreadPool.busy
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
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
afterInherited 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
createInherited from FixedThreadPool.createWorker
Inherited from FixedThreadPool.destroy
Inherited from FixedThreadPool.destroyWorker
Inherited from FixedThreadPool.execute
Inherited from FixedThreadPool.findFreeWorkerKey
+Inherited from FixedThreadPool.findFreeWorkerNodeKey
Protected
internalInherited from FixedThreadPool.internalBusy
Protected
isInherited from FixedThreadPool.isMain
Inherited from FixedThreadPool.registerWorkerMessageListener
Protected
removeRemoves the given worker from the pool.
-The worker that will be removed.
-Inherited from FixedThreadPool.removeWorker
-Protected
sendInherited from FixedThreadPool.sendToWorker
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
Constructs a new poolifier dynamic thread pool.