X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicThreadPool.html;h=83acc6eb74f7161a5f5c73c93a55ab53475f3c0d;hb=775f635f59c45f203473b0cd736cfa639dd76ff3;hp=acd50e80b2083b97b1ae8c6d7b6efab41d33fc79;hpb=b142df6d1278e9d0b6c4c7226bf3dae36c486410;p=poolifier.git diff --git a/docs/classes/DynamicThreadPool.html b/docs/classes/DynamicThreadPool.html index acd50e80..83acc6eb 100644 --- a/docs/classes/DynamicThreadPool.html +++ b/docs/classes/DynamicThreadPool.html @@ -1,13 +1,15 @@ -
Constructs a new poolifier dynamic thread pool.
Minimum number of threads which are always active.
-Maximum number of threads that can be created by this pool.
-Path to an implementation of a ThreadWorker
file, which can be relative or absolute.
Optional
opts: PoolOptions<ThreadWorkerWithMessageChannel> = {}Options for this dynamic thread pool.
-Optional
Readonly
emitterProtected
busyWhether the pool is busy or not.
+The pool busyness boolean status.
+Overrides FixedThreadPool.busy
Protected
fullInherited from FixedThreadPool.numberOfRunningTasks
-Whether the pool is full or not.
+The pool filling boolean status.
+Inherited from FixedThreadPool.full
+Pool information.
+Inherited from FixedThreadPool.info
+Protected
maxThe pool maximum size.
+Inherited from FixedThreadPool.maxSize
+Protected
minThe pool minimum size.
+Inherited from FixedThreadPool.minSize
+Private
readyThe pool readiness boolean status.
+Inherited from FixedThreadPool.ready
+Protected
typeThe pool type.
+If it is 'dynamic'
, it provides the max
property.
Overrides FixedThreadPool.type
Private
utilizationThe approximate pool utilization.
+The pool utilization.
+ +Inherited from FixedThreadPool.utilization
+Protected
workerThe worker type.
+Inherited from FixedThreadPool.worker
+Protected
afterProtected
afterHook executed after the worker task execution. +Can be overridden.
+Inherited from FixedThreadPool.afterWorkerSetup
-Protected
chooseChoose a worker for the next task.
-The default implementation uses a round robin algorithm to distribute the load.
- -Worker.
+The worker node key.
Inherited from FixedThreadPool.chooseWorker
-Protected
createCreates a new worker for this pool and sets it up completely.
- -New, completely set up worker.
+ +The received message.
Inherited from FixedThreadPool.createAndSetupWorker
-Protected
createInherited from FixedThreadPool.afterTaskExecutionHook
+Protected
afterInherited from FixedThreadPool.createWorker
-Protected
decreaseMethod hooked up after a worker node has been newly created. +Can be overridden.
+The newly created worker node key.
+Inherited from FixedThreadPool.afterWorkerNodeSetup
+Protected
beforeDecrease the number of tasks that the given worker has applied.
+Hook executed before the worker task execution. +Can be overridden.
+The worker node key.
+The task to execute.
Inherited from FixedThreadPool.beforeTaskExecutionHook
+Protected
checkWorker whose tasks are decreased.
-Inherited from FixedThreadPool.decreaseWorkersTasks
+Inherited from FixedThreadPool.checkDynamicPoolSize
Protected
createCreates a new, completely set up dynamic worker node.
+New, completely set up dynamic worker node key.
+ +Inherited from FixedThreadPool.createAndSetupDynamicWorkerNode
+Protected
createCreates a new, completely set up worker node.
+New, completely set up worker node key.
+ +Inherited from FixedThreadPool.createAndSetupWorkerNode
+Protected
createCreates a new worker.
+Newly created worker.
+ +Inherited from FixedThreadPool.createWorker
+Terminates all workers in this pool.
+Inherited from FixedThreadPool.destroy
Protected
destroyTerminates the worker node given its worker node key.
+Inherited from FixedThreadPool.destroyWorker
-Inherited from FixedThreadPool.destroyWorkerNode
+Enables/disables the worker node tasks queue in this pool.
+Inherited from FixedThreadPool.execute
-Inherited from FixedThreadPool.findFreeWorker
-Whether to enable or disable the worker node tasks queue.
+Optional
tasksQueueOptions: TasksQueueOptionsThe worker node tasks queue options.
+Inherited from FixedThreadPool.enableTasksQueue
+Executes the specified function in the worker constructor with the task data input parameter.
+Inherited from FixedThreadPool.getWorkerIndex
+Optional
data: DataThe optional task input data for the specified task function. This can only be structured-cloneable data.
+Optional
name: stringThe optional name of the task function to execute. If not specified, the default task function will be executed.
+Optional
transferList: TransferListItem[]An optional array of transferable objects to transfer ownership of. Ownership of the transferred objects is given to the pool's worker_threads worker and they should not be used in the main thread afterwards.
+Promise that will be fulfilled when the task is completed.
+ +Inherited from FixedThreadPool.execute
Protected
flushInherited from FixedThreadPool.getWorkerRunningTasks
+Inherited from FixedThreadPool.flushTasksQueue
Protected
increaseProtected
getIncrease the number of tasks that the given worker has applied.
+Gets the worker information given its worker node key.
Worker whose tasks are increased.
-Inherited from FixedThreadPool.increaseWorkersTask
-Protected
internalThe worker node key.
+The worker information.
+ +Inherited from FixedThreadPool.getWorkerInfo
+Internal
+Whether the worker node has back pressure (i.e. its tasks queue is full).
+Inherited from FixedThreadPool.internalExecute
-Protected
internaltrue
if the worker node has back pressure, false
otherwise.
Inherited from FixedThreadPool.hasWorkerNodeBackPressure
+Protected
internalInherited from FixedThreadPool.internalGetBusyStatus
-Protected
isWhether worker nodes are executing concurrently their tasks quota or not.
+Worker nodes busyness boolean status.
+ +Inherited from FixedThreadPool.internalBusy
+Protected
isShould return whether the worker is the main worker or not.
+Inherited from FixedThreadPool.isMain
Lists the names of task function available in this pool.
+The names of task function available in this pool.
+ +Inherited from FixedThreadPool.listTaskFunctions
+Protected
registerThe worker node key.
+The message listener callback.
+Inherited from FixedThreadPool.registerWorkerMessageListener
Protected
removeProtected
sendRemoves the given worker from the pool.
+Inherited from FixedThreadPool.sendKillMessageToWorker
+Protected
sendSends the startup message to worker given its worker node key.
Worker that will be removed.
-Inherited from FixedThreadPool.removeWorker
-Protected
sendThe worker node key.
+Inherited from FixedThreadPool.sendStartupMessageToWorker
+Protected
sendSends a message to worker given its worker node key.
+The worker node key.
+The message.
+Optional
transferList: TransferListItem[]The optional array of transferable objects.
+Inherited from FixedThreadPool.sendToWorker
Sets the worker node tasks queue options in this pool.
+The worker node 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
Protected
setupSetup hook that can be overridden by a Poolifier pool implementation -to run code before workers are created in the abstract constructor.
+Sets the worker choice strategy options in this pool.
The worker choice strategy options.
+Inherited from FixedThreadPool.setWorkerChoiceStrategyOptions
+Protected
setupSetup 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.
- -The listener function to execute when a message is received from a worker.
+This method 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.
- -The listener function to execute when a message is received from a worker.
+This method 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
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
- -emitter
.Template
of data sent to the worker. This can only be serializable data.
- -Template
of response of execution. This can only be serializable data.
- -Author
Alessandro Pio Ardizio
+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
. +Author
Alessandro Pio Ardizio
-Since
0.0.1
+Since
0.0.1