X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FAbstractPool.html;h=be753f26c66d6837b8e47043f8cb866625b74dfd;hb=df7349e2151c2e46d0bf2c406a5d8bd14d1ed2bf;hp=08cf199db605182faa03c59bc7b3ef5e04cd156b;hpb=f04db52f666beefda86a0444fb9a28d410211b3f;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index 08cf199d..be753f26 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,4 +1,4 @@
-
AbstractPool | poolifier - v2.6.20
+AbstractPool | poolifier - v2.6.31
@@ -49,7 +49,7 @@
IPool < Worker , Data , Response >
+
Defined in src/pools/abstract-pool.ts:56
@@ -63,6 +63,7 @@
Properties
emitter?
file Path
+
max?
number Of Workers
opts
promise Response Map
@@ -90,7 +91,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
@@ -117,19 +120,24 @@
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
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
setup Hook
shall Create Dynamic Worker
+
shall Update Task Function Worker Usage
start Pool
tasks Queue Size
update Elu Worker Usage
@@ -177,7 +185,7 @@
Returns AbstractPool < Worker , Data , Response >
+
Defined in src/pools/abstract-pool.ts:108
Protected
Readonly
file Path
file Path : string
@@ -204,7 +214,15 @@
+Defined in src/pools/abstract-pool.ts:110
+
+Protected
Optional
Readonly
max
+max ?: number
+
+
Protected
Readonly
number Of Workers
number Of Workers : number
@@ -212,7 +230,7 @@
+
Defined in src/pools/abstract-pool.ts:109
Protected
Readonly
opts
@@ -220,7 +238,7 @@
+Defined in src/pools/abstract-pool.ts:111
Protected
promise Response Map
@@ -233,7 +251,7 @@
+Defined in src/pools/abstract-pool.ts:75
Private
Readonly
start Timestamp
start Timestamp : number
@@ -241,7 +259,7 @@
+Defined in src/pools/abstract-pool.ts:99
Private
Readonly
starting
starting : boolean
@@ -249,7 +267,7 @@
+Defined in src/pools/abstract-pool.ts:95
Protected
worker Choice Strategy Context
@@ -257,16 +275,16 @@
+Defined in src/pools/abstract-pool.ts:81
-Readonly
worker Nodes
+Readonly
Internal
worker Nodes
+Defined in src/pools/abstract-pool.ts:62
Protected
full
@@ -292,7 +310,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:641
+Defined in src/pools/abstract-pool.ts:324
-Protected
Abstract
max Size
+Protected
max Size
get maxSize( ) : number
@@ -315,9 +333,9 @@
Returns number
+Defined in src/pools/abstract-pool.ts:525
-Protected
Abstract
min Size
+Protected
min Size
get minSize( ) : number
@@ -326,7 +344,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:518
Private
ready
@@ -337,7 +355,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:470
Protected
Abstract
type
@@ -349,7 +367,7 @@
Returns "fixed" | "dynamic"
+Defined in src/pools/abstract-pool.ts:508
+Defined in src/pools/abstract-pool.ts:487
Protected
Abstract
worker
-get worker( ) : "cluster" | "thread"
+get worker( ) : "thread" | "cluster"
-Returns "cluster" | "thread"
+Returns "thread" | "cluster"
+Defined in src/pools/abstract-pool.ts:513
Protected
after Task Execution Hook
@@ -421,7 +439,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:834
Protected
after Worker Node Setup
@@ -441,7 +459,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1109
Protected
before Task Execution Hook
@@ -466,7 +484,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:804
Private
build Tasks Queue Options
@@ -479,15 +497,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:1266
+
+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
@@ -502,7 +536,7 @@ Can be overridden.
max : number
Returns void
+Defined in src/pools/abstract-pool.ts:179
Private
check File Path
@@ -515,7 +549,7 @@ Can be overridden.
filePath : string
Returns void
+Defined in src/pools/abstract-pool.ts:148
Private
check Message Worker Id
+Defined in src/pools/abstract-pool.ts:535
Private
check Number Of Workers
@@ -549,7 +583,7 @@ Can be overridden.
numberOfWorkers : number
Returns void
+Defined in src/pools/abstract-pool.ts:161
Private
check Pool Options
@@ -562,7 +596,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:205
Private
check Valid Tasks Queue Options
@@ -575,7 +609,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:287
Private
check Valid Worker Choice Strategy
@@ -588,7 +622,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 +635,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:243
Private
choose Worker Node
@@ -614,7 +648,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:966
Protected
create And Setup Dynamic Worker Node
@@ -626,7 +660,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1052
Protected
create And Setup Worker Node
@@ -638,7 +672,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1012
Protected
Abstract
create Worker
@@ -650,7 +684,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1005
Private
dequeue Task
@@ -663,7 +697,7 @@ Can be overridden.
workerNodeKey : number
Returns undefined | Task < Data >
+Defined in src/pools/abstract-pool.ts:1357
+Defined in src/pools/abstract-pool.ts:750
Protected
Abstract
destroy Worker Node
@@ -694,7 +728,7 @@ Can be overridden.
Returns Promise < void >
+Defined in src/pools/abstract-pool.ts:780
+Defined in src/pools/abstract-pool.ts:606
Private
enqueue Task
@@ -734,11 +768,11 @@ Can be overridden.
task : Task < Data >
Returns number
+Defined in src/pools/abstract-pool.ts:1351
execute
-execute ( data ? , name ? ) : Promise < Response >
+execute ( data ? , name ? , transferList ? ) : Promise < Response >
@@ -747,12 +781,17 @@ Can be overridden.
Optional
data : Data
-
Returns void
+Defined in src/pools/abstract-pool.ts:1365
Private
flush Tasks Queues
@@ -805,11 +844,11 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1375
Protected
get Worker Info
-get Worker Info ( workerNodeKey ) : WorkerInfo
+get Worker Info ( workerNodeKey ) : undefined | WorkerInfo
@@ -821,11 +860,11 @@ Can be overridden.
-The worker information.
+The worker information.
+Defined in src/pools/abstract-pool.ts:1280
Private
get Worker Node Key By Worker
@@ -845,7 +884,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:554
Private
get Worker Node Key By Worker Id
@@ -865,7 +904,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:566
Private
handle Task Execution Response
@@ -878,7 +917,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1226
Private
handle Worker Ready Response
@@ -891,19 +930,48 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1212
+
+Private
has Back Pressure
+
+has Back Pressure ( ) : boolean
+
+Returns boolean
+
+has Worker Node Back Pressure
+
Protected
internal Busy
internal Busy ( ) : boolean
-
Returns void
+Defined in src/pools/abstract-pool.ts:1143
Protected
Abstract
register Worker Message Listener
@@ -967,7 +1048,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1096
Private
remove Worker Node
@@ -986,7 +1067,22 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1314
+
+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 +1101,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:927
Private
update Run Time Worker Usage
@@ -1188,7 +1309,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:901
Private
update Task Statistics Worker Usage
@@ -1203,7 +1324,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:876
Private
update Wait Time Worker Usage
@@ -1218,7 +1339,7 @@ Can be overridden.
task : Task < Data >
Returns void
+Defined in src/pools/abstract-pool.ts:913
Protected
worker Listener
@@ -1245,7 +1366,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1192
Emitter on which events can be listened to.
Events that can currently be listened to:
-
+
+- '
+
'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.'backPressure'
: Emitted when all worker nodes have back pressure (i.e. their tasks queue is full: queue size >= pool maximum size^2).