X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FDynamicClusterPool.html;h=7f63aa01e4b9ae3f7de7d090bda87a4de9259879;hb=4e1212db1d198963828820471bde6902277d0388;hp=e63d126d2c2b366596a44eb1746346ae7e06383e;hpb=95d287d1625c80929657a9f217774c5c8f6668e7;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index e63d126d..7f63aa01 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -1,13 +1,13 @@ -
Maximum number of workers that can be created by this pool.
-Path to an implementation of a ClusterWorker
file, which can be relative or absolute.
Options for this dynamic cluster 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
getThe worker node key.
-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.
-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 workers which are always active.
-