X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicThreadPool.html;h=3a9c41ad360a49997464b56018aa52ab3d51c183;hb=54f4e726f7e6c2ee917735b489fafde0dd7100bd;hp=8d55fceda26d6ca3b4f4271a2f5e42d7240005b7;hpb=0e16e60a89029abe61cda7ba293c036298cced05;p=poolifier.git diff --git a/docs/classes/DynamicThreadPool.html b/docs/classes/DynamicThreadPool.html index 8d55fced..3a9c41ad 100644 --- a/docs/classes/DynamicThreadPool.html +++ b/docs/classes/DynamicThreadPool.html @@ -1,4 +1,4 @@ -
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.
-Emitter on which events can be listened to.
Events that can currently be listened to:
'full'
: Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.'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.'busy'
: Emitted when the number of workers created in the pool has reached the maximum size expected and are executing concurrently their tasks quota.'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.'backPressure'
: Emitted when all worker nodes have back pressure (i.e. their tasks queue is full: queue size >= maximum queue size).Protected
Readonly
fileProtected
Readonly
maxMaximum number of threads that can be created by this pool.
Protected
Readonly
numberProtected
Readonly
optsProtected
promiseProtected
workerReadonly
workerReadonly
Internal
workerPool worker nodes.
Protected
fullProtected
maxThe pool maximum size.
Protected
minPrivate
readyProtected
typePrivate
utilizationProtected
workerThe worker node key.
-The received message.
-Protected
afterThe newly created worker node key.
-Protected
beforeThe worker node key.
-The task to execute.
-Protected
checkProtected
createProtected
createProtected
createProtected
destroyThe worker node key.
-Enables/disables the worker tasks queue in this pool.
+Enables/disables the worker node tasks queue in this pool.
Whether to enable or disable the worker tasks queue.
-Whether to enable or disable the worker node tasks queue.
+Optional
tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
-The worker node tasks queue options.
+Optional
Optional
data: DataThe optional task input data for the specified task function. This can only be structured-cloneable data.
-Optional
Optional
name: stringThe optional name of the task function to execute. If not specified, the default task function will be executed.
-Optional
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.
-Optional
Promise that will be fulfilled when the task is completed.
Protected
flushProtected
getGets the worker information given its worker node key.
The worker node key.
-The worker information.
+ +The worker information.
Protected
internalProtected
isProtected
registerThe worker node key.
-The message listener callback.
Protected
sendProtected
sendThe worker node key.
-Protected
sendThe worker node key.
-The message.
-Optional
transferList: TransferListItem[]The optional array of transferable objects.
-Optional
Sets the worker tasks queue options in this pool.
+Sets the worker node tasks queue options in this pool.
The worker tasks queue options.
-The worker node tasks queue options.
+The worker choice strategy.
-Optional
workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
-Optional
The worker choice strategy options.
-Protected
setupProtected
workerGenerated using TypeDoc
Generated using TypeDoc
\ No newline at end of file
Minimum number of threads which are always active.
-