X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedClusterPool.html;h=3c06ec2642e78afc09fa51d4a8240e0980269e52;hb=ef29303558d4caf5ff412db9579ea28346b77f3f;hp=1716132ec7d23928b8eb717416704e153e50eace;hpb=a25c335d7e5573a171fc96c445cb6092852b2c4a;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index 1716132e..3c06ec26 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -1,13 +1,13 @@ -
Events that can currently be listened to:
'ready'
: Emitted when the number of workers created in the pool has reached the minimum size expected and are ready.'busy'
: Emitted when the number of workers created in the pool has reached the maximum size expected and are executing at least one task.'busy'
: Emitted when the number of workers created in the pool has reached the maximum size expected and are executing concurrently their tasks quota.'full'
: Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.destroy
': Emitted when the pool is destroyed.'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
promiseGenerated using TypeDoc
Generated using TypeDoc
The 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
workerAccessors
Protected
full@@ -262,7 +263,7 @@
info
@@ -274,7 +275,7 @@
Protected
max@@ -286,7 +287,7 @@
Protected
min@@ -298,7 +299,7 @@
Private
ready@@ -310,7 +311,7 @@
Protected
type@@ -323,7 +324,7 @@
Private
utilization@@ -336,7 +337,7 @@
Protected
worker@@ -348,7 +349,7 @@
Methods
Protected
after@@ -397,7 +398,7 @@ Can be overridden.
Protected
before@@ -423,7 +424,7 @@ Can be overridden.
Protected
check@@ -439,7 +440,7 @@ Can be overridden.
Returns void
Protected
create@@ -452,7 +453,7 @@ Can be overridden.
Protected
create@@ -465,7 +466,7 @@ Can be overridden.
Protected
create@@ -478,7 +479,7 @@ Can be overridden.
destroy
@@ -490,7 +491,7 @@ Can be overridden.
Protected
destroy@@ -510,32 +511,32 @@ Can be overridden.
enable Tasks Queue
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 +567,7 @@ Can be overridden.
Protected
flush@@ -580,7 +581,7 @@ Can be overridden.
Returns void
Protected
get@@ -601,7 +602,7 @@ Can be overridden.
has Worker Node Back Pressure
@@ -622,7 +623,7 @@ Can be overridden.
Protected
internal@@ -635,7 +636,7 @@ Can be overridden.
Protected
is@@ -647,7 +648,7 @@ Can be overridden.
list Task Functions
@@ -660,7 +661,7 @@ Can be overridden.
Protected
register@@ -701,7 +702,7 @@ Can be overridden.
Protected
send@@ -717,7 +718,7 @@ Can be overridden.
Returns Promise<void>
Protected
send@@ -737,7 +738,7 @@ Can be overridden.
Protected
send@@ -762,27 +763,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
@@ -807,7 +808,7 @@ Can be overridden.
set Worker Choice Strategy Options
@@ -827,7 +828,7 @@ Can be overridden.
Protected
setup@@ -840,7 +841,19 @@ Can be overridden.
start
++- start(): void
+-
+
+
Starts the minimum number of workers in this pool.
+Returns void
+Protected
worker@@ -868,20 +881,20 @@ Can be overridden.
-
+Settings
Settings
Member Visibility
Theme
@@ -931,70 +944,33 @@ Can be overridden.- set
Worker Choice Strategy
- set
Worker Choice Strategy Options
- setup
Hook
+- start
- worker
Listener