X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FDynamicThreadPool.html;h=6bf89139cf02fb02c624f9fe66a8d140021cc8de;hb=d3127e8409afde2d33be3bf0a04065da98b535c7;hp=966c0ce5f959157f8a59d46e7a8ea1b9aabd9888;hpb=0c1d2aee9268a3d1cad693d46d3ffe253e1f6a41;p=poolifier.git diff --git a/docs/classes/DynamicThreadPool.html b/docs/classes/DynamicThreadPool.html index 966c0ce5..6bf89139 100644 --- a/docs/classes/DynamicThreadPool.html +++ b/docs/classes/DynamicThreadPool.html @@ -1,4 +1,4 @@ -
Type of data sent to the worker. This can only be serializable data.
Type of response of execution. This can only be serializable data.
+Type of execution response. This can only be serializable data.
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
emitterEmitter on which events can be listened to.
+Events that can currently be listened to:
+'full'
: Emitted when the pool is dynamic and full.'busy'
: Emitted when the pool is busy.Inherited from FixedThreadPool.emitter
Readonly
filePath to the worker file.
+Inherited from FixedThreadPool.filePath
Protected
Readonly
maxProtected
nextId of the next message.
+Readonly
maxMaximum number of threads that can be created by this pool.
Inherited from FixedThreadPool.nextMessageId
Readonly
numberNumber of workers that this pool should manage.
+Inherited from FixedThreadPool.numberOfWorkers
Readonly
optsOptions for the 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.
+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.promiseMap
+Inherited from FixedThreadPool.promiseResponseMap
Protected
workerWorker choice strategy instance implementing the worker choice algorithm.
-Default to a strategy implementing a round robin algorithm.
+Worker choice strategy context referencing a worker choice algorithm implementation.
+Default to a round robin algorithm.
Inherited from FixedThreadPool.workerChoiceStrategyContext
Readonly
workersInherited from FixedThreadPool.workers
-Readonly
workersInherited from FixedThreadPool.workersTasksUsage
-Readonly
workerPool worker nodes.
+Inherited from FixedThreadPool.workerNodes
+Protected
busyWhether 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.
+Overrides FixedThreadPool.full
+Private
numberNumber of tasks queued in the pool.
+Inherited from FixedThreadPool.numberOfQueuedTasks
+Private
numberNumber of tasks running in the pool.
+Inherited from FixedThreadPool.numberOfRunningTasks
Pool maximum size.
+Overrides FixedThreadPool.size
+Pool type.
+If it is 'dynamic'
, it provides the max
property.
Overrides FixedThreadPool.type
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.
Inherited from FixedThreadPool.afterPromiseWorkerResponseHook
+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.
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.
Inherited from FixedThreadPool.beforePromiseWorkerResponseHook
+Inherited from FixedThreadPool.beforeTaskExecutionHook
Protected
chooseProtected
chooseChooses a worker for the next task.
-The default implementation uses a round robin algorithm to distribute the load.
- -Worker.
+Chooses a worker node for the next task.
+The default uses a round robin algorithm to distribute the load.
Inherited from FixedThreadPool.chooseWorker
+[worker node key, worker node].
+Inherited from FixedThreadPool.chooseWorkerNode
Protected
createCreates a new worker for this pool and sets it up completely.
- -New, completely set up worker.
+Creates a new worker and sets it up completely in the pool worker nodes.
New, completely set up worker.
+Inherited from FixedThreadPool.createAndSetupWorker
Protected
createReturns a newly created worker.
+Inherited from FixedThreadPool.createWorker
Shutdowns every current worker in this pool.
+Inherited from FixedThreadPool.destroy
Protected
destroyShutdowns the given worker.
+A worker within workerNodes
.
Inherited from FixedThreadPool.destroyWorker
Inherited from FixedThreadPool.execute
-Inherited from FixedThreadPool.findFreeWorker
-Enables/disables the worker tasks queue in this pool.
+Inherited from FixedThreadPool.getWorkerAverageTasksRunTime
-Whether to enable or disable the worker tasks queue.
+Inherited from FixedThreadPool.getWorkerIndex
+Optional
tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
+Inherited from FixedThreadPool.enableTasksQueue
Inherited from FixedThreadPool.getWorkerRunningTasks
-Protected
internalExecutes the function specified 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
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.
The worker that will be removed.
+The worker which should receive the message.
+The message.
Inherited from FixedThreadPool.removeWorker
+Inherited from FixedThreadPool.sendToWorker
Protected
sendSets the worker tasks queue options in this pool.
+The worker tasks queue options.
+Inherited from FixedThreadPool.sendToWorker
+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
Sets the worker choice strategy options in this pool.
+The 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 node are created in the abstract constructor. +Can be overridden
Inherited from FixedThreadPool.setupHook
Protected
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
+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
.emitter
.Author
Alessandro Pio Ardizio
Since
0.0.1