X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FAbstractPool.html;h=e306ebe9c5021637043ffb8fb5f345c46cc09b4e;hb=4e1212db1d198963828820471bde6902277d0388;hp=779ee93646effb18cf2db2facd60b6ff67435493;hpb=b9da9d7e74c720f83482a09d1b883fc83d04f4ed;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index 779ee936..e306ebe9 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,13 +1,13 @@
-
AbstractPool | poolifier - v2.6.37
@@ -49,19 +49,19 @@
IPool < Worker , Data , Response >
+
Defined in src/pools/abstract-pool.ts:59
- Index
+ Index
Constructors
-constructor
+
Properties
-emitter?
+
Accessors
-busy
+
Methods
-add Worker Node
+
add Worker Node
after Task Execution Hook
after Worker Node Setup
before Task Execution Hook
@@ -133,8 +133,8 @@
send Startup Message To Worker
send Statistics Message To Worker
send To Worker
-
set Tasks Queue Max Size
set Tasks Queue Options
+
set Tasks Queue Size
set Worker Choice Strategy
set Worker Choice Strategy Options
setup Hook
@@ -155,7 +155,7 @@
Constructors
-constructor
+constructor
new Abstract Pool < Worker , Data , Response > ( numberOfWorkers , filePath , opts ) : AbstractPool < Worker , Data , Response >
@@ -176,19 +176,22 @@
numberOfWorkers : number
+
+
filePath : string
+
+
+
+
Returns AbstractPool < Worker , Data , Response >
+
Defined in src/pools/abstract-pool.ts:115
Protected
Readonly
file Path
file Path : string
@@ -217,7 +220,7 @@
+Defined in src/pools/abstract-pool.ts:117
Protected
Optional
Readonly
max
max ?: number
@@ -225,7 +228,7 @@
+
Defined in src/pools/abstract-pool.ts:93
Protected
Readonly
number Of Workers
number Of Workers : number
@@ -233,7 +236,7 @@
+
Defined in src/pools/abstract-pool.ts:116
Protected
Readonly
opts
@@ -241,7 +244,7 @@
+Defined in src/pools/abstract-pool.ts:118
Protected
promise Response Map
@@ -254,7 +257,7 @@
+Defined in src/pools/abstract-pool.ts:78
Private
Readonly
start Timestamp
start Timestamp : number
@@ -262,7 +265,7 @@
+Defined in src/pools/abstract-pool.ts:106
Private
started
started : boolean
@@ -270,7 +273,7 @@
+Defined in src/pools/abstract-pool.ts:102
Private
Readonly
starting
starting : boolean
@@ -278,7 +281,7 @@
+Defined in src/pools/abstract-pool.ts:98
Protected
worker Choice Strategy Context
@@ -286,7 +289,7 @@
+Defined in src/pools/abstract-pool.ts:84
Readonly
Internal
worker Nodes
@@ -295,7 +298,7 @@
+Defined in src/pools/abstract-pool.ts:65
Protected
full
@@ -321,7 +324,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:689
+Defined in src/pools/abstract-pool.ts:350
Protected
max Size
@@ -344,7 +347,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:562
Protected
min Size
@@ -355,7 +358,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:555
Private
ready
@@ -366,7 +369,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:507
Protected
Abstract
type
@@ -378,7 +381,7 @@
Returns "fixed" | "dynamic"
+Defined in src/pools/abstract-pool.ts:545
+Defined in src/pools/abstract-pool.ts:524
Protected
Abstract
worker
@@ -401,7 +404,7 @@
Returns "thread" | "cluster"
+Defined in src/pools/abstract-pool.ts:550
Protected
after Task Execution Hook
@@ -439,15 +443,17 @@ Can be overridden.
workerNodeKey : number
+
+
message : MessageValue < Response , unknown >
+
+
Returns void
+Defined in src/pools/abstract-pool.ts:888
Protected
after Worker Node Setup
@@ -462,11 +468,12 @@ Can be overridden.
workerNodeKey : number
+
+
Returns void
+Defined in src/pools/abstract-pool.ts:1162
Protected
before Task Execution Hook
@@ -481,15 +488,17 @@ Can be overridden.
workerNodeKey : number
+
+
task : Task < Data >
+
+
Returns void
+Defined in src/pools/abstract-pool.ts:858
Private
build Tasks Queue Options
@@ -502,7 +511,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:672
Private
check And Emit Dynamic Worker Creation Events
@@ -510,7 +519,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1393
Private
check And Emit Task Execution Events
@@ -518,7 +527,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1381
Private
check And Emit Task Queuing Events
@@ -526,7 +535,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1387
Protected
check Dynamic Pool Size
@@ -541,7 +550,7 @@ Can be overridden.
max : number
Returns void
+Defined in src/pools/abstract-pool.ts:187
Private
check File Path
@@ -554,7 +563,7 @@ Can be overridden.
filePath : string
Returns void
+Defined in src/pools/abstract-pool.ts:156
Private
check Message Worker Id
@@ -568,13 +577,14 @@ Can be overridden.
message : MessageValue < Response , unknown >
+
+
Returns void
+Defined in src/pools/abstract-pool.ts:572
Private
check Number Of Workers
@@ -587,7 +597,7 @@ Can be overridden.
numberOfWorkers : number
Returns void
+Defined in src/pools/abstract-pool.ts:169
Private
check Pool Options
@@ -600,7 +610,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:213
Private
check Valid Tasks Queue Options
@@ -613,7 +623,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:295
Private
check Valid Worker Choice Strategy
@@ -626,7 +636,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:241
Private
check Valid Worker Choice Strategy Options
@@ -639,7 +649,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:251
Private
choose Worker Node
@@ -652,7 +662,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1015
Protected
create And Setup Dynamic Worker Node
@@ -664,7 +674,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1105
Protected
create And Setup Worker Node
@@ -676,7 +686,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1061
Protected
Abstract
create Worker
@@ -688,7 +698,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1054
Private
dequeue Task
@@ -701,7 +711,7 @@ Can be overridden.
workerNodeKey : number
Returns undefined | Task < Data >
+Defined in src/pools/abstract-pool.ts:1483
+Defined in src/pools/abstract-pool.ts:803
Protected
Abstract
destroy Worker Node
@@ -727,11 +737,12 @@ Can be overridden.
workerNodeKey : number
+
+
Returns Promise < void >
+Defined in src/pools/abstract-pool.ts:834
enable Tasks Queue
@@ -745,16 +756,18 @@ Can be overridden.
enable : boolean
+
+
Optional
+
+
Returns void
+Defined in src/pools/abstract-pool.ts:643
Private
enqueue Task
@@ -769,7 +782,7 @@ Can be overridden.
task : Task < Data >
Returns number
+Defined in src/pools/abstract-pool.ts:1477
execute
@@ -783,21 +796,24 @@ 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:747
Private
execute Task
@@ -811,15 +827,17 @@ Can be overridden.
workerNodeKey : number
+
+
task : Task < Data >
+
+
Returns void
+Defined in src/pools/abstract-pool.ts:1471
Protected
flush Tasks Queue
@@ -832,7 +850,7 @@ Can be overridden.
workerNodeKey : number
Returns void
+Defined in src/pools/abstract-pool.ts:1491
Private
flush Tasks Queues
@@ -840,11 +858,11 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1501
Protected
get Worker Info
-get Worker Info ( workerNodeKey ) : undefined | WorkerInfo
+get Worker Info ( workerNodeKey ) : WorkerInfo
@@ -854,12 +872,13 @@ Can be overridden.
workerNodeKey : number
-The worker information.
+
+
+The worker information.
+Defined in src/pools/abstract-pool.ts:1407
Private
get Worker Node Key By Worker
@@ -873,12 +892,13 @@ 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:591
Private
get Worker Node Key By Worker Id
@@ -892,12 +912,13 @@ 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:603
Private
handle Task Execution Response
@@ -910,7 +931,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1353
Private
handle Worker Ready Response
@@ -923,7 +944,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1339
Private
has Back Pressure
@@ -931,7 +952,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:1456
has Worker Node Back Pressure
@@ -945,13 +966,14 @@ Can be overridden.
workerNodeKey : number
+
+
Returns boolean true
if the worker node has back pressure, false
otherwise.
+Defined in src/pools/abstract-pool.ts:1449
Protected
internal Busy
@@ -963,7 +985,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:705
Protected
Abstract
is Main
@@ -974,7 +996,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:849
+Defined in src/pools/abstract-pool.ts:726
Private
redistribute Queued Tasks
@@ -1000,7 +1022,7 @@ Can be overridden.
workerNodeKey : number
Returns void
+Defined in src/pools/abstract-pool.ts:1202
Protected
Abstract
register Worker Message Listener
@@ -1019,11 +1041,13 @@ Can be overridden.
workerNodeKey : number
+
+
listener : ( ( message ) => void )
+
@@ -1038,7 +1062,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1149
Private
remove Worker Node
@@ -1052,11 +1076,12 @@ Can be overridden.
worker : Worker
+
+
Returns void
+Defined in src/pools/abstract-pool.ts:1440
Protected
send Kill Message To Worker
@@ -1071,7 +1096,7 @@ Can be overridden.
workerId : number
Returns Promise < void >
+Defined in src/pools/abstract-pool.ts:813
Protected
Abstract
send Startup Message To Worker
@@ -1085,11 +1110,12 @@ Can be overridden.
workerNodeKey : number
+
+
Returns void
+Defined in src/pools/abstract-pool.ts:1182
Private
send Statistics Message To Worker
@@ -1103,11 +1129,12 @@ Can be overridden.
workerNodeKey : number
+
+
Returns void
+Defined in src/pools/abstract-pool.ts:1189
Protected
Abstract
send To Worker
@@ -1121,32 +1148,22 @@ Can be overridden.
workerNodeKey : number
+
+
+
+
Optional
transferList : TransferListItem []
Optional
+
+
Returns void
-
-Private
set Tasks Queue Max Size
-
-set Tasks Queue Max Size ( size ) : void
-
-
-Returns void
+Defined in src/pools/abstract-pool.ts:1043
set Tasks Queue Options
@@ -1160,12 +1177,26 @@ Can be overridden.
+
+
Returns void
+Defined in src/pools/abstract-pool.ts:655
+
+Private
set Tasks Queue Size
+
+set Tasks Queue Size ( size ) : void
+
+
+Returns void
set Worker Choice Strategy
@@ -1179,16 +1210,18 @@ 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:610
set Worker Choice Strategy Options
@@ -1202,12 +1235,13 @@ Can be overridden.
+
+
Returns void
+Defined in src/pools/abstract-pool.ts:629
Protected
setup Hook
@@ -1219,7 +1253,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:842
Private
shall Create Dynamic Worker
@@ -1231,7 +1265,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1032
Private
shall Execute Task
@@ -1244,7 +1278,7 @@ Can be overridden.
workerNodeKey : number
Returns boolean
+Defined in src/pools/abstract-pool.ts:738
Private
shall Update Task Function Worker Usage
@@ -1258,12 +1292,13 @@ Can be overridden.
workerNodeKey : number
+
+
Returns boolean true
if the worker node shall update its task function worker usage, false
otherwise.
+Defined in src/pools/abstract-pool.ts:921
Private
start Pool
@@ -1271,7 +1306,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:337
Private
task Stealing On Empty Queue
@@ -1284,7 +1319,7 @@ Can be overridden.
workerId : number
Returns void
+Defined in src/pools/abstract-pool.ts:1246
Private
tasks Queue Size
@@ -1297,7 +1332,7 @@ Can be overridden.
workerNodeKey : number
Returns number
+Defined in src/pools/abstract-pool.ts:1487
Private
tasks Stealing On Back Pressure
@@ -1310,7 +1345,7 @@ Can be overridden.
workerId : number
Returns void
+Defined in src/pools/abstract-pool.ts:1278
Private
update Elu Worker Usage
@@ -1325,7 +1360,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:975
Private
update Run Time Worker Usage
@@ -1340,7 +1375,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:948
Private
update Task Statistics Worker Usage
@@ -1355,7 +1390,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:930
Private
update Task Stolen Statistics Worker Usage
@@ -1370,7 +1405,7 @@ Can be overridden.
taskName : string
Returns void
+Defined in src/pools/abstract-pool.ts:1227
Private
update Wait Time Worker Usage
@@ -1385,7 +1420,7 @@ Can be overridden.
task : Task < Data >
Returns void
+Defined in src/pools/abstract-pool.ts:962
Protected
worker Listener
@@ -1412,20 +1447,20 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1321
+poolifier - v2.6.44
+
-
\ No newline at end of file
+
\ No newline at end of file
Number of workers that this pool should manage.
-