X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicThreadPool.html;h=9839ac139b1984a50c829efd4060c78d7cf895c8;hb=5e5a659e2b415c7d533dad095eda082989983f8e;hp=b7fba0c61ae31aaa5d6a377084a30609ae4b1385;hpb=248bc34b348a7d8d2b90eecff49d60a3b465da9e;p=poolifier.git diff --git a/docs/classes/DynamicThreadPool.html b/docs/classes/DynamicThreadPool.html index b7fba0c6..cbbc5b2d 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
-Protected
afterPool information.
+Inherited from FixedThreadPool.info
+Protected
maxInherited from FixedThreadPool.afterWorkerSetup
-Protected
choosePool maximum size.
+Overrides FixedThreadPool.maxSize
+Protected
minChoose a worker for the next task.
-The default implementation uses a round robin algorithm to distribute the load.
- -Worker.
+Pool minimum size.
Inherited from FixedThreadPool.chooseWorker
-Protected
createInherited from FixedThreadPool.minSize
+Protected
typeCreates a new worker for this pool and sets it up completely.
- -New, completely set up worker.
+Pool type.
+If it is 'dynamic'
, it provides the max
property.
Inherited from FixedThreadPool.createAndSetupWorker
+Overrides FixedThreadPool.type
Protected
createProtected
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 used to update the maxListeners
or binding the main-worker
<->worker
connection if not bind by default.
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
+The worker node key.
+The task to execute.
+Inherited from FixedThreadPool.beforeTaskExecutionHook
+Protected
chooseChooses a worker node for the next task.
+The default worker choice strategy uses a round robin algorithm to distribute the load.
+The worker node key
+ +Inherited from FixedThreadPool.chooseWorkerNode
+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
createInherited from FixedThreadPool.findFreeWorker
-Returns a newly created worker.
+Inherited from FixedThreadPool.createWorker
+Inherited from FixedThreadPool.getWorkerIndex
-Shutdowns every current worker in this pool.
+Inherited from FixedThreadPool.destroy
+Protected
destroyShutdowns 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 serializable data.
+Inherited from FixedThreadPool.internalExecute
-Protected
internalPromise that will be fulfilled when the task is completed.
+ +Inherited from FixedThreadPool.execute
+Protected
internalInherited from FixedThreadPool.internalGetBusyStatus
+Inherited from FixedThreadPool.internalBusy
Protected
isProtected
isShould return whether the worker is the main worker or not.
+Inherited from FixedThreadPool.isMain
Protected
registerThe worker which should register a listener.
+The message listener callback.
+Inherited from FixedThreadPool.registerWorkerMessageListener
Protected
removeProtected
sendRemoves the given worker from the pool.
+Sends a message to the given worker.
Worker that will be removed.
-Inherited from FixedThreadPool.removeWorker
-Protected
sendThe worker which should receive the message.
+The message.
+Inherited from FixedThreadPool.sendToWorker
+Sets the worker tasks queue options in this pool.
+Inherited from FixedThreadPool.sendToWorker
-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
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 node 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