X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=4f501d6f503d1bdab4b5ab50ca3e7d2d989f409e;hb=0cf6d1374ad842cc31aca1a8ddaa1bc5a9b9302b;hp=92d46d153c26a6e332bce691985d560adac71ee5;hpb=341ec6db3b66173fd9314338b736fabb0639914b;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index 92d46d15..4f501d6f 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,13 +1,13 @@
-AbstractPool | poolifier - v2.6.40
@@ -49,19 +49,19 @@
IPool < Worker , Data , Response >
+
Defined in src/pools/abstract-pool.ts:65
-
+
Constructors
-constructor
+
Properties
-emitter?
+
Accessors
-busy
+
Constructors
constructor constructor
new < Worker , Data , Response > ( numberOfWorkers , filePath , opts ) : AbstractPool < Worker , Data , Response >
@@ -176,25 +188,29 @@
numberOfWorkers : number
+
filePath : string
+
+ Returns AbstractPool < Worker , Data , Response >
+
Defined in src/pools/abstract-pool.ts:127
Protected Readonly number number : number
@@ -233,7 +249,7 @@
+
Defined in src/pools/abstract-pool.ts:128
Protected Readonly opts
+Defined in src/pools/abstract-pool.ts:130
Protected promise Defined in src/pools/abstract-pool.ts:118
Private started started : boolean
@@ -270,15 +286,27 @@
Defined in src/pools/abstract-pool.ts:110
Private Readonly starting Private starting starting : boolean
Defined in src/pools/abstract-pool.ts:114
+Private Readonly task Protected worker Defined in src/pools/abstract-pool.ts:94
Readonly Internal worker Defined in src/pools/abstract-pool.ts:71
Protected full
@@ -321,7 +349,7 @@
Returns boolean
Defined in src/pools/abstract-pool.ts:659
+Defined in src/pools/abstract-pool.ts:272
Protected max
@@ -344,7 +372,7 @@
Returns number
Defined in src/pools/abstract-pool.ts:485
Protected min
@@ -355,7 +383,7 @@
Returns number
Defined in src/pools/abstract-pool.ts:478
Private ready
@@ -366,7 +394,7 @@
Returns boolean
Defined in src/pools/abstract-pool.ts:430
Protected Abstract type
@@ -378,7 +406,7 @@
Returns "fixed" | "dynamic"
Defined in src/pools/abstract-pool.ts:468
+Defined in src/pools/abstract-pool.ts:447
Protected Abstract worker
@@ -401,9 +429,40 @@
Returns "thread" | "cluster"
Defined in src/pools/abstract-pool.ts:473
Methods
+
Private add
@@ -417,14 +476,15 @@
worker : Worker
+
+
Returns number The added worker node key.
Defined in src/pools/abstract-pool.ts:1613
Protected after
@@ -439,15 +499,17 @@ Can be overridden.
workerNodeKey : number
+
+
message : MessageValue < Response , unknown >
+
+
Returns void
Defined in src/pools/abstract-pool.ts:1041
Protected after
@@ -462,11 +524,12 @@ Can be overridden.
workerNodeKey : number
+
+
Returns void
Defined in src/pools/abstract-pool.ts:1354
Protected before
@@ -481,15 +544,17 @@ Can be overridden.
workerNodeKey : number
+
+
task : Task < Data >
+
+
Returns void
Defined in src/pools/abstract-pool.ts:1011
Private build
@@ -502,7 +567,7 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:598
Private check
@@ -510,7 +575,7 @@ Can be overridden.
Returns void Defined in src/pools/abstract-pool.ts:1588
Private check
@@ -518,7 +583,7 @@ Can be overridden.
Returns void Defined in src/pools/abstract-pool.ts:1576
Private check
@@ -526,35 +591,7 @@ Can be overridden.
Returns void Protected check
-check ( min , max ) : void
-
-
Parameters
-
-
-min : number
-
-max : number Returns void Private check
-check ( filePath ) : void
-
-Returns void Defined in src/pools/abstract-pool.ts:1582
Private check
@@ -566,15 +603,16 @@ Can be overridden.
Parameters
+
+
Returns void
Defined in src/pools/abstract-pool.ts:495
Private check
@@ -587,7 +625,7 @@ Can be overridden.
numberOfWorkers : number
Returns void Defined in src/pools/abstract-pool.ts:171
Private check
@@ -600,33 +638,7 @@ Can be overridden.
Returns void Private check
-check ( tasksQueueOptions ) : void
-
-Returns void Private check
-check ( workerChoiceStrategy ) : void
-
-
Parameters
-
-
-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:189
Private check
@@ -639,7 +651,7 @@ Can be overridden.
Returns void Defined in src/pools/abstract-pool.ts:218
Private choose
@@ -652,7 +664,7 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:1168
Protected create
@@ -664,7 +676,7 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:1258
Protected create
@@ -676,7 +688,7 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:1214
Protected Abstract create
@@ -688,7 +700,20 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:1207
+Private delete
+delete ( name ) : void
+
+Returns void Private dequeue
@@ -701,7 +726,47 @@ Can be overridden.
workerNodeKey : number
Returns undefined | Task < Data > Defined in src/pools/abstract-pool.ts:1682
+Protected Abstract deregister
+deregister < Message > ( workerNodeKey , listener ) : void
+
+
+
+
Parameters
+
+
+workerNodeKey : number
+
+listener : ( ( message ) => void )
+
+
+( message ) : void
+
+Returns void Returns void
+ Defined in src/pools/abstract-pool.ts:948
Protected Abstract destroy
@@ -727,11 +792,12 @@ Can be overridden.
workerNodeKey : number
+
+
Returns Promise < void >
Defined in src/pools/abstract-pool.ts:987
enable
@@ -745,16 +811,18 @@ Can be overridden.
enable : boolean
+
+
Optional
+
+
Returns void
Defined in src/pools/abstract-pool.ts:563
Private enqueue
@@ -769,7 +837,7 @@ Can be overridden.
task : Task < Data >
Returns number Defined in src/pools/abstract-pool.ts:1676
execute
@@ -783,21 +851,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:878
Private execute
@@ -811,15 +882,30 @@ Can be overridden.
workerNodeKey : number
+
+
task : Task < Data >
+
+
Returns void
Defined in src/pools/abstract-pool.ts:1670
+Protected flag
+flag ( workerNodeKey ) : void
+
+Returns void Protected flush
@@ -832,7 +918,7 @@ Can be overridden.
workerNodeKey : number
Returns void Defined in src/pools/abstract-pool.ts:1690
Private flush
@@ -840,11 +926,11 @@ Can be overridden.
Returns void Defined in src/pools/abstract-pool.ts:1700
Protected get
-get ( workerNodeKey ) : undefined | WorkerInfo get ( workerNodeKey ) : WorkerInfo
@@ -854,12 +940,13 @@ Can be overridden.
workerNodeKey : number
-The worker information.
+
+
+The worker information.
Defined in src/pools/abstract-pool.ts:1602
Private get
@@ -873,12 +960,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:511
Private get
@@ -890,14 +978,41 @@ Can be overridden.
Parameters
-workerId : number workerId : undefined | 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:523
+Private Readonly handle
+handle ( event ) : void
+
+Returns void Private Readonly handle
+handle ( event ) : void
+
+Returns void Private handle
@@ -910,7 +1025,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void Defined in src/pools/abstract-pool.ts:1548
Private handle
@@ -923,7 +1038,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void Defined in src/pools/abstract-pool.ts:1532
Private has
@@ -931,7 +1046,28 @@ Can be overridden.
Returns boolean Defined in src/pools/abstract-pool.ts:1655
+
has
@@ -945,13 +1081,22 @@ Can be overridden.
workerNodeKey : number
+
+
Returns boolean true if the worker node has back pressure, false otherwise.
Defined in src/pools/abstract-pool.ts:1648
+Private initialize
+initialize ( ) : void
+Returns void Protected internal
@@ -963,7 +1108,7 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:675
Protected Abstract is
@@ -974,20 +1119,20 @@ Can be overridden.
Returns boolean
Defined in src/pools/abstract-pool.ts:843
Private redistribute
@@ -1000,7 +1145,47 @@ Can be overridden.
workerNodeKey : number
Returns void Defined in src/pools/abstract-pool.ts:1404
+Protected Abstract register
+register < Message > ( workerNodeKey , listener ) : void
+
+
+
+
Parameters
+
+
+workerNodeKey : number
+
+listener : ( ( message ) => void )
+
+
+( message ) : void
+
+Returns void Returns void
+ Protected Abstract register
@@ -1019,11 +1204,13 @@ Can be overridden.
workerNodeKey : number
+
+
listener : ( ( message ) => void )
@@ -1038,7 +1225,28 @@ Can be overridden.
Returns void
Defined in src/pools/abstract-pool.ts:1315
+
Private remove
@@ -1052,26 +1260,25 @@ Can be overridden.
worker : Worker
+
+
Returns void
Defined in src/pools/abstract-pool.ts:1635
Protected send
-send ( workerNodeKey , workerId ) : Promise < void > send ( workerNodeKey ) : Promise < void >
Parameters
-workerNodeKey : number
-
-workerId : number
+workerNodeKey : number
Returns Promise < void > Defined in src/pools/abstract-pool.ts:959
Protected Abstract send
@@ -1085,11 +1292,12 @@ Can be overridden.
workerNodeKey : number
+
+
Returns void
Defined in src/pools/abstract-pool.ts:1385
Private send
@@ -1103,11 +1311,40 @@ Can be overridden.
workerNodeKey : number
+
+
Returns void
Defined in src/pools/abstract-pool.ts:1392
+Private send
+send ( workerNodeKey , message ) : Promise < boolean >
+
+
Parameters
+
+
+workerNodeKey : number
+
+ Returns Promise < boolean > Private send
+send ( message ) : Promise < boolean >
+
+Returns Promise < boolean > Protected Abstract send
@@ -1121,19 +1358,51 @@ Can be overridden.
workerNodeKey : number
+
+
+
+
Optional transferList : TransferListItem [] Optional
+
+
Returns void
Defined in src/pools/abstract-pool.ts:1196
+set Private set
+set ( ) : void
+Returns void set
@@ -1147,12 +1416,13 @@ Can be overridden.
+
+
Returns void
Defined in src/pools/abstract-pool.ts:577
Private set
@@ -1165,7 +1435,15 @@ Can be overridden.
size : number
Returns void Defined in src/pools/abstract-pool.ts:612
+Private set
+set ( ) : void
+Returns void set
@@ -1179,16 +1457,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:530
set
@@ -1202,12 +1482,13 @@ Can be overridden.
+
+
Returns void
Defined in src/pools/abstract-pool.ts:549
Protected setup
@@ -1219,7 +1500,7 @@ Can be overridden.
Returns void
Defined in src/pools/abstract-pool.ts:995
Private shall
@@ -1231,7 +1512,7 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:1185
Private shall
@@ -1244,7 +1525,7 @@ Can be overridden.
workerNodeKey : number
Returns boolean Defined in src/pools/abstract-pool.ts:869
Private shall
@@ -1258,33 +1539,25 @@ Can be overridden.
workerNodeKey : number
+
+
Returns boolean true if the worker node shall update its task function worker usage, false otherwise.
Private start
-start ( ) : void
-Returns void Private task start
+start ( ) : void
-
-Returns void Defined in src/pools/abstract-pool.ts:932
Private tasks
@@ -1297,20 +1570,23 @@ Can be overridden.
workerNodeKey : number
Returns number Private unset
-tasks ( workerId ) : void unset ( ) : void
+Returns void Private unset
+unset ( ) : void
-
Returns void Defined in src/pools/abstract-pool.ts:645
Private update
@@ -1325,7 +1601,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void Defined in src/pools/abstract-pool.ts:1128
Private update
@@ -1340,7 +1616,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void Defined in src/pools/abstract-pool.ts:1101
Private update
@@ -1355,7 +1631,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void Defined in src/pools/abstract-pool.ts:1083
Private update
@@ -1370,7 +1646,7 @@ Can be overridden.
taskName : string
Returns void Defined in src/pools/abstract-pool.ts:1425
Private update
@@ -1385,39 +1661,28 @@ Can be overridden.
task : Task < Data >
Returns void Protected worker poolifier - v3.0.4
\ No newline at end of file
+
Number of workers that this pool should manage.
-