X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicThreadPool.html;h=83acc6eb74f7161a5f5c73c93a55ab53475f3c0d;hb=775f635f59c45f203473b0cd736cfa639dd76ff3;hp=f3134790a4abb37b0410b4dd988fdeff1045e393;hpb=cfc6e8df4c903b63514c46cb67b3f5e24079d3ce;p=poolifier.git diff --git a/docs/classes/DynamicThreadPool.html b/docs/classes/DynamicThreadPool.html index f3134790..83acc6eb 100644 --- a/docs/classes/DynamicThreadPool.html +++ b/docs/classes/DynamicThreadPool.html @@ -1,15 +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.
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
numberInherited from FixedThreadPool.max
+Protected
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 task 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
Internal
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
full{@inheritDoc}
+Whether the pool is full or not.
+The pool filling boolean status.
Inherited from FixedThreadPool.numberOfRunningTasks
-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
ready{@inheritDoc}
+The 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 promise resolution. +
Hook executed after the worker task execution. Can be overridden.
The received message.
-The worker node key.
+The Promise response.
-Inherited from FixedThreadPool.afterPromiseWorkerResponseHook
-Protected
afterThe received message.
+Inherited from FixedThreadPool.afterTaskExecutionHook
+Protected
after{@inheritDoc}
+Method hooked up after a worker node has been newly created. +Can be overridden.
Inherited from FixedThreadPool.afterWorkerSetup
-Protected
beforeThe newly created worker node key.
+Inherited from FixedThreadPool.afterWorkerNodeSetup
+Protected
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, completely set up dynamic worker node.
Inherited from FixedThreadPool.chooseWorker
-Protected
createCreates a new worker for this pool and sets it up completely.
+New, completely set up dynamic worker node key.
-New, completely set up worker.
+Inherited from FixedThreadPool.createAndSetupDynamicWorkerNode
+Protected
createCreates a new, completely set up worker node.
Inherited from FixedThreadPool.createAndSetupWorker
-Protected
createNew, completely set up worker node key.
+ +Inherited from FixedThreadPool.createAndSetupWorkerNode
+Protected
create{@inheritDoc}
+Creates a new worker.
Newly created worker.
+ +Inherited from FixedThreadPool.createWorker
{@inheritDoc}
+Terminates all workers in this pool.
Inherited from FixedThreadPool.destroy
Protected
destroy{@inheritDoc}
+Terminates the worker node given its worker node key.
Inherited from FixedThreadPool.destroyWorker
-Inherited from FixedThreadPool.destroyWorkerNode
+{@inheritDoc}
+Enables/disables the worker node tasks queue in this pool.
Inherited from FixedThreadPool.execute
-{@inheritDoc}
+Whether to enable or disable the worker node tasks queue.
Inherited from FixedThreadPool.findFreeWorker
-Optional
tasksQueueOptions: TasksQueueOptionsThe worker node 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.getWorkerAverageTasksRunTime
+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
flush{@inheritDoc}
-Inherited from FixedThreadPool.getWorkerIndex
+Inherited from FixedThreadPool.flushTasksQueue
Protected
get{@inheritDoc}
+Gets the worker information given its worker node key.
Inherited from FixedThreadPool.getWorkerRunningTasks
-Protected
internalThe worker information.
+ +Inherited from FixedThreadPool.getWorkerInfo
+Internal
+Whether the worker node has back pressure (i.e. its tasks queue is full).
+The worker node key.
+true
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
is{@inheritDoc}
+Should 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
register{@inheritDoc}
+Registers a listener callback on the worker given its worker node key.
The 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.
The worker that will be removed.
-Inherited from FixedThreadPool.removeWorker
-Protected
sendThe worker node key.
+Inherited from FixedThreadPool.sendStartupMessageToWorker
+Protected
send{@inheritDoc}
+Sends 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
{@inheritDoc}
+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
.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