X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicThreadPool.html;h=ed6d4a8f3c416b5b31409288811c6536a70e6683;hb=a34454964733f585af19a04f21f9e35eb18c77b1;hp=acd50e80b2083b97b1ae8c6d7b6efab41d33fc79;hpb=b142df6d1278e9d0b6c4c7226bf3dae36c486410;p=poolifier.git diff --git a/docs/classes/DynamicThreadPool.html b/docs/classes/DynamicThreadPool.html index acd50e80..ed6d4a8f 100644 --- a/docs/classes/DynamicThreadPool.html +++ b/docs/classes/DynamicThreadPool.html @@ -1,11 +1,13 @@
Optional
Readonly
emitterReadonly
fileReadonly
maxInherited from FixedThreadPool.max
-Protected
nextId of the next message.
+Maximum 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 promise response 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 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.
Inherited from FixedThreadPool.promiseMap
+Inherited from FixedThreadPool.promiseResponseMap
Readonly
tasksInherited from FixedThreadPool.tasks
-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
workersReadonly
workerInherited from FixedThreadPool.workers
+Inherited from FixedThreadPool.workerNodes
Overrides FixedThreadPool.busy
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
Overrides FixedThreadPool.type
Protected
afterHook executed after the worker task promise resolution. +Can be overridden.
+The worker.
+The received message.
+Inherited from FixedThreadPool.afterPromiseResponseHook
+Protected
afterInherited from FixedThreadPool.afterWorkerSetup
Protected
chooseProtected
beforeHook executed before the worker task promise resolution. +Can be overridden.
+The worker node key.
+Inherited from FixedThreadPool.beforePromiseResponseHook
+Protected
chooseChoose a worker for the next task.
-The default implementation uses a round robin algorithm to distribute the load.
+Chooses a worker node for the next task.
+The default uses a round robin algorithm to distribute the load.
-Worker.
+[worker node key, worker node].
Inherited from FixedThreadPool.chooseWorker
+Inherited from FixedThreadPool.chooseWorkerNode
Protected
createCreates a new worker for this pool and sets it up completely.
+Creates 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.createWorker
Protected
decreaseProtected
dequeueDecrease the number of tasks that the given worker has applied.
-Worker whose tasks are decreased.
-Inherited from FixedThreadPool.decreaseWorkersTasks
+Inherited from FixedThreadPool.dequeueTask
Inherited from FixedThreadPool.destroy
Inherited from FixedThreadPool.destroyWorker
Protected
enqueueInherited from FixedThreadPool.enqueueTask
+Inherited from FixedThreadPool.execute
Inherited from FixedThreadPool.findFreeWorker
-Inherited from FixedThreadPool.getWorkerIndex
+Inherited from FixedThreadPool.findFreeWorkerNodeKey
Inherited from FixedThreadPool.getWorkerRunningTasks
-Protected
increaseProtected
flushIncrease the number of tasks that the given worker has applied.
-Worker whose tasks are increased.
-Inherited from FixedThreadPool.increaseWorkersTask
+Inherited from FixedThreadPool.flushTasksQueue
Protected
internalProtected
flushInherited from FixedThreadPool.internalExecute
+Inherited from FixedThreadPool.flushTasksQueueByWorker
Protected
internalProtected
internalInherited from FixedThreadPool.internalGetBusyStatus
+Inherited from FixedThreadPool.internalBusy
Protected
isInherited from FixedThreadPool.isMain
Inherited from FixedThreadPool.registerWorkerMessageListener
Protected
removeProtected
removeRemoves the given worker from the pool.
+Removes the given worker from the pool worker nodes.
Worker that will be removed.
+The worker.
Inherited from FixedThreadPool.removeWorker
+Inherited from FixedThreadPool.removeWorkerNode
Protected
sendInherited from FixedThreadPool.sendToWorker
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.
+Setup hook to run code before worker node are created in the abstract constructor. +Can be overridden
Inherited from FixedThreadPool.setupHook
Protected
tasksInherited from FixedThreadPool.tasksQueueLength
+Protected
workerThis function is the listener registered for each 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.
+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.
+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
@@ -30,9 +28,13 @@ When the maximum number of threads is reached, an event is emitted. If you wantType Parameters
Data = unknown
Data = unknown
+Type of data sent to the worker. This can only be serializable data.
+Response = unknown
Response = unknown
+Type of response of execution. This can only be serializable data.
+Hierarchy
@@ -40,7 +42,7 @@ When the maximum number of threads is reached, an event is emitted. If you want- DynamicThreadPool
@@ -54,43 +56,45 @@ When the maximum number of threads is reached, an event is emitted. If you wantemitter?
file Path
-max
-next Message Id
+max
number Of Workers
opts
-promise Map
-tasks
+promise Response Map
worker Choice Strategy Context
-workers
+worker Nodes
Properties
Accessors
Methods
-constructor
-- new
Dynamic Thread Pool<Data, Response>(min: number, max: number, filePath: string, opts??: PoolOptions<ThreadWorkerWithMessageChannel>): DynamicThreadPool<Data, Response>
+- new
Dynamic Thread Pool<Data, Response>(min: number, max: number, filePath: string, opts?: PoolOptions<ThreadWorkerWithMessageChannel>): DynamicThreadPool<Data, Response>
-
@@ -125,95 +129,84 @@ When the maximum number of threads is reached, an event is emitted. If you want
-
-
Constructs a new poolifier dynamic thread pool.
Path to an implementation of a
ThreadWorker
file, which can be relative or absolute.
+Optional
opts: PoolOptions<ThreadWorkerWithMessageChannel> = {}opts: PoolOptions<ThreadWorkerWithMessageChannel> = {}
Options for this dynamic thread pool.
Returns DynamicThreadPool<Data, Response>