X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FDynamicThreadPool.html;h=26888edf983bf541ba41afeb19c1e467914fac66;hb=296cba79ddbf15e2fd8510a4ba1ef0079ef77ee1;hp=f3134790a4abb37b0410b4dd988fdeff1045e393;hpb=cfc6e8df4c903b63514c46cb67b3f5e24079d3ce;p=poolifier.git diff --git a/docs/classes/DynamicThreadPool.html b/docs/classes/DynamicThreadPool.html index f3134790..26888edf 100644 --- a/docs/classes/DynamicThreadPool.html +++ b/docs/classes/DynamicThreadPool.html @@ -1,4 +1,4 @@ -
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.
Options for this dynamic thread pool.
-Optional
Readonly
emitter{@inheritDoc}
-Protected
Readonly
maxMaximum number of threads that can be created by this pool.
-Protected
nextId of the next message.
-Inherited from FixedThreadPool.nextMessageId
-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
promiseThe promise map.
+Protected
promiseThe execution response promise map.
key
: This is the message Id of each submitted task.value
: An object that contains the worker, the resolve function and the reject function.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 and resolve/reject the promise based on the message.
-Inherited from FixedThreadPool.promiseMap
-Protected
workerWorker choice strategy instance implementing the worker choice algorithm.
-Default to a strategy implementing a round robin algorithm.
-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
workerWorker choice strategy context referencing a worker choice algorithm implementation.
+Inherited from FixedThreadPool.workerChoiceStrategyContext
Readonly
workers{@inheritDoc}
-Inherited from FixedThreadPool.workers
-Readonly
workers{@inheritDoc}
-Inherited from FixedThreadPool.workersTasksUsage
-Readonly
workerPool worker nodes.
+Inherited from FixedThreadPool.workerNodes
+Protected
busy{@inheritDoc}
+Whether 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.
+Inherited from FixedThreadPool.full
+{@inheritDoc}
+Pool information.
Inherited from FixedThreadPool.numberOfRunningTasks
+Inherited from FixedThreadPool.info
+Protected
maxPool maximum size.
+Overrides FixedThreadPool.maxSize
+Protected
minPool minimum size.
+Inherited from FixedThreadPool.minSize
+Private
readyInherited from FixedThreadPool.ready
Private
starting{@inheritDoc}
+Inherited from FixedThreadPool.starting
+Protected
typePool type.
+If it is 'dynamic'
, it provides the max
property.
Overrides FixedThreadPool.type
Private
utilizationGets the approximate pool utilization.
+The pool utilization.
+ +Inherited from FixedThreadPool.utilization
+Protected
workerGets the worker type.
+Inherited from FixedThreadPool.worker
+Protected
afterProtected
afterHook executed after the worker task promise resolution. +
Hook executed after the worker task execution. Can be overridden.
The received message.
-The worker.
+The Promise response.
-Inherited from FixedThreadPool.afterPromiseWorkerResponseHook
-Protected
afterThe received message.
+Inherited from FixedThreadPool.afterTaskExecutionHook
+Protected
after{@inheritDoc}
+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 promise resolution. +
Hook executed before the worker task execution. Can be overridden.
The worker.
-The worker node key.
+The task to execute.
+Inherited from FixedThreadPool.beforeTaskExecutionHook
+Protected
checkInherited from FixedThreadPool.beforePromiseWorkerResponseHook
+Inherited from FixedThreadPool.checkDynamicPoolSize
Protected
chooseProtected
createChooses a worker for the next task.
-The default implementation uses a round robin algorithm to distribute the load.
- -Worker.
+Creates a new dynamic worker and sets it up completely in the pool worker nodes.
Inherited from FixedThreadPool.chooseWorker
-Protected
createCreates a new worker for this pool and sets it up completely.
+New, completely set up dynamic worker.
-New, completely set up 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
createProtected
create{@inheritDoc}
+Creates a new worker.
Newly created worker.
+ +Inherited from FixedThreadPool.createWorker
{@inheritDoc}
+Terminates every current worker in this pool.
Inherited from FixedThreadPool.destroy
Protected
destroy{@inheritDoc}
+Terminates the given worker.
A worker within workerNodes
.
Inherited from FixedThreadPool.destroyWorker
{@inheritDoc}
+Enables/disables the worker tasks queue in this pool.
Inherited from FixedThreadPool.execute
-{@inheritDoc}
+Whether to enable or disable the worker tasks queue.
Inherited from FixedThreadPool.findFreeWorker
-{@inheritDoc}
-Inherited from FixedThreadPool.getWorkerAverageTasksRunTime
-Optional
tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
+Inherited from FixedThreadPool.enableTasksQueue
+{@inheritDoc}
+Executes the specified function in the worker constructor with the task data input parameter.
Inherited from FixedThreadPool.getWorkerIndex
-{@inheritDoc}
+Optional
data: DataThe task input data for the specified worker function. This can only be structured-cloneable data.
Inherited from FixedThreadPool.getWorkerRunningTasks
-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
internal{@inheritDoc}
+Whether 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
send{@inheritDoc}
+Sends 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.
The worker that will be removed.
-Inherited from FixedThreadPool.removeWorker
-Protected
sendThe worker tasks queue options.
+Inherited from FixedThreadPool.setTasksQueueOptions
+{@inheritDoc}
+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
{@inheritDoc}
+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
.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