X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=docs%2Fclasses%2FAbstractPool.html;h=48d436c8a7e1ce36227e088badf7c1e00fb46e9f;hb=8cc4ea811611b8ad77c7b0379911afe497f2e7e4;hp=ac61238ccf805c177c072009a26f5d8ba56e1087;hpb=3c7c9bd12cf4b0cec0e0a3825c31f7cc9f3f58fe;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index ac61238c..48d436c8 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,4 +1,4 @@
-
AbstractPool | poolifier - v2.6.21
+AbstractPool | poolifier - v2.6.28
@@ -49,7 +49,7 @@
IPool < Worker , Data , Response >
+
Defined in src/pools/abstract-pool.ts:56
@@ -119,12 +120,14 @@
handle Worker Ready Response
internal Busy
is Main
+
list Task Functions
redistribute Queued Tasks
register Worker Message Listener
remove Worker Node
+
send Kill Message To Worker
send Startup Message To Worker
+
send Statistics Message To Worker
send To Worker
-
send Worker Statistics Message To Worker
set Tasks Queue Options
set Worker Choice Strategy
set Worker Choice Strategy Options
@@ -177,7 +180,7 @@
Returns AbstractPool < Worker , Data , Response >
+
Defined in src/pools/abstract-pool.ts:107
Protected
Readonly
number Of Workers
number Of Workers : number
@@ -212,7 +216,7 @@
+Defined in src/pools/abstract-pool.ts:108
Protected
Readonly
opts
@@ -220,7 +224,7 @@
+Defined in src/pools/abstract-pool.ts:110
Protected
promise Response Map
@@ -233,7 +237,7 @@
+Defined in src/pools/abstract-pool.ts:75
Private
Readonly
start Timestamp
start Timestamp : number
@@ -241,7 +245,7 @@
+Defined in src/pools/abstract-pool.ts:94
Private
Readonly
starting
starting : boolean
@@ -249,7 +253,15 @@
+Defined in src/pools/abstract-pool.ts:90
+
+Private
task Functions
+task Functions : string []
+
+
Protected
worker Choice Strategy Context
@@ -257,7 +269,7 @@
+Defined in src/pools/abstract-pool.ts:81
Readonly
worker Nodes
@@ -266,7 +278,7 @@
+Defined in src/pools/abstract-pool.ts:62
Protected
full
@@ -292,7 +304,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:615
+Defined in src/pools/abstract-pool.ts:308
Protected
Abstract
max Size
@@ -315,7 +327,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:504
Protected
Abstract
min Size
@@ -326,7 +338,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:499
Private
ready
@@ -337,7 +349,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:451
Protected
Abstract
type
@@ -349,7 +361,7 @@
Returns "fixed" | "dynamic"
+Defined in src/pools/abstract-pool.ts:489
+Defined in src/pools/abstract-pool.ts:468
Protected
Abstract
worker
@@ -372,7 +384,7 @@
Returns "thread" | "cluster"
+Defined in src/pools/abstract-pool.ts:494
Protected
after Task Execution Hook
@@ -421,7 +433,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:795
Protected
after Worker Node Setup
@@ -441,7 +453,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1028
Protected
before Task Execution Hook
@@ -466,7 +478,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:774
Private
build Tasks Queue Options
@@ -479,7 +491,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:602
Private
check And Emit Events
@@ -487,7 +499,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1168
Protected
check Dynamic Pool Size
@@ -502,7 +514,7 @@ Can be overridden.
max : number
Returns void
+Defined in src/pools/abstract-pool.ts:180
Private
check File Path
@@ -515,7 +527,7 @@ Can be overridden.
filePath : string
Returns void
+Defined in src/pools/abstract-pool.ts:149
Private
check Message Worker Id
+Defined in src/pools/abstract-pool.ts:512
Private
check Number Of Workers
@@ -549,7 +561,7 @@ Can be overridden.
numberOfWorkers : number
Returns void
+Defined in src/pools/abstract-pool.ts:162
Private
check Pool Options
@@ -562,7 +574,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:206
Private
check Valid Tasks Queue Options
@@ -575,7 +587,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:271
Private
check Valid Worker Choice Strategy
@@ -588,7 +600,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:233
Private
check Valid Worker Choice Strategy Options
@@ -601,7 +613,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:243
Private
choose Worker Node
@@ -614,7 +626,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:889
Protected
create And Setup Dynamic Worker Node
@@ -626,7 +638,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:975
Protected
create And Setup Worker Node
@@ -638,7 +650,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:935
Protected
Abstract
create Worker
@@ -650,7 +662,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:928
Private
dequeue Task
@@ -663,7 +675,7 @@ Can be overridden.
workerNodeKey : number
Returns undefined | Task < Data >
+Defined in src/pools/abstract-pool.ts:1238
+Defined in src/pools/abstract-pool.ts:720
Protected
Abstract
destroy Worker Node
@@ -694,7 +706,7 @@ Can be overridden.
Returns Promise < void >
+Defined in src/pools/abstract-pool.ts:750
+Defined in src/pools/abstract-pool.ts:580
Private
enqueue Task
@@ -734,11 +746,11 @@ Can be overridden.
task : Task < Data >
Returns number
+Defined in src/pools/abstract-pool.ts:1234
execute
-execute ( data ? , name ? ) : Promise < Response >
+execute ( data ? , name ? , transferList ? ) : Promise < Response >
@@ -747,12 +759,17 @@ Can be overridden.
Optional
data : Data
-
Returns void
+Defined in src/pools/abstract-pool.ts:1246
Private
flush Tasks Queues
@@ -805,7 +822,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1256
Protected
get Worker Info
@@ -825,7 +842,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1185
Private
get Worker Node Key By Worker
@@ -845,7 +862,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:531
Private
get Worker Node Key By Worker Id
@@ -865,7 +882,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:543
Private
handle Task Execution Response
@@ -878,7 +895,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1139
Private
handle Worker Ready Response
@@ -891,19 +908,19 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1127
Protected
internal Busy
internal Busy ( ) : boolean
-
Returns void
+Defined in src/pools/abstract-pool.ts:1062
Protected
Abstract
register Worker Message Listener
@@ -967,7 +997,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1015
Private
remove Worker Node
@@ -986,7 +1016,22 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1215
+
+Protected
send Kill Message To Worker
+
+send Kill Message To Worker ( workerNodeKey , workerId ) : Promise < void >
+
+
+
Parameters
+
+
+workerNodeKey : number
+
+workerId : number
+Returns Promise < void >
Protected
Abstract
send Startup Message To Worker
@@ -1005,13 +1050,13 @@ Can be overridden.
Returns void
-
-Protected
Abstract
send To Worker
-
+
+Private
send Statistics Message To Worker
+
+send Statistics Message To Worker ( workerNodeKey ) : void
-
Returns void
+Defined in src/pools/abstract-pool.ts:850
Private
update Run Time Worker Usage
@@ -1188,7 +1238,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:824
Private
update Task Statistics Worker Usage
@@ -1203,7 +1253,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:811
Private
update Wait Time Worker Usage
@@ -1218,7 +1268,7 @@ Can be overridden.
task : Task < Data >
Returns void
+Defined in src/pools/abstract-pool.ts:836
Protected
worker Listener
@@ -1245,7 +1295,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1111
Emitter on which events can be listened to.
Events that can currently be listened to:
-
+
+- '
@@ -196,7 +200,7 @@ +'full'
: Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.'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.'error'
: Emitted when an uncaught error occurs.'taskError'
: Emitted when an error occurs while executing a task.Protected
Readonly
file