X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=00d68b3d181866d60a64610ffe52a9cd7260643a;hb=969223ea18802a84dfea369e254332e11bf8e419;hp=ac61238ccf805c177c072009a26f5d8ba56e1087;hpb=3c7c9bd12cf4b0cec0e0a3825c31f7cc9f3f58fe;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index ac61238c..00d68b3d 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,4 +1,4 @@
-
AbstractPool | poolifier - v2.6.21
+AbstractPool | poolifier - v2.6.33
@@ -49,7 +49,7 @@
IPool < Worker , Data , Response >
+
Defined in src/pools/abstract-pool.ts:57
@@ -63,10 +63,12 @@
Properties
emitter?
file Path
+
max?
number Of Workers
opts
promise Response Map
start Timestamp
+
started
starting
worker Choice Strategy Context
worker Nodes
@@ -90,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
@@ -117,21 +121,29 @@
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 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
@@ -177,7 +189,7 @@
Returns AbstractPool < Worker , Data , Response >
+
Defined in src/pools/abstract-pool.ts:113
Protected
Readonly
file Path
file Path : string
@@ -204,7 +218,15 @@
+Defined in src/pools/abstract-pool.ts:115
+
+Protected
Optional
Readonly
max
+max ?: number
+
+
Protected
Readonly
number Of Workers
number Of Workers : number
@@ -212,7 +234,7 @@
+
Defined in src/pools/abstract-pool.ts:114
Protected
Readonly
opts
@@ -220,7 +242,7 @@
+Defined in src/pools/abstract-pool.ts:116
Protected
promise Response Map
@@ -233,7 +255,7 @@
+Defined in src/pools/abstract-pool.ts:76
Private
Readonly
start Timestamp
start Timestamp : number
@@ -241,7 +263,15 @@
+Defined in src/pools/abstract-pool.ts:104
+
+Private
started
+started : boolean
+
+
Private
Readonly
starting
starting : boolean
@@ -249,7 +279,7 @@
+Defined in src/pools/abstract-pool.ts:96
Protected
worker Choice Strategy Context
@@ -257,16 +287,16 @@
+Defined in src/pools/abstract-pool.ts:82
-Readonly
worker Nodes
+Readonly
Internal
worker Nodes
+Defined in src/pools/abstract-pool.ts:63
Protected
full
@@ -292,7 +322,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:682
+Defined in src/pools/abstract-pool.ts:354
-Protected
Abstract
max Size
+Protected
max Size
get maxSize( ) : number
@@ -315,9 +345,9 @@
Returns number
+Defined in src/pools/abstract-pool.ts:555
-Protected
Abstract
min Size
+Protected
min Size
get minSize( ) : number
@@ -326,7 +356,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:548
Private
ready
@@ -337,7 +367,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:500
Protected
Abstract
type
@@ -349,7 +379,7 @@
Returns "fixed" | "dynamic"
+Defined in src/pools/abstract-pool.ts:538
+Defined in src/pools/abstract-pool.ts:517
Protected
Abstract
worker
@@ -372,7 +402,7 @@
Returns "thread" | "cluster"
+Defined in src/pools/abstract-pool.ts:543
Protected
after Task Execution Hook
@@ -421,7 +451,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:879
Protected
after Worker Node Setup
@@ -441,7 +471,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1151
Protected
before Task Execution Hook
@@ -466,7 +496,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:849
Private
build Tasks Queue Options
@@ -479,15 +509,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:1376
+
+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 +548,7 @@ Can be overridden.
max : number
Returns void
+Defined in src/pools/abstract-pool.ts:185
Private
check File Path
@@ -515,7 +561,7 @@ Can be overridden.
filePath : string
Returns void
+Defined in src/pools/abstract-pool.ts:154
Private
check Message Worker Id
+Defined in src/pools/abstract-pool.ts:565
Private
check Number Of Workers
@@ -549,7 +595,7 @@ Can be overridden.
numberOfWorkers : number
Returns void
+Defined in src/pools/abstract-pool.ts:167
Private
check Pool Options
@@ -562,7 +608,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:211
Private
check Valid Tasks Queue Options
@@ -572,10 +618,10 @@ Can be overridden.
Parameters
+
Returns void
+Defined in src/pools/abstract-pool.ts:293
Private
check Valid Worker Choice Strategy
@@ -588,7 +634,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:239
Private
check Valid Worker Choice Strategy Options
@@ -601,7 +647,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:249
Private
choose Worker Node
@@ -614,7 +660,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1004
Protected
create And Setup Dynamic Worker Node
@@ -626,7 +672,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1094
Protected
create And Setup Worker Node
@@ -638,7 +684,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1050
Protected
Abstract
create Worker
@@ -650,7 +696,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1043
Private
dequeue Task
@@ -663,7 +709,7 @@ Can be overridden.
workerNodeKey : number
Returns undefined | Task < Data >
+Defined in src/pools/abstract-pool.ts:1467
+Defined in src/pools/abstract-pool.ts:794
Protected
Abstract
destroy Worker Node
@@ -694,32 +740,32 @@ Can be overridden.
Returns Promise < void >
+Defined in src/pools/abstract-pool.ts:825
enable Tasks Queue
enable Tasks Queue ( enable , tasksQueueOptions ? ) : void
-
Returns void
+Defined in src/pools/abstract-pool.ts:1336
Private
handle Worker Ready Response
@@ -891,19 +942,48 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1322
+
+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:1191
Protected
Abstract
register Worker Message Listener
@@ -967,7 +1060,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1138
Private
remove Worker Node
@@ -986,7 +1079,22 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1424
+
+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,11 +1113,30 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1171
+
+Private
send Statistics Message To Worker
+
+send Statistics Message To Worker ( workerNodeKey ) : void
+
+
+
+
Parameters
+
+
+workerNodeKey : number
+
+
+Returns void
+
Protected
Abstract
send To Worker
-send To Worker ( workerNodeKey , message ) : void
+send To Worker ( workerNodeKey , message , transferList ? ) : void
@@ -1025,50 +1152,49 @@ Can be overridden.
+
+
+Optional
transferList : TransferListItem []
+
Returns void
-
+
+Private
set Tasks Queue Max Size
-send Worker Statistics Message To Worker ( workerNodeKey ) : void
+set Tasks Queue Max Size ( size ) : void
-
Parameters
-workerNodeKey : number
-
-
-Returns void
-
+Returns void
+Defined in src/pools/abstract-pool.ts:659
set Tasks Queue Options
set Tasks Queue Options ( tasksQueueOptions ) : void
-
Returns void
+Defined in src/pools/abstract-pool.ts:965
Private
update Run Time Worker Usage
@@ -1188,7 +1360,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:939
Private
update Task Statistics Worker Usage
@@ -1203,7 +1375,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:921
Private
update Wait Time Worker Usage
@@ -1218,7 +1390,7 @@ Can be overridden.
task : Task < Data >
Returns void
+Defined in src/pools/abstract-pool.ts:951
Protected
worker Listener
@@ -1245,7 +1417,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1302
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 >= maximum queue size).