X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicThreadPool.html;h=5301f5d93bf76eb154dfbb1ac00122cfaac62c6a;hb=ef29303558d4caf5ff412db9579ea28346b77f3f;hp=ad0632c4ab6cb95e036940eebfd90db161e77d22;hpb=936fa0fb8e70b2c297938cc9455444486b6daa3e;p=poolifier.git diff --git a/docs/classes/DynamicThreadPool.html b/docs/classes/DynamicThreadPool.html index ad0632c4..5301f5d9 100644 --- a/docs/classes/DynamicThreadPool.html +++ b/docs/classes/DynamicThreadPool.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
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@@ -267,7 +268,7 @@ When the maximum number of threads is reached and workers are busy, an event is
info
@@ -279,7 +280,7 @@ When the maximum number of threads is reached and workers are busy, an event is
Protected
max@@ -291,7 +292,7 @@ When the maximum number of threads is reached and workers are busy, an event is
Protected
min@@ -303,7 +304,7 @@ When the maximum number of threads is reached and workers are busy, an event is
Private
ready@@ -315,7 +316,7 @@ When the maximum number of threads is reached and workers are busy, an event is
Protected
type@@ -328,7 +329,7 @@ When the maximum number of threads is reached and workers are busy, an event is
Private
utilization@@ -341,7 +342,7 @@ When the maximum number of threads is reached and workers are busy, an event is
Protected
worker@@ -353,7 +354,7 @@ When the maximum number of threads is reached and workers are busy, an event is
Methods
Protected
after@@ -402,7 +403,7 @@ Can be overridden.
Protected
before@@ -428,7 +429,7 @@ Can be overridden.
Protected
check@@ -444,7 +445,7 @@ Can be overridden.
Returns void
Protected
create@@ -457,7 +458,7 @@ Can be overridden.
Protected
create@@ -470,7 +471,7 @@ Can be overridden.
Protected
create@@ -483,7 +484,7 @@ Can be overridden.
destroy
@@ -495,7 +496,7 @@ Can be overridden.
Protected
destroy@@ -515,32 +516,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
@@ -571,7 +572,7 @@ Can be overridden.
Protected
flush@@ -585,7 +586,7 @@ Can be overridden.
Returns void
Protected
get@@ -606,7 +607,7 @@ Can be overridden.
has Worker Node Back Pressure
@@ -627,7 +628,7 @@ Can be overridden.
Protected
internal@@ -640,7 +641,7 @@ Can be overridden.
Protected
is@@ -652,7 +653,7 @@ Can be overridden.
list Task Functions
@@ -665,7 +666,7 @@ Can be overridden.
Protected
register@@ -706,7 +707,7 @@ Can be overridden.
Protected
send@@ -722,7 +723,7 @@ Can be overridden.
Returns Promise<void>
Protected
send@@ -742,7 +743,7 @@ Can be overridden.
Protected
send@@ -772,27 +773,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
@@ -817,7 +818,7 @@ Can be overridden.
set Worker Choice Strategy Options
@@ -837,7 +838,7 @@ Can be overridden.
Protected
setup@@ -850,7 +851,19 @@ Can be overridden.
start
++- start(): void
+-
+
+
Starts the minimum number of workers in this pool.
+Returns void
+Protected
worker@@ -878,20 +891,20 @@ Can be overridden.
-
+Settings
Settings
Member Visibility
Theme
@@ -941,70 +954,33 @@ Can be overridden.- set
Worker Choice Strategy
- set
Worker Choice Strategy Options
- setup
Hook
+- start
- worker
Listener