X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FDynamicClusterPool.html;h=0c403e1718a1a44878d560d15c650ccef0054297;hb=0bb3df76aeab8a2af9e99ccf91d9e9cc5e751674;hp=0ccad3578199b61ef5dbf320ddeb39b9165bbf88;hpb=3882157ecadc80e686b319068bd73a9cc218e10c;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index 0ccad357..0c403e17 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -1,4 +1,4 @@ -
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 >= pool maximum size^2).'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
maxProtected
Readonly
numberProtected
Readonly
optsProtected
promiseProtected
workerReadonly
Internal
workerProtected
fullProtected
maxProtected
minPrivate
readyProtected
typePrivate
utilizationProtected
workerProtected
afterProtected
beforeProtected
checkProtected
createProtected
createProtected
createProtected
destroy
Enables/disables the worker tasks queue in this pool.
+Enables/disables the worker node tasks queue in this pool.
Parameters
enable: boolean
-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.
Returns void
execute
@@ -571,7 +571,7 @@ Can be overridden.
Protected
flush@@ -585,11 +585,11 @@ Can be overridden.
Returns void
Protected
get-- get
Worker Info(workerNodeKey): WorkerInfo
+- get
Worker Info(workerNodeKey): undefined | WorkerInfo
-
@@ -601,12 +601,12 @@ Can be overridden.
Gets the worker information given its worker node key.
The worker node key.
Returns WorkerInfo
The worker information.
+Returns undefined | WorkerInfo
The worker information.
has Worker Node Back Pressure
@@ -627,7 +627,7 @@ Can be overridden.
Protected
internal@@ -640,7 +640,7 @@ Can be overridden.
Protected
is@@ -652,7 +652,7 @@ Can be overridden.
list Task Functions
@@ -665,7 +665,7 @@ Can be overridden.
Protected
register@@ -706,7 +706,7 @@ Can be overridden.
Protected
send@@ -722,7 +722,7 @@ Can be overridden.
Returns Promise<void>
Protected
send@@ -742,7 +742,7 @@ Can be overridden.
Protected
send@@ -767,27 +767,27 @@ Can be overridden.
set Tasks Queue Options
Sets the worker tasks queue options in this pool.
+Sets the worker node tasks queue options in this pool.
Parameters
tasksQueueOptions: TasksQueueOptions
-The worker tasks queue options.
+The worker node tasks queue options.
Returns void
set Worker Choice Strategy
@@ -812,7 +812,7 @@ Can be overridden.
set Worker Choice Strategy Options
@@ -832,7 +832,7 @@ Can be overridden.
Protected
setup@@ -845,7 +845,7 @@ Can be overridden.
Protected
worker@@ -873,7 +873,7 @@ Can be overridden.