X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicThreadPool.html;h=83acc6eb74f7161a5f5c73c93a55ab53475f3c0d;hb=b6fea09e6a8174e664770741943cf08445066e2b;hp=d76ec5385a66d793921a74fe6fcdc840dce9b97c;hpb=2041f3d8b2564bfab8e30db6a87dba283219ca86;p=poolifier.git diff --git a/docs/classes/DynamicThreadPool.html b/docs/classes/DynamicThreadPool.html index d76ec538..83acc6eb 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
promiseProtected
workerReadonly
Internal
workerProtected
fullProtected
maxProtected
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.
-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
getGets the worker information given its worker node key.
The worker node key.
-The worker information.
+ + +The worker information.
The worker node key.
-true
if the worker node has back pressure, false
otherwise.
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
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.
-