X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicThreadPool.html;h=c03d97602875426e0db043c5929bac798b9e384e;hb=c11be5eddc7229e4b77105ed27e93697b65d0146;hp=bd30fb69eecd9d0d7ccf00b200e0beb6aa8f9739;hpb=95d287d1625c80929657a9f217774c5c8f6668e7;p=poolifier.git diff --git a/docs/classes/DynamicThreadPool.html b/docs/classes/DynamicThreadPool.html index bd30fb69..c03d9760 100644 --- a/docs/classes/DynamicThreadPool.html +++ b/docs/classes/DynamicThreadPool.html @@ -1,13 +1,13 @@ -
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.
-Protected
Readonly
fileProtected
Readonly
maxProtected
Readonly
numberProtected
Readonly
optsProtected
promiseThe task 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
workerReadonly
Internal
workerProtected
fullProtected
maxProtected
minPrivate
readyProtected
typePrivate
utilizationProtected
workerAdds a task function to this pool. +If a task function with the same name already exists, it will be overwritten.
+The name of the task function.
+The task function.
+true
if the task function was added, false
otherwise.
https://nodejs.org/api/errors.html#class-typeerror If the name
parameter is not a string or an empty string.
https://nodejs.org/api/errors.html#class-typeerror If the fn
parameter is not a function.
Protected
afterThe 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
deregisterDeregisters a listener callback on the worker given its worker node key.
+The worker node key.
+The message listener callback.
+Protected
destroyThe worker node key.
-Whether to enable or disable the worker node tasks queue.
-Optional
tasksQueueOptions: TasksQueueOptionsThe 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
getThe worker node key.
-The worker information.
The worker node key.
-true
if the worker node has back pressure, false
otherwise.
Protected
internalProtected
isProtected
registerRegisters once a listener callback on the worker given its worker node key.
+The worker node key.
+The message listener callback.
+Protected
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
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
Minimum number of threads which are always active.
-