X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicThreadPool.html;h=18d495876688ccf2ac6ca69e0bc4fc1345be98bb;hb=761b0c73be0bf581f50a78123913f933bd405f52;hp=f6495e279a204f5ba19c7dc378617f980e5bffea;hpb=812ad701baefad24cad2df8f9a60bf4d581d8697;p=poolifier.git diff --git a/docs/classes/DynamicThreadPool.html b/docs/classes/DynamicThreadPool.html index f6495e27..18d49587 100644 --- a/docs/classes/DynamicThreadPool.html +++ b/docs/classes/DynamicThreadPool.html @@ -33,7 +33,7 @@ When the maximum number of threads is reached and workers are busy, an event is
Optional
Readonly
emitterReadonly
filePath to the worker-file.
+Path to the worker file.
Inherited from FixedThreadPool.filePath
Readonly
maxMaximum number of threads that can be created by this pool.
Readonly
numberInherited from FixedThreadPool.numberOfWorkers
Readonly
optsInherited from FixedThreadPool.opts
Protected
promiseThe execution response promise map.
key
: The message id of each submitted task.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
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
numberInherited from FixedThreadPool.numberOfQueuedTasks
Private
numberInherited from FixedThreadPool.numberOfRunningTasks
Pool type.
+If it is 'dynamic'
, it provides the max
property.
Overrides FixedThreadPool.type
Protected
afterHook executed after the worker task execution. Can be overridden.
@@ -276,29 +287,32 @@ Can be overridden.The worker.
The received message.
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
beforeInherited from FixedThreadPool.beforeTaskExecutionHook
Protected
chooseChooses a worker node for the next task.
The default uses a round robin algorithm to distribute the load.
[worker node key, worker node].
Inherited from FixedThreadPool.chooseWorkerNode
Protected
createInherited 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
Enables/disables the worker tasks queue in this pool.
+Whether to enable or disable the worker tasks queue.
+Optional
tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
+Inherited from FixedThreadPool.enableTasksQueue
+Executes the function specified in the worker constructor with the task data input parameter.
+ +Promise that will be fulfilled when the task is completed.
+Optional
data: DataThe task input data for the specified worker function. 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.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
sendSends a message to the given worker.
+The worker which should receive the message.
+The message.
+Inherited from FixedThreadPool.sendToWorker
Sets the worker tasks queue options in this pool.
+The worker tasks queue options.
+Inherited from FixedThreadPool.setTasksQueueOptions
+Sets the worker choice strategy in this pool.
+The worker choice strategy.
+Optional
workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
+Inherited from FixedThreadPool.setWorkerChoiceStrategy
Sets the worker choice strategy options in this pool.
+The worker choice strategy options.
+Inherited from FixedThreadPool.setWorkerChoiceStrategyOptions
+Protected
setupInherited from FixedThreadPool.setupHook
Protected
workerThis 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 message.
@@ -533,11 +629,11 @@ Can be overriddenInherited from FixedThreadPool.workerListener
Type of response of execution. This can only be serializable data.
+Type of execution response. This can only be serializable data.
Hierarchy
@@ -42,7 +42,7 @@ When the maximum number of threads is reached and workers are busy, an event is@@ -65,8 +65,8 @@ When the maximum number of threads is reached and workers are busy, an event is