X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=5d9c47e5236bc1dd4415ad1ad6d983a6c47191be;hb=2447ee8ce5d3db1253c7286482e5a54e84618ecf;hp=ac61238ccf805c177c072009a26f5d8ba56e1087;hpb=a47027a0bf90ce21b528708dadd0eb23b5537b43;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index ac61238c..5d9c47e5 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,4 +1,4 @@
-
AbstractPool | poolifier - v2.6.21
+AbstractPool | poolifier - v2.6.24
@@ -49,7 +49,7 @@
IPool < Worker , Data , Response >
+
Defined in src/pools/abstract-pool.ts:56
@@ -177,7 +177,7 @@
Returns AbstractPool < Worker , Data , Response >
+
Defined in src/pools/abstract-pool.ts:103
Protected
Readonly
file Path
file Path : string
@@ -204,7 +204,7 @@
+
Defined in src/pools/abstract-pool.ts:105
Protected
Readonly
number Of Workers
number Of Workers : number
@@ -212,7 +212,7 @@
+Defined in src/pools/abstract-pool.ts:104
Protected
Readonly
opts
@@ -220,7 +220,7 @@
+Defined in src/pools/abstract-pool.ts:106
Protected
promise Response Map
@@ -233,7 +233,7 @@
+Defined in src/pools/abstract-pool.ts:75
Private
Readonly
start Timestamp
start Timestamp : number
@@ -241,7 +241,7 @@
+Defined in src/pools/abstract-pool.ts:94
Private
Readonly
starting
starting : boolean
@@ -249,7 +249,7 @@
+Defined in src/pools/abstract-pool.ts:90
Protected
worker Choice Strategy Context
@@ -257,7 +257,7 @@
+Defined in src/pools/abstract-pool.ts:81
Readonly
worker Nodes
@@ -266,7 +266,7 @@
+Defined in src/pools/abstract-pool.ts:62
Protected
full
@@ -292,7 +292,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:607
+Defined in src/pools/abstract-pool.ts:302
Protected
Abstract
max Size
@@ -315,7 +315,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:498
Protected
Abstract
min Size
@@ -326,7 +326,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:493
Private
ready
@@ -337,7 +337,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:445
Protected
Abstract
type
@@ -349,7 +349,7 @@
Returns "fixed" | "dynamic"
+Defined in src/pools/abstract-pool.ts:483
+Defined in src/pools/abstract-pool.ts:462
Protected
Abstract
worker
@@ -372,7 +372,7 @@
Returns "thread" | "cluster"
+Defined in src/pools/abstract-pool.ts:488
Protected
after Task Execution Hook
@@ -421,7 +421,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:745
Protected
after Worker Node Setup
@@ -441,7 +441,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:976
Protected
before Task Execution Hook
@@ -466,7 +466,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:724
Private
build Tasks Queue Options
@@ -479,7 +479,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:594
Private
check And Emit Events
@@ -487,7 +487,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1110
Protected
check Dynamic Pool Size
@@ -502,7 +502,7 @@ Can be overridden.
max : number
Returns void
+Defined in src/pools/abstract-pool.ts:174
Private
check File Path
@@ -515,7 +515,7 @@ Can be overridden.
filePath : string
Returns void
+Defined in src/pools/abstract-pool.ts:143
Private
check Message Worker Id
+Defined in src/pools/abstract-pool.ts:506
Private
check Number Of Workers
@@ -549,7 +549,7 @@ Can be overridden.
numberOfWorkers : number
Returns void
+Defined in src/pools/abstract-pool.ts:156
Private
check Pool Options
@@ -562,7 +562,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:200
Private
check Valid Tasks Queue Options
@@ -575,7 +575,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:265
Private
check Valid Worker Choice Strategy
@@ -588,7 +588,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:227
Private
check Valid Worker Choice Strategy Options
@@ -601,7 +601,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:237
Private
choose Worker Node
@@ -614,7 +614,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:839
Protected
create And Setup Dynamic Worker Node
@@ -626,7 +626,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:925
Protected
create And Setup Worker Node
@@ -638,7 +638,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:885
Protected
Abstract
create Worker
@@ -650,7 +650,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:878
Private
dequeue Task
@@ -663,7 +663,7 @@ Can be overridden.
workerNodeKey : number
Returns undefined | Task < Data >
+Defined in src/pools/abstract-pool.ts:1180
+Defined in src/pools/abstract-pool.ts:687
Protected
Abstract
destroy Worker Node
@@ -694,7 +694,7 @@ Can be overridden.
Returns Promise < void >
+Defined in src/pools/abstract-pool.ts:700
+Defined in src/pools/abstract-pool.ts:572
Private
enqueue Task
@@ -734,11 +734,11 @@ Can be overridden.
task : Task < Data >
Returns number
+Defined in src/pools/abstract-pool.ts:1176
execute
-execute ( data ? , name ? ) : Promise < Response >
+execute ( data ? , name ? , transferList ? ) : Promise < Response >
@@ -747,12 +747,17 @@ Can be overridden.
Optional
data : Data
-
Returns void
+Defined in src/pools/abstract-pool.ts:1188
Private
flush Tasks Queues
@@ -805,7 +810,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1198
Protected
get Worker Info
@@ -825,7 +830,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1127
Private
get Worker Node Key By Worker
@@ -845,7 +850,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:523
Private
get Worker Node Key By Worker Id
@@ -865,7 +870,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:535
Private
handle Task Execution Response
@@ -878,7 +883,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1081
Private
handle Worker Ready Response
@@ -891,19 +896,19 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1072
Protected
internal Busy
internal Busy ( ) : boolean
-
Returns void
+Defined in src/pools/abstract-pool.ts:1010
Protected
Abstract
register Worker Message Listener
@@ -967,7 +972,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:963
Private
remove Worker Node
@@ -986,7 +991,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1157
Protected
Abstract
send Startup Message To Worker
@@ -1005,11 +1010,11 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:990
Protected
Abstract
send To Worker
-send To Worker ( workerNodeKey , message ) : void
+send To Worker ( workerNodeKey , message , transferList ? ) : void
@@ -1025,11 +1030,16 @@ Can be overridden.
+
+
+Optional
transferList : TransferListItem []
+
Returns void
+Defined in src/pools/abstract-pool.ts:867
Private
send Worker Statistics Message To Worker
@@ -1048,7 +1058,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:997
+Defined in src/pools/abstract-pool.ts:584
+Defined in src/pools/abstract-pool.ts:542
set Worker Choice Strategy Options
+Defined in src/pools/abstract-pool.ts:561
Protected
setup Hook
@@ -1125,7 +1135,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:708
Private
shall Create Dynamic Worker
@@ -1137,7 +1147,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:856
Private
start Pool
@@ -1145,7 +1155,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:289
Private
tasks Queue Size
@@ -1158,7 +1168,7 @@ Can be overridden.
workerNodeKey : number
Returns number
+Defined in src/pools/abstract-pool.ts:1184
Private
update Elu Worker Usage
@@ -1173,7 +1183,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:800
Private
update Run Time Worker Usage
@@ -1188,7 +1198,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:774
Private
update Task Statistics Worker Usage
@@ -1203,7 +1213,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:761
Private
update Wait Time Worker Usage
@@ -1218,7 +1228,7 @@ Can be overridden.
task : Task < Data >
Returns void
+Defined in src/pools/abstract-pool.ts:786
Protected
worker Listener
@@ -1245,7 +1255,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1059
Executes the specified function in the worker constructor with the task data input parameter.