X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=e382e9e16e85fa1b4736e8df9cfd0842e9c02057;hb=3eed67feea0f527e3ee31a6ebb1063883eec3855;hp=c5225675ab7e6ec74e0a984e4f66eedd11108212;hpb=323daa7f98fd16385379e4b6e8def0a9a3f140c8;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index c5225675..e382e9e1 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,13 +1,13 @@
-AbstractPool | poolifier - v2.6.36
@@ -49,19 +49,19 @@
IPool < Worker , Data , Response >
+
Defined in src/pools/abstract-pool.ts:59
-
+
Constructors
-constructor
+
Properties
-emitter?
+
Accessors
-busy
+
Constructors
constructor constructor
new < Worker , Data , Response > ( numberOfWorkers , filePath , opts ) : AbstractPool < Worker , Data , Response >
@@ -174,19 +180,22 @@
numberOfWorkers : number
+
filePath : string
+
+ Returns AbstractPool < Worker , Data , Response >
+
Defined in src/pools/abstract-pool.ts:114
Protected Readonly file file : string
@@ -215,7 +224,7 @@
+
Defined in src/pools/abstract-pool.ts:116
Protected Optional Readonly max max ?: number
@@ -223,7 +232,7 @@
+Defined in src/pools/abstract-pool.ts:92
Protected Readonly number number : number
@@ -231,7 +240,7 @@
Defined in src/pools/abstract-pool.ts:115
Protected Readonly opts Defined in src/pools/abstract-pool.ts:117
Protected promise Defined in src/pools/abstract-pool.ts:105
Private started started : boolean
@@ -268,15 +277,15 @@
Defined in src/pools/abstract-pool.ts:97
Private Readonly starting Private starting starting : boolean
Defined in src/pools/abstract-pool.ts:101
Protected worker Defined in src/pools/abstract-pool.ts:83
Readonly Internal worker Defined in src/pools/abstract-pool.ts:65
Protected full
@@ -319,7 +328,7 @@
Returns boolean
Defined in src/pools/abstract-pool.ts:722
+Defined in src/pools/abstract-pool.ts:342
Protected max
@@ -342,7 +351,7 @@
Returns number
Defined in src/pools/abstract-pool.ts:555
Protected min
@@ -353,7 +362,7 @@
Returns number
Defined in src/pools/abstract-pool.ts:548
Private ready
@@ -364,7 +373,7 @@
Returns boolean
Defined in src/pools/abstract-pool.ts:500
Protected Abstract type
@@ -376,7 +385,7 @@
Returns "fixed" | "dynamic"
Defined in src/pools/abstract-pool.ts:538
+Defined in src/pools/abstract-pool.ts:517
Protected Abstract worker
@@ -399,7 +408,7 @@
Returns "thread" | "cluster"
Defined in src/pools/abstract-pool.ts:543
Protected after
@@ -437,15 +447,17 @@ Can be overridden.
workerNodeKey : number
+
+
message : MessageValue < Response , unknown >
+
+
Returns void
Defined in src/pools/abstract-pool.ts:935
Protected after
@@ -460,11 +472,12 @@ Can be overridden.
workerNodeKey : number
+
+
Returns void
Defined in src/pools/abstract-pool.ts:1209
Protected before
@@ -479,15 +492,17 @@ Can be overridden.
workerNodeKey : number
+
+
task : Task < Data >
+
+
Returns void
Defined in src/pools/abstract-pool.ts:905
Private build
@@ -500,7 +515,7 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:671
Private check
@@ -508,7 +523,7 @@ Can be overridden.
Returns void Defined in src/pools/abstract-pool.ts:1444
Private check
@@ -516,7 +531,7 @@ Can be overridden.
Returns void Defined in src/pools/abstract-pool.ts:1432
Private check
@@ -524,7 +539,7 @@ Can be overridden.
Returns void Defined in src/pools/abstract-pool.ts:1438
Protected check
@@ -539,7 +554,7 @@ Can be overridden.
max : number
Returns void Defined in src/pools/abstract-pool.ts:187
Private check
@@ -552,7 +567,7 @@ Can be overridden.
filePath : string
Returns void Defined in src/pools/abstract-pool.ts:156
Private check
@@ -566,13 +581,14 @@ Can be overridden.
message : MessageValue < Response , unknown >
+
+
Returns void
Defined in src/pools/abstract-pool.ts:565
Private check
@@ -585,7 +601,7 @@ Can be overridden.
numberOfWorkers : number
Returns void Defined in src/pools/abstract-pool.ts:169
Private check
@@ -598,7 +614,7 @@ Can be overridden.
Returns void Defined in src/pools/abstract-pool.ts:213
Private check
@@ -608,10 +624,10 @@ Can be overridden.
Parameters
+
Returns void Defined in src/pools/abstract-pool.ts:304
Private check
@@ -624,7 +640,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:244
Private check
@@ -637,7 +653,7 @@ Can be overridden.
Returns void Defined in src/pools/abstract-pool.ts:257
Private choose
@@ -650,7 +666,7 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:1062
Protected create
@@ -662,7 +678,7 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:1152
Protected create
@@ -674,7 +690,7 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:1108
Protected Abstract create
@@ -686,7 +702,7 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:1101
Private dequeue
@@ -699,7 +715,7 @@ Can be overridden.
workerNodeKey : number
Returns undefined | Task < Data > Defined in src/pools/abstract-pool.ts:1534
+Defined in src/pools/abstract-pool.ts:850
Protected Abstract destroy
@@ -725,11 +741,12 @@ Can be overridden.
workerNodeKey : number
+
+
Returns Promise < void >
Defined in src/pools/abstract-pool.ts:881
enable
@@ -743,16 +760,18 @@ Can be overridden.
enable : boolean
+
+
Optional
+
+
Returns void
Defined in src/pools/abstract-pool.ts:636
Private enqueue
@@ -767,7 +786,7 @@ Can be overridden.
task : Task < Data >
Returns number Defined in src/pools/abstract-pool.ts:1528
execute
@@ -781,21 +800,24 @@ Can be overridden.
Optional data : Data Optional
+
+
Optional name : string Optional
+
+
Optional transferList : TransferListItem [] Optional
+
+
Returns Promise < Response > Promise that will be fulfilled when the task is completed.
Defined in src/pools/abstract-pool.ts:779
Private execute
@@ -809,15 +831,17 @@ Can be overridden.
workerNodeKey : number
+
+
task : Task < Data >
+
+
Returns void
Defined in src/pools/abstract-pool.ts:1522
Protected flush
@@ -830,7 +854,7 @@ Can be overridden.
workerNodeKey : number
Returns void Defined in src/pools/abstract-pool.ts:1542
Private flush
@@ -838,11 +862,11 @@ Can be overridden.
Returns void Defined in src/pools/abstract-pool.ts:1552
Protected get
-get ( workerNodeKey ) : undefined | WorkerInfo get ( workerNodeKey ) : WorkerInfo
@@ -852,12 +876,13 @@ Can be overridden.
workerNodeKey : number
-The worker information.
+
+
+The worker information.
Defined in src/pools/abstract-pool.ts:1458
Private get
@@ -871,12 +896,13 @@ Can be overridden.
worker : Worker
+
+
Returns number The worker node key if found in the pool worker nodes, -1 otherwise.
Defined in src/pools/abstract-pool.ts:584
Private get
@@ -890,12 +916,13 @@ Can be overridden.
workerId : number
+
+
Returns number The worker node key if the worker id is found in the pool worker nodes, -1 otherwise.
Defined in src/pools/abstract-pool.ts:596
Private handle
@@ -908,7 +935,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void Defined in src/pools/abstract-pool.ts:1404
Private handle
@@ -921,7 +948,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void Defined in src/pools/abstract-pool.ts:1390
Private has
@@ -929,7 +956,7 @@ Can be overridden.
Returns boolean Defined in src/pools/abstract-pool.ts:1507
has
@@ -943,13 +970,14 @@ Can be overridden.
workerNodeKey : number
+
+
Returns boolean true if the worker node has back pressure, false otherwise.
Defined in src/pools/abstract-pool.ts:1500
Protected internal
@@ -961,7 +989,7 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:738
Protected Abstract is
@@ -972,7 +1000,7 @@ Can be overridden.
Returns boolean
Defined in src/pools/abstract-pool.ts:896
+Defined in src/pools/abstract-pool.ts:758
Private redistribute
@@ -998,7 +1026,7 @@ Can be overridden.
workerNodeKey : number
Returns void Defined in src/pools/abstract-pool.ts:1253
Protected Abstract register
@@ -1017,11 +1045,13 @@ Can be overridden.
workerNodeKey : number
+
+
listener : ( ( message ) => void )
@@ -1036,7 +1066,7 @@ Can be overridden.
Returns void
Defined in src/pools/abstract-pool.ts:1196
Private remove
@@ -1050,11 +1080,12 @@ Can be overridden.
worker : Worker
+
+
Returns void
Defined in src/pools/abstract-pool.ts:1491
Protected send
@@ -1069,7 +1100,7 @@ Can be overridden.
workerId : number
Returns Promise < void > Defined in src/pools/abstract-pool.ts:860
Protected Abstract send
@@ -1083,11 +1114,12 @@ Can be overridden.
workerNodeKey : number
+
+
Returns void
Defined in src/pools/abstract-pool.ts:1233
Private send
@@ -1101,11 +1133,12 @@ Can be overridden.
workerNodeKey : number
+
+
Returns void
Defined in src/pools/abstract-pool.ts:1240
Protected Abstract send
@@ -1119,32 +1152,30 @@ Can be overridden.
workerNodeKey : number
+
+
+
+
Optional transferList : TransferListItem [] Optional
+
+
Returns void
Private set
-set ( size ) : void set ( ) : void
-
Returns void Defined in src/pools/abstract-pool.ts:691
set
@@ -1158,12 +1189,34 @@ Can be overridden.
+
+
Returns void
Defined in src/pools/abstract-pool.ts:650
+Private set
+set ( size ) : void
+
+Returns void Private set
+set ( ) : void
+Returns void set
@@ -1177,16 +1230,18 @@ Can be overridden.
workerChoiceStrategy : "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
+
+
Optional
+
+
Returns void
Defined in src/pools/abstract-pool.ts:603
set
@@ -1200,12 +1255,13 @@ Can be overridden.
+
+
Returns void
Defined in src/pools/abstract-pool.ts:622
Protected setup
@@ -1217,7 +1273,7 @@ Can be overridden.
Returns void
Defined in src/pools/abstract-pool.ts:889
Private shall
@@ -1229,7 +1285,20 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:1079
+Private shall
+shall ( workerNodeKey ) : boolean
+
+Returns boolean Private shall
@@ -1243,20 +1312,25 @@ Can be overridden.
workerNodeKey : number
+
+
Returns boolean true if the worker node shall update its task function worker usage, false otherwise.
start
+start ( ) : void
-Returns void Defined in src/pools/abstract-pool.ts:834
Private task
@@ -1269,7 +1343,7 @@ Can be overridden.
workerId : number
Returns void Defined in src/pools/abstract-pool.ts:1297
Private tasks
@@ -1282,7 +1356,7 @@ Can be overridden.
workerNodeKey : number
Returns number Defined in src/pools/abstract-pool.ts:1538
Private tasks
@@ -1295,7 +1369,23 @@ Can be overridden.
workerId : number
Returns void Defined in src/pools/abstract-pool.ts:1329
+Private unset
+unset ( ) : void
+Returns void Private unset
+unset ( ) : void
+Returns void Private update
@@ -1310,7 +1400,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void Defined in src/pools/abstract-pool.ts:1022
Private update
@@ -1325,7 +1415,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void Defined in src/pools/abstract-pool.ts:995
Private update
@@ -1340,7 +1430,22 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void Defined in src/pools/abstract-pool.ts:977
+Private update
+update ( workerNodeKey , taskName ) : void
+
+
Parameters
+
+
+workerNodeKey : number
+
+taskName : string Returns void Private update
@@ -1355,7 +1460,7 @@ Can be overridden.
task : Task < Data >
Returns void Defined in src/pools/abstract-pool.ts:1009
Protected worker
@@ -1382,20 +1487,20 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:1372
+poolifier - v2.6.45
\ No newline at end of file
+
Number of workers that this pool should manage.
-