X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicThreadPool.html;h=cda827b9479c3fb3a538dc1ce44d0d9fd0ba40d6;hb=d5d8ef5b0645ff2e43010f981a768c48cd559854;hp=d464b3f15b34089acca1fffbafb16e9e3773711a;hpb=e7339cfd46bfe4600187ae2c6bd6c9e7f63e7052;p=poolifier.git diff --git a/docs/classes/DynamicThreadPool.html b/docs/classes/DynamicThreadPool.html index d464b3f1..cda827b9 100644 --- a/docs/classes/DynamicThreadPool.html +++ b/docs/classes/DynamicThreadPool.html @@ -1,4 +1,4 @@ -
Readonly
filePath to the worker-file.
-Protected
Readonly
filePath to the worker file.
+Readonly
maxProtected
Readonly
maxMaximum number of threads that can be created by this pool.
-Readonly
numberProtected
Readonly
numberNumber of workers that this pool should manage.
-Inherited from FixedThreadPool.numberOfWorkers
Readonly
optsOptions for the pool.
-Protected
Readonly
optsOptions for this fixed thread pool.
+Inherited from FixedThreadPool.opts
Protected
promiseProtected
promiseThe execution response promise map.
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 with the promise resolve/reject bound to the message id.
-Inherited from FixedThreadPool.promiseResponseMap
Protected
workerProtected
workerWorker choice strategy context referencing a worker choice algorithm implementation.
-Default to a round robin algorithm.
-Inherited from FixedThreadPool.workerChoiceStrategyContext
Readonly
workerReadonly
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.full
+Number of tasks queued in the pool.
+Pool information.
Inherited from FixedThreadPool.numberOfQueuedTasks
-Private
numberInherited from FixedThreadPool.info
+Protected
maxNumber of tasks running in the pool.
+Pool maximum size.
Inherited from FixedThreadPool.numberOfRunningTasks
-Overrides FixedThreadPool.maxSize
+Protected
minPool minimum size.
+Inherited from FixedThreadPool.minSize
+Protected
typePool type.
If it is 'dynamic'
, it provides the max
property.
Overrides FixedThreadPool.type
Protected
workerGets the worker type.
+Inherited from FixedThreadPool.worker
+Protected
afterProtected
afterHook executed after the worker task execution. Can be overridden.
@@ -280,40 +329,45 @@ Can be overridden.The worker.
-The received message.
-Inherited from FixedThreadPool.afterTaskExecutionHook
Protected
afterProtected
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.
Function that can be hooked up when a worker has been newly created and moved to the pool worker nodes. +Can be overridden.
The newly created worker.
-Inherited from FixedThreadPool.afterWorkerSetup
Protected
beforeProtected
beforeHook executed before the worker task execution. Can be overridden.
@@ -322,258 +376,303 @@ Can be overridden.The worker node key.
-The task to execute.
+Inherited from FixedThreadPool.beforeTaskExecutionHook
Protected
chooseProtected
createChooses a worker node for the next task.
-The default uses a round robin algorithm to distribute the load.
- -[worker node key, worker node].
+Creates a new dynamic worker and sets it up completely in the pool worker nodes.
Inherited from FixedThreadPool.chooseWorkerNode
-Protected
createNew, completely set up dynamic worker.
+ +Inherited from FixedThreadPool.createAndSetupDynamicWorker
+Protected
createCreates a new worker and sets it up completely in the pool worker nodes.
- -New, completely set up worker.
New, completely set up worker.
+ +Inherited from FixedThreadPool.createAndSetupWorker
Protected
createProtected
createReturns a newly created worker.
+Creates a new worker.
Newly created worker.
+ +Inherited from FixedThreadPool.createWorker
Shutdowns every current worker in this pool.
+Terminate every current worker in this pool.
Inherited from FixedThreadPool.destroy
Protected
destroyShutdowns the given worker.
+Terminates 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.
+Enables/disables the worker tasks queue in this pool.
The input for the specified task. This can only be serializable data.
-Inherited from FixedThreadPool.execute
-Whether to enable or disable the worker tasks queue.
+Optional
tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
+Inherited from FixedThreadPool.enableTasksQueue
+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.
Executes the specified function in the worker constructor with the task data input parameter.
+Optional
data: DataThe task input data for the specified worker function. This can only be structured-cloneable data.
Inherited from FixedThreadPool.findFreeWorkerNodeKey
+Optional
name: stringThe name of the worker function to execute. If not specified, the default worker function will be executed.
+Promise that will be fulfilled when the task is completed.
+ +Inherited from FixedThreadPool.execute
Protected
internalProtected
internalWhether worker nodes are executing at least one task.
+Worker nodes busyness boolean status.
+ +Inherited from FixedThreadPool.internalBusy
Protected
isProtected
isShould return whether the worker is the main worker or not.
Inherited from FixedThreadPool.isMain
Protected
sendRegisters a listener callback on the given worker.
+Sends a message to the given worker.
The worker which should register a listener.
-The worker which should receive the message.
+The message listener callback.
+The message.
Inherited from FixedThreadPool.sendToWorker
+Sets the worker tasks queue options in this pool.
+Inherited from FixedThreadPool.registerWorkerMessageListener
-Protected
sendThe worker tasks queue options.
+Inherited from FixedThreadPool.setTasksQueueOptions
+Sends a message to the given worker.
+Sets the worker choice strategy in this pool.
The worker which should receive the message.
-The worker choice strategy.
+The message.
-Inherited from FixedThreadPool.sendToWorker
+Optional
workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
+Inherited from FixedThreadPool.setWorkerChoiceStrategy
Sets the worker choice strategy in this pool.
+Sets the worker choice strategy options in this pool.
The worker choice strategy.
-Inherited from FixedThreadPool.setWorkerChoiceStrategy
-Protected
setupThe worker choice strategy options.
+Inherited from FixedThreadPool.setWorkerChoiceStrategyOptions
+Protected
setupSetup hook to execute code before worker node are created in the abstract constructor. -Can be overridden
+Setup hook to execute code before worker nodes are created in the abstract constructor. +Can be overridden.
Inherited from FixedThreadPool.setupHook
Protected
workerProtected
workerThis function is the listener registered for each worker message.
- -The listener function to execute when a message is received from a worker.
The listener function to execute when a message is received from a worker.
+This function is the listener registered for each worker message.
- -The listener function to execute when a message is received from a worker.
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 and workers are busy, an event is emitted. If you want to listen to this event, use the pool's
+emitter
.