X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FDynamicThreadPool.html;h=7a85327c24a5c03ed9042589aa9582b4ad0c9394;hb=227be16668f5a3adf78a255c20e956d6f5b3f567;hp=468cfc3c5915e157c76a4fe4d91c9b7c1ffe0007;hpb=74f29142ea20199700ef7021402616ea9de714a8;p=poolifier.git diff --git a/docs/classes/DynamicThreadPool.html b/docs/classes/DynamicThreadPool.html index 468cfc3c..7a85327c 100644 --- a/docs/classes/DynamicThreadPool.html +++ b/docs/classes/DynamicThreadPool.html @@ -1,4 +1,4 @@ -
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.
+Path to the worker file.
Inherited from FixedThreadPool.filePath
Readonly
maxMaximum number of threads that can be created by this pool.
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 response map.
+The execution response promise map.
key
: The message id of each submitted task.value
: An object that contains the worker, the promise resolve and reject callbacks.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 with the promise resolve/reject bound to 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.promiseResponseMap
Protected
workerWorker choice strategy context referencing a worker choice algorithm implementation.
Default to a round robin algorithm.
Inherited from FixedThreadPool.workerChoiceStrategyContext
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.
@@ -241,10 +244,10 @@ When the maximum number of threads is reached and workers are busy, an event isInherited from FixedThreadPool.numberOfQueuedTasks
Private
numberNumber of tasks running in the pool.
@@ -252,392 +255,369 @@ When the maximum number of threads is reached and workers are busy, an event isInherited from FixedThreadPool.numberOfRunningTasks
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 worker.
The received message.
Inherited from FixedThreadPool.afterPromiseResponseHook
+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 node key.
Inherited from FixedThreadPool.beforePromiseResponseHook
+Inherited from FixedThreadPool.beforeTaskExecutionHook
Protected
chooseChooses a worker node for the next task.
The default uses a round robin algorithm to distribute the load.
- -[worker node key, worker node].
[worker node key, worker node].
+Inherited from FixedThreadPool.chooseWorkerNode
Protected
createCreates a new worker and sets it up completely in the pool worker nodes.
- -New, completely set up worker.
New, completely set up worker.
+Inherited from FixedThreadPool.createAndSetupWorker
Protected
createReturns a newly created worker.
+Inherited from FixedThreadPool.createWorker
Protected
dequeueInherited from FixedThreadPool.dequeueTask
-Shutdowns every current worker in this pool.
+Inherited from FixedThreadPool.destroy
Protected
destroyShutdowns the given worker.
+A worker within workerNodes
.
Inherited from FixedThreadPool.destroyWorker
Protected
enqueueEnables/disables the worker tasks queue in this pool.
+Whether to enable or disable the worker tasks queue.
+Optional
tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
+Inherited from FixedThreadPool.enqueueTask
+Inherited from FixedThreadPool.enableTasksQueue
Executes 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.
+Promise that will be fulfilled when the task is completed.
+Inherited from FixedThreadPool.execute
Inherited from FixedThreadPool.findFreeWorkerNodeKey
-Protected
flushInherited from FixedThreadPool.flushTasksQueue
-Protected
flushInherited from FixedThreadPool.flushTasksQueueByWorker
-Protected
internalInherited 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 worker nodes.
+Sends a message to the given worker.
The worker.
+The worker which should receive the message.
+The message.
Inherited from FixedThreadPool.removeWorkerNode
+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
Protected
setupSetup hook to run code before worker node are created in the abstract constructor. -Can be overridden
+Sets the worker choice strategy options in this pool.
Inherited from FixedThreadPool.setupHook
-Protected
tasksInherited from FixedThreadPool.tasksQueueLength
+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
workerThis function is the listener registered for each worker message.
- -The listener function to execute when a message is received from a 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.
The listener function to execute when a message is received from a worker.
+Inherited from FixedThreadPool.workerListener
Generated using TypeDoc
Type of data sent to the worker. This can only be serializable data.