X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=c5225675ab7e6ec74e0a984e4f66eedd11108212;hb=728b7bbdfbaf327a620aae50beb974b15a0a33d2;hp=48d436c8a7e1ce36227e088badf7c1e00fb46e9f;hpb=fb8fbcfd7983c1eadc39411c9b29054e6fa97d5b;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index 48d436c8..c5225675 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,4 +1,4 @@
-
AbstractPool | poolifier - v2.6.28
+AbstractPool | poolifier - v2.6.36
@@ -49,7 +49,7 @@
IPool < Worker , Data , Response >
+
Defined in src/pools/abstract-pool.ts:58
@@ -63,12 +63,13 @@
Properties
@@ -91,7 +92,9 @@
after Worker Node Setup
before Task Execution Hook
build Tasks Queue Options
-check And Emit Events
+check And Emit Dynamic Worker Creation Events
+check And Emit Task Execution Events
+check And Emit Task Queuing Events
check Dynamic Pool Size
check File Path
check Message Worker Id
@@ -118,6 +121,8 @@
get Worker Node Key By Worker Id
handle Task Execution Response
handle Worker Ready Response
+has Back Pressure
+has Worker Node Back Pressure
internal Busy
is Main
list Task Functions
@@ -128,13 +133,17 @@
send Startup Message To Worker
send Statistics Message To Worker
send To Worker
+set Tasks Queue Max Size
set Tasks Queue Options
set Worker Choice Strategy
set Worker Choice Strategy Options
setup Hook
shall Create Dynamic Worker
+shall Update Task Function Worker Usage
start Pool
+task Stealing On Empty Queue
tasks Queue Size
+tasks Stealing On Back Pressure
update Elu Worker Usage
update Run Time Worker Usage
update Task Statistics Worker Usage
@@ -165,22 +174,19 @@
numberOfWorkers : number
-
+
filePath : string
-
+
-
+
Returns AbstractPool < Worker , Data , Response >
+Defined in src/pools/abstract-pool.ts:114
Properties
@@ -192,15 +198,16 @@
'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.
'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 >= maximum queue size).
+Defined in src/pools/abstract-pool.ts:67
Protected
Readonly
file Path
file Path : string
@@ -208,7 +215,15 @@
+Defined in src/pools/abstract-pool.ts:116
+
+Protected
Optional
Readonly
max
+max ?: number
+
+
Protected
Readonly
number Of Workers
number Of Workers : number
@@ -216,7 +231,7 @@
+Defined in src/pools/abstract-pool.ts:115
Protected
Readonly
opts
@@ -224,7 +239,7 @@
+Defined in src/pools/abstract-pool.ts:117
Protected
promise Response Map
@@ -237,7 +252,7 @@
+Defined in src/pools/abstract-pool.ts:77
Private
Readonly
start Timestamp
start Timestamp : number
@@ -245,7 +260,15 @@
+Defined in src/pools/abstract-pool.ts:105
+
+Private
started
+started : boolean
+
+
Private
Readonly
starting
starting : boolean
@@ -253,15 +276,7 @@
-
-Private
task Functions
-task Functions : string []
-
-
+Defined in src/pools/abstract-pool.ts:97
Protected
worker Choice Strategy Context
@@ -269,16 +284,16 @@
+Defined in src/pools/abstract-pool.ts:83
-Readonly
worker Nodes
+Readonly
Internal
worker Nodes
+Defined in src/pools/abstract-pool.ts:64
Protected
full
@@ -304,7 +319,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:688
+Defined in src/pools/abstract-pool.ts:349
-Protected
Abstract
max Size
+Protected
max Size
get maxSize( ) : number
@@ -327,9 +342,9 @@
Returns number
+Defined in src/pools/abstract-pool.ts:561
-Protected
Abstract
min Size
+Protected
min Size
get minSize( ) : number
@@ -338,7 +353,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:554
Private
ready
@@ -349,7 +364,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:506
Protected
Abstract
type
@@ -361,7 +376,7 @@
Returns "fixed" | "dynamic"
+Defined in src/pools/abstract-pool.ts:544
+Defined in src/pools/abstract-pool.ts:523
Protected
Abstract
worker
@@ -384,7 +399,7 @@
Returns "thread" | "cluster"
+Defined in src/pools/abstract-pool.ts:549
Protected
after Task Execution Hook
@@ -423,17 +437,15 @@ Can be overridden.
workerNodeKey : number
-
+
message : MessageValue < Response , unknown >
-
+
Returns void
+Defined in src/pools/abstract-pool.ts:881
Protected
after Worker Node Setup
@@ -448,12 +460,11 @@ Can be overridden.
workerNodeKey : number
-
+
Returns void
+Defined in src/pools/abstract-pool.ts:1155
Protected
before Task Execution Hook
@@ -468,17 +479,15 @@ Can be overridden.
workerNodeKey : number
-
+
task : Task < Data >
-
+
Returns void
+Defined in src/pools/abstract-pool.ts:851
Private
build Tasks Queue Options
@@ -491,15 +500,31 @@ Can be overridden.
-
+
+Private
check And Emit Dynamic Worker Creation Events
-check And Emit Events ( ) : void
+check And Emit Dynamic Worker Creation Events ( ) : void
Returns void
+Defined in src/pools/abstract-pool.ts:1409
+
+Private
check And Emit Task Execution Events
+
+check And Emit Task Execution Events ( ) : void
+
+Returns void
+
+Private
check And Emit Task Queuing Events
+
+check And Emit Task Queuing Events ( ) : void
+
+Returns void
Protected
check Dynamic Pool Size
@@ -514,7 +539,7 @@ Can be overridden.
max : number
Returns void
+Defined in src/pools/abstract-pool.ts:186
Private
check File Path
@@ -527,7 +552,7 @@ Can be overridden.
filePath : string
Returns void
+Defined in src/pools/abstract-pool.ts:155
Private
check Message Worker Id
@@ -541,14 +566,13 @@ Can be overridden.
message : MessageValue < Response , unknown >
-
+
Returns void
+Defined in src/pools/abstract-pool.ts:571
Private
check Number Of Workers
@@ -561,7 +585,7 @@ Can be overridden.
numberOfWorkers : number
Returns void
+Defined in src/pools/abstract-pool.ts:168
Private
check Pool Options
@@ -574,7 +598,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:212
Private
check Valid Tasks Queue Options
@@ -584,10 +608,10 @@ Can be overridden.
Parameters
+
Returns void
+Defined in src/pools/abstract-pool.ts:294
Private
check Valid Worker Choice Strategy
@@ -600,7 +624,7 @@ Can be overridden.
workerChoiceStrategy : "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
Returns void
+Defined in src/pools/abstract-pool.ts:240
Private
check Valid Worker Choice Strategy Options
@@ -613,7 +637,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:250
Private
choose Worker Node
@@ -626,7 +650,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1008
Protected
create And Setup Dynamic Worker Node
@@ -638,7 +662,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1098
Protected
create And Setup Worker Node
@@ -650,7 +674,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1054
Protected
Abstract
create Worker
@@ -662,7 +686,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1047
Private
dequeue Task
@@ -675,7 +699,7 @@ Can be overridden.
workerNodeKey : number
Returns undefined | Task < Data >
+Defined in src/pools/abstract-pool.ts:1500
+Defined in src/pools/abstract-pool.ts:796
Protected
Abstract
destroy Worker Node
@@ -701,37 +725,34 @@ Can be overridden.
workerNodeKey : number
-
+
Returns Promise < void >
+Defined in src/pools/abstract-pool.ts:827
enable Tasks Queue
enable Tasks Queue ( enable , tasksQueueOptions ? ) : void
-
Returns void
+Defined in src/pools/abstract-pool.ts:642
Private
enqueue Task
@@ -746,7 +767,7 @@ Can be overridden.
task : Task < Data >
Returns number
+Defined in src/pools/abstract-pool.ts:1494
execute
@@ -760,24 +781,21 @@ Can be overridden.
Optional
data : Data
-
+Optional
Optional
name : string
-
+Optional
Optional
transferList : TransferListItem []
-
+Optional
Returns Promise < Response > Promise that will be fulfilled when the task is completed.
+Defined in src/pools/abstract-pool.ts:738
Private
execute Task
@@ -791,17 +809,15 @@ Can be overridden.
workerNodeKey : number
-
+
task : Task < Data >
-
+
Returns void
+Defined in src/pools/abstract-pool.ts:1488
Protected
flush Tasks Queue
@@ -814,7 +830,7 @@ Can be overridden.
workerNodeKey : number
Returns void
+Defined in src/pools/abstract-pool.ts:1508
Private
flush Tasks Queues
@@ -822,11 +838,11 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1518
Protected
get Worker Info
-get Worker Info ( workerNodeKey ) : WorkerInfo
+get Worker Info ( workerNodeKey ) : undefined | WorkerInfo
@@ -836,13 +852,12 @@ Can be overridden.
workerNodeKey : number
-
-The worker information.
+
+The worker information.
+Defined in src/pools/abstract-pool.ts:1423
Private
get Worker Node Key By Worker
@@ -856,13 +871,12 @@ Can be overridden.
worker : Worker
-
+
Returns number The worker node key if found in the pool worker nodes, -1
otherwise.
+Defined in src/pools/abstract-pool.ts:590
Private
get Worker Node Key By Worker Id
@@ -876,13 +890,12 @@ Can be overridden.
workerId : number
-
+
Returns number The worker node key if the worker id is found in the pool worker nodes, -1
otherwise.
+Defined in src/pools/abstract-pool.ts:602
Private
handle Task Execution Response
@@ -895,7 +908,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1369
Private
handle Worker Ready Response
@@ -908,7 +921,35 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1355
+
+Private
has Back Pressure
+
+has Back Pressure ( ) : boolean
+
+Returns boolean
+
+has Worker Node Back Pressure
+
Protected
internal Busy
@@ -920,7 +961,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:704
Protected
Abstract
is Main
@@ -931,7 +972,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:842
+Defined in src/pools/abstract-pool.ts:725
Private
redistribute Queued Tasks
@@ -957,7 +998,7 @@ Can be overridden.
workerNodeKey : number
Returns void
+Defined in src/pools/abstract-pool.ts:1195
Protected
Abstract
register Worker Message Listener
@@ -976,13 +1017,11 @@ Can be overridden.
workerNodeKey : number
-
+
listener : ( ( message ) => void )
-
@@ -997,7 +1036,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1142
Private
remove Worker Node
@@ -1011,12 +1050,11 @@ Can be overridden.
worker : Worker
-
+
Returns void
+Defined in src/pools/abstract-pool.ts:1457
Protected
send Kill Message To Worker
@@ -1031,7 +1069,7 @@ Can be overridden.
workerId : number
Returns Promise < void >
+Defined in src/pools/abstract-pool.ts:806
Protected
Abstract
send Startup Message To Worker
@@ -1045,12 +1083,11 @@ Can be overridden.
workerNodeKey : number
-
+
Returns void
+Defined in src/pools/abstract-pool.ts:1175
Private
send Statistics Message To Worker
@@ -1064,12 +1101,11 @@ Can be overridden.
workerNodeKey : number
-
+
Returns void
+Defined in src/pools/abstract-pool.ts:1182
Protected
Abstract
send To Worker
@@ -1083,42 +1119,51 @@ Can be overridden.
workerNodeKey : number
-
+
-
+
Optional
transferList : TransferListItem []
-
+Optional
Returns void
+Defined in src/pools/abstract-pool.ts:1036
+
+Private
set Tasks Queue Max Size
+
+set Tasks Queue Max Size ( size ) : void
+
+
+Returns void
set Tasks Queue Options
set Tasks Queue Options ( tasksQueueOptions ) : void
-
Returns void
+Defined in src/pools/abstract-pool.ts:654
set Worker Choice Strategy
@@ -1132,18 +1177,16 @@ Can be overridden.
workerChoiceStrategy : "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
-
+
-
+Optional
Returns void
+Defined in src/pools/abstract-pool.ts:609
set Worker Choice Strategy Options
@@ -1157,13 +1200,12 @@ Can be overridden.
-
+
Returns void
+Defined in src/pools/abstract-pool.ts:628
Protected
setup Hook
@@ -1175,7 +1217,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:835
Private
shall Create Dynamic Worker
@@ -1187,7 +1229,26 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1025
+
+Private
shall Update Task Function Worker Usage
+
Private
start Pool
@@ -1195,7 +1256,20 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:336
+
+Private
task Stealing On Empty Queue
+
+task Stealing On Empty Queue ( workerId ) : void
+
+
+Returns void
Private
tasks Queue Size
@@ -1208,7 +1282,20 @@ Can be overridden.
workerNodeKey : number
Returns number
+Defined in src/pools/abstract-pool.ts:1504
+
+Private
tasks Stealing On Back Pressure
+
+tasks Stealing On Back Pressure ( workerId ) : void
+
+
+Returns void
Private
update Elu Worker Usage
@@ -1223,7 +1310,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:968
Private
update Run Time Worker Usage
@@ -1238,7 +1325,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:941
Private
update Task Statistics Worker Usage
@@ -1253,7 +1340,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:923
Private
update Wait Time Worker Usage
@@ -1268,7 +1355,7 @@ Can be overridden.
task : Task < Data >
Returns void
+Defined in src/pools/abstract-pool.ts:955
Protected
worker Listener
@@ -1295,7 +1382,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1335
+Generated using TypeDoc
\ No newline at end of file
Number of workers that this pool should manage.
-