X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FDynamicThreadPool.html;h=86171c79877dbdd2161b6a2b2d61d2e323339196;hb=2115798751b31f025acae1ff8c4f5cbcec8ad3af;hp=fcd381101e5f9fcb0585834eb15909697474e9de;hpb=afa30fd0dd5bbc5d305cc30be663966a449efc08;p=poolifier.git diff --git a/docs/classes/DynamicThreadPool.html b/docs/classes/DynamicThreadPool.html index fcd38110..86171c79 100644 --- a/docs/classes/DynamicThreadPool.html +++ b/docs/classes/DynamicThreadPool.html @@ -1,4 +1,4 @@ -
Emitter 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.'ready'
: Emitted when the number of workers created in the pool has reached the minimum size expected and are ready.'busy'
: Emitted when the number of workers created in the pool has reached the maximum size expected and are executing at least one task.'full'
: Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.destroy
': Emitted when the pool is destroyed.'error'
: Emitted when an uncaught error occurs.'taskError'
: Emitted when an error occurs while executing a task.Protected
Readonly
fileProtected
Readonly
maxProtected
Readonly
numberProtected
Readonly
optsOptions for the pool.
+ +Options for this fixed thread pool.
Protected
promiseThe execution response promise map.
+ +The task execution response promise map.
key
: The message id of each submitted task.value
: An object that contains the worker, the execution response promise resolve and reject callbacks.Protected
workerWorker choice strategy context referencing a worker choice algorithm implementation.
-Default to a round robin algorithm.
Readonly
workerPool worker nodes.
Protected
fullProtected
maxPool maximum size.
+The pool maximum size.
Protected
minPool minimum size.
+The pool minimum size.
Private
readyThe pool readiness boolean status.
+Protected
typePool type.
+The pool type.
If it is 'dynamic'
, it provides the max
property.
Private
utilizationThe approximate pool utilization.
+The pool utilization.
+ +Protected
workerGets the worker type.
+The worker type.
Protected
afterHook executed after the worker task execution. Can be overridden.
@@ -331,12 +365,12 @@ Can be overridden.The worker.
+The worker node key.
The received message.
Protected
afterProtected
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.
Method hooked up after a worker node has been newly created. +Can be overridden.
The newly created worker.
+The newly created worker node key.
Protected
beforeHook executed before the worker task execution. Can be overridden.
@@ -381,83 +415,104 @@ Can be overridden.The worker node key.
The task to execute.
+Protected
chooseProtected
checkProtected
createChooses a worker node for the next task.
-The default worker choice strategy uses a round robin algorithm to distribute the load.
+Creates a new, completely set up dynamic worker node.
The worker node key
+New, completely set up dynamic worker node key.
-Protected
createProtected
createCreates a new worker and sets it up completely in the pool worker nodes.
+Creates a new, completely set up worker node.
New, completely set up worker.
+New, completely set up worker node key.
+Protected
createReturns a newly created worker.
+Creates a new worker.
Newly created worker.
+ +Shutdowns every current worker in this pool.
+Terminates all workers in this pool.
Protected
destroyProtected
destroyShutdowns the given worker.
+Terminates the worker node given its worker node key.
A worker within workerNodes
.
The worker node key.
Executes the specified function 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.
+The optional task input data for the specified task function. This can only be structured-cloneable data.
Optional
name: stringThe name of the worker function to execute. If not specified, the default worker function will be executed.
+The 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.
@@ -508,16 +568,55 @@ Can be overridden.Protected
flushProtected
getGets the worker information given its worker node key.
+The worker node key.
+The worker information.
+ +Protected
internalProtected
isInherited 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
registerRegisters a listener callback on the given worker.
+Registers a listener callback on the worker given its worker node key.
The worker which should register a listener.
+The worker node key.
Inherited from FixedThreadPool.registerWorkerMessageListener
Protected
sendInherited from FixedThreadPool.sendKillMessageToWorker
+Protected
sendSends the startup message to worker given its worker node key.
+The worker node key.
+Inherited from FixedThreadPool.sendStartupMessageToWorker
+Protected
sendSends a message to the given worker.
+Sends a message to worker given its worker node key.
The worker which should receive the message.
+The worker node key.
The message.
Optional
transferList: TransferListItem[]The optional array of transferable objects.
+Inherited from FixedThreadPool.sendToWorker
Inherited from FixedThreadPool.setTasksQueueOptions
The worker choice strategy.
Inherited from FixedThreadPool.setWorkerChoiceStrategy
Inherited from FixedThreadPool.setWorkerChoiceStrategyOptions
Protected
setupSetup hook to execute code before worker node are created in the abstract constructor. -Can be overridden
+Setup hook to execute code before worker nodes are created in the abstract constructor. +Can be overridden.
Inherited from FixedThreadPool.setupHook
Protected
workerThis function is the listener registered for each worker message.
+This method is the listener registered for each worker message.
The listener function to execute when a message is received from a worker.
@@ -688,20 +841,20 @@ Can be overriddenThis function is the listener registered for each worker message.
+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
Type of data sent to the worker. This can only be serializable data.
+Type of data sent to the worker. This can only be structured-cloneable data.
Response = unknown
-Type of execution response. This can only be serializable data.
+Type of execution response. This can only be structured-cloneable data.
@@ -73,24 +73,32 @@ When the maximum number of threads is reached and workers are busy, an event is info max Size
min Size
+ready
type
+utilization
worker
Methods
opts: PoolOptions<ThreadWorkerWithMessageChannel> = {}
+opts: ThreadPoolOptions = {}
Options for this dynamic thread pool.