X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FDynamicThreadPool.html;h=26888edf983bf541ba41afeb19c1e467914fac66;hb=296cba79ddbf15e2fd8510a4ba1ef0079ef77ee1;hp=acd50e80b2083b97b1ae8c6d7b6efab41d33fc79;hpb=b142df6d1278e9d0b6c4c7226bf3dae36c486410;p=poolifier.git diff --git a/docs/classes/DynamicThreadPool.html b/docs/classes/DynamicThreadPool.html index acd50e80..26888edf 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
+Overrides FixedThreadPool.type
+Pool information.
+Inherited from FixedThreadPool.info
+Protected
maxPool maximum size.
+Overrides FixedThreadPool.maxSize
+Protected
minPool minimum size.
+Inherited from FixedThreadPool.minSize
+Private
readyInherited from FixedThreadPool.ready
Protected
afterPrivate
startingInherited from FixedThreadPool.afterWorkerSetup
+Inherited from FixedThreadPool.starting
Protected
chooseProtected
typeChoose a worker for the next task.
-The default implementation uses a round robin algorithm to distribute the load.
- -Worker.
+Pool type.
+If it is 'dynamic'
, it provides the max
property.
Inherited from FixedThreadPool.chooseWorker
+Overrides FixedThreadPool.type
Protected
createPrivate
utilizationCreates a new worker for this pool and sets it up completely.
- -New, completely set up worker.
+Gets the approximate pool utilization.
Inherited from FixedThreadPool.createAndSetupWorker
-Protected
createThe pool utilization.
+ +Inherited from FixedThreadPool.utilization
+Protected
workerInherited from FixedThreadPool.createWorker
+Gets the worker type.
+Inherited from FixedThreadPool.worker
Protected
decreaseProtected
afterDecrease the number of tasks that the given worker has applied.
+Hook executed after the worker task execution. +Can be overridden.
Worker whose tasks are decreased.
-Inherited from FixedThreadPool.decreaseWorkersTasks
-Inherited from FixedThreadPool.destroy
-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 overridden.
+Inherited from FixedThreadPool.destroyWorker
+The newly created worker.
+Inherited from FixedThreadPool.afterWorkerSetup
Protected
beforeHook executed before the worker task execution. +Can be overridden.
+Inherited from FixedThreadPool.execute
-Inherited from FixedThreadPool.findFreeWorker
-The worker node key.
+The task to execute.
+Inherited from FixedThreadPool.beforeTaskExecutionHook
+Protected
checkInherited from FixedThreadPool.getWorkerIndex
-Inherited from FixedThreadPool.checkDynamicPoolSize
+Protected
createCreates a new dynamic worker and sets it up completely in the pool worker nodes.
+New, 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.
+ +Inherited from FixedThreadPool.createAndSetupWorker
+Protected
createCreates a new worker.
+Newly created worker.
+ +Inherited from FixedThreadPool.createWorker
+Terminates every current worker in this pool.
+Inherited from FixedThreadPool.destroy
+Protected
destroyTerminates the given worker.
+Inherited from FixedThreadPool.getWorkerRunningTasks
-Protected
increaseA worker within workerNodes
.
Inherited from FixedThreadPool.destroyWorker
+Increase the number of tasks that the given worker has applied.
+Enables/disables the worker tasks queue in this pool.
Worker whose tasks are increased.
-Inherited from FixedThreadPool.increaseWorkersTask
-Protected
internalWhether to enable or disable the worker tasks queue.
+Optional
tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
+Inherited from FixedThreadPool.enableTasksQueue
+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.internalExecute
-Protected
internalInherited from FixedThreadPool.internalGetBusyStatus
+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
isProtected
internalWhether worker nodes are executing at least one task.
+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
Protected
sendSends a message to the given worker.
+The worker which should receive the message.
+Inherited from FixedThreadPool.registerWorkerMessageListener
+The message.
+Inherited from FixedThreadPool.sendToWorker
Protected
removeRemoves the given worker from the pool.
+Sets the worker tasks queue options in this pool.
Worker that will be removed.
-Inherited from FixedThreadPool.removeWorker
-Protected
sendThe worker tasks queue options.
+Inherited from FixedThreadPool.setTasksQueueOptions
+Sets the worker choice strategy in this pool.
+The worker choice strategy.
+Inherited from FixedThreadPool.sendToWorker
+Optional
workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
+Inherited from FixedThreadPool.setWorkerChoiceStrategy
Sets the worker choice strategy options in this pool.
+Inherited from FixedThreadPool.setWorkerChoiceStrategy
-Protected
setupThe worker choice strategy options.
+Inherited from FixedThreadPool.setWorkerChoiceStrategyOptions
+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 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 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.
- -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.
+ +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, 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