X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=aff9850dd46ceb55e6088a5de0ea9e4d8b744410;hb=a93f5559e2dd5ff7fd49afdd43bc9806cff92f56;hp=27ed4997fc97f37ad8390ae2455176a5feb5dc99;hpb=f4ff239c096df6dfb39c94eb3f83fd070d3d85d8;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index 27ed4997..aff9850d 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,4 +1,4 @@
-
AbstractPool | poolifier - v2.6.23
+AbstractPool | poolifier - v2.6.32
@@ -49,7 +49,7 @@
IPool < Worker , Data , Response >
+
Defined in src/pools/abstract-pool.ts:56
@@ -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,28 @@
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
tasks Queue Size
+
tasks Stealing On Back Pressure
update Elu Worker Usage
update Run Time Worker Usage
update Task Statistics Worker Usage
@@ -177,7 +188,7 @@
Returns AbstractPool < Worker , Data , Response >
+
Defined in src/pools/abstract-pool.ts:112
Protected
Readonly
file Path
file Path : string
@@ -204,7 +217,15 @@
+Defined in src/pools/abstract-pool.ts:114
+
+Protected
Optional
Readonly
max
+max ?: number
+
+
Protected
Readonly
number Of Workers
number Of Workers : number
@@ -212,7 +233,7 @@
+
Defined in src/pools/abstract-pool.ts:113
Protected
Readonly
opts
@@ -220,7 +241,7 @@
+Defined in src/pools/abstract-pool.ts:115
Protected
promise Response Map
@@ -233,7 +254,7 @@
+Defined in src/pools/abstract-pool.ts:75
Private
Readonly
start Timestamp
start Timestamp : number
@@ -241,7 +262,15 @@
+Defined in src/pools/abstract-pool.ts:103
+
+Private
started
+started : boolean
+
+
Private
Readonly
starting
starting : boolean
@@ -249,7 +278,7 @@
+Defined in src/pools/abstract-pool.ts:95
Protected
worker Choice Strategy Context
@@ -257,16 +286,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 +321,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:675
+Defined in src/pools/abstract-pool.ts:345
-Protected
Abstract
max Size
+Protected
max Size
get maxSize( ) : number
@@ -315,9 +344,9 @@
Returns number
+Defined in src/pools/abstract-pool.ts:546
-Protected
Abstract
min Size
+Protected
min Size
get minSize( ) : number
@@ -326,7 +355,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:539
Private
ready
@@ -337,7 +366,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:491
Protected
Abstract
type
@@ -349,7 +378,7 @@
Returns "fixed" | "dynamic"
+Defined in src/pools/abstract-pool.ts:529
+Defined in src/pools/abstract-pool.ts:508
Protected
Abstract
worker
@@ -372,7 +401,7 @@
Returns "thread" | "cluster"
+Defined in src/pools/abstract-pool.ts:534
Protected
after Task Execution Hook
@@ -421,7 +450,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:872
Protected
after Worker Node Setup
@@ -441,7 +470,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1144
Protected
before Task Execution Hook
@@ -466,7 +495,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:842
Private
build Tasks Queue Options
@@ -479,15 +508,31 @@ Can be overridden.
-
+
+Private
check And Emit Dynamic Worker Creation Events
+
+check And Emit Dynamic Worker Creation Events ( ) : void
+
+Returns void
+
+Private
check And Emit Task Execution Events
-check And Emit Events ( ) : void
+check And Emit Task Execution Events ( ) : void
Returns void
+Defined in src/pools/abstract-pool.ts:1323
+
+Private
check And Emit Task Queuing Events
+
+check And Emit Task Queuing Events ( ) : void
+
+Returns void
Protected
check Dynamic Pool Size
@@ -502,7 +547,7 @@ Can be overridden.
max : number
Returns void
+Defined in src/pools/abstract-pool.ts:184
Private
check File Path
@@ -515,7 +560,7 @@ Can be overridden.
filePath : string
Returns void
+Defined in src/pools/abstract-pool.ts:153
Private
check Message Worker Id
+Defined in src/pools/abstract-pool.ts:556
Private
check Number Of Workers
@@ -549,7 +594,7 @@ Can be overridden.
numberOfWorkers : number
Returns void
+Defined in src/pools/abstract-pool.ts:166
Private
check Pool Options
@@ -562,7 +607,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:210
Private
check Valid Tasks Queue Options
@@ -575,7 +620,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:292
Private
check Valid Worker Choice Strategy
@@ -588,7 +633,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:238
Private
check Valid Worker Choice Strategy Options
@@ -601,7 +646,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:248
Private
choose Worker Node
@@ -614,7 +659,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:997
Protected
create And Setup Dynamic Worker Node
@@ -626,7 +671,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1087
Protected
create And Setup Worker Node
@@ -638,7 +683,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1043
Protected
Abstract
create Worker
@@ -650,7 +695,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1036
Private
dequeue Task
@@ -663,7 +708,7 @@ Can be overridden.
workerNodeKey : number
Returns undefined | Task < Data >
+Defined in src/pools/abstract-pool.ts:1426
+Defined in src/pools/abstract-pool.ts:787
Protected
Abstract
destroy Worker Node
@@ -694,32 +739,32 @@ Can be overridden.
Returns Promise < void >
+Defined in src/pools/abstract-pool.ts:818
enable Tasks Queue
enable Tasks Queue ( enable , tasksQueueOptions ? ) : void
-
Returns void
+Defined in src/pools/abstract-pool.ts:1295
Private
handle Worker Ready Response
@@ -891,7 +941,36 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1281
+
+Private
has Back Pressure
+
+has Back Pressure ( ) : boolean
+
+Returns boolean
+
+has Worker Node Back Pressure
+
Protected
internal Busy
@@ -903,7 +982,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:691
Protected
Abstract
is Main
@@ -914,7 +993,20 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:833
+
Private
redistribute Queued Tasks
@@ -927,7 +1019,7 @@ Can be overridden.
workerNodeKey : number
Returns void
+Defined in src/pools/abstract-pool.ts:1182
Protected
Abstract
register Worker Message Listener
@@ -967,7 +1059,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1131
Private
remove Worker Node
@@ -986,7 +1078,22 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1383
+
+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 +1112,30 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1162
+
+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 +1151,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 ( queueMaxSize ) : void
-
Parameters
-workerNodeKey : number
-
-
-Returns void
-
+Returns void
+Defined in src/pools/abstract-pool.ts:652
set Tasks Queue Options
set Tasks Queue Options ( tasksQueueOptions ) : void
-
Returns void
+Defined in src/pools/abstract-pool.ts:958
Private
update Run Time Worker Usage
@@ -1188,7 +1346,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:932
Private
update Task Statistics Worker Usage
@@ -1203,7 +1361,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:914
Private
update Wait Time Worker Usage
@@ -1218,7 +1376,7 @@ Can be overridden.
task : Task < Data >
Returns void
+Defined in src/pools/abstract-pool.ts:944
Protected
worker Listener
@@ -1245,7 +1403,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1261
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).