X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FFixedThreadPool.html;h=c2557b461d595e571b6e70ad55090f01b1695d58;hb=30c799e98a2d088cbca774d347983a04ebc5f5a5;hp=f2bd8f7c02c44eeb3d3b2001c782a4b32c53e750;hpb=46e29227a97fe04f886969199f1c14338af50543;p=poolifier.git diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index f2bd8f7c..c2557b46 100644 --- a/docs/classes/FixedThreadPool.html +++ b/docs/classes/FixedThreadPool.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
Optional
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
@@ -566,7 +566,7 @@ Can be overridden.
Protected
flush@@ -580,11 +580,11 @@ Can be overridden.
Returns void
Protected
get-- get
Worker Info(workerNodeKey): WorkerInfo
+- get
Worker Info(workerNodeKey): undefined | WorkerInfo
-
@@ -596,12 +596,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
@@ -622,7 +622,7 @@ Can be overridden.
Protected
internal@@ -635,7 +635,7 @@ Can be overridden.
Protected
is@@ -647,7 +647,7 @@ Can be overridden.
list Task Functions
@@ -660,7 +660,7 @@ Can be overridden.
Protected
register@@ -701,7 +701,7 @@ Can be overridden.
Protected
send@@ -717,7 +717,7 @@ Can be overridden.
Returns Promise<void>
Protected
send@@ -737,7 +737,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.