X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=072c9da05dae4cb0411cc9c601675033feef32ac;hb=dd7f9381792ec728f9cd87ef7a0df6b2893db77e;hp=779ee93646effb18cf2db2facd60b6ff67435493;hpb=b9da9d7e74c720f83482a09d1b883fc83d04f4ed;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index 779ee936..072c9da0 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,13 +1,13 @@
-AbstractPool | poolifier - v2.6.37
@@ -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 +187,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 +248,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 +285,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 +348,7 @@
Returns boolean
Defined in src/pools/abstract-pool.ts:662
+Defined in src/pools/abstract-pool.ts:272
Protected max
@@ -344,7 +371,7 @@
Returns number
Defined in src/pools/abstract-pool.ts:485
Protected min
@@ -355,7 +382,7 @@
Returns number
Defined in src/pools/abstract-pool.ts:478
Private ready
@@ -366,7 +393,7 @@
Returns boolean
Defined in src/pools/abstract-pool.ts:430
Protected Abstract type
@@ -378,7 +405,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 +428,40 @@
Returns "thread" | "cluster"
Defined in src/pools/abstract-pool.ts:473
Methods
+
Private add
@@ -417,14 +475,15 @@
worker : Worker
+
+
Returns number The added worker node key.
Defined in src/pools/abstract-pool.ts:1614
Protected after
@@ -439,15 +498,17 @@ Can be overridden.
workerNodeKey : number
+
+
message : MessageValue < Response , unknown >
+
+
Returns void
Defined in src/pools/abstract-pool.ts:1044
Protected after
@@ -462,11 +523,12 @@ Can be overridden.
workerNodeKey : number
+
+
Returns void
Defined in src/pools/abstract-pool.ts:1355
Protected before
@@ -481,15 +543,17 @@ Can be overridden.
workerNodeKey : number
+
+
task : Task < Data >
+
+
Returns void
Defined in src/pools/abstract-pool.ts:1014
Private build
@@ -502,7 +566,7 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:601
Private check
@@ -510,7 +574,7 @@ Can be overridden.
Returns void Defined in src/pools/abstract-pool.ts:1589
Private check
@@ -518,7 +582,7 @@ Can be overridden.
Returns void Defined in src/pools/abstract-pool.ts:1577
Private check
@@ -526,35 +590,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:1583
Private check
@@ -566,15 +602,16 @@ Can be overridden.
Parameters
+
+
Returns void
Defined in src/pools/abstract-pool.ts:495
Private check
@@ -587,7 +624,7 @@ Can be overridden.
numberOfWorkers : number
Returns void Defined in src/pools/abstract-pool.ts:171
Private check
@@ -600,33 +637,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 +650,7 @@ Can be overridden.
Returns void Defined in src/pools/abstract-pool.ts:218
Private choose
@@ -652,7 +663,7 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:1171
Protected create
@@ -664,7 +675,7 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:1261
Protected create
@@ -676,7 +687,7 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:1217
Protected Abstract create
@@ -688,7 +699,20 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:1210
+Private delete
+delete ( name ) : void
+
+Returns void Private dequeue
@@ -701,7 +725,47 @@ Can be overridden.
workerNodeKey : number
Returns undefined | Task < Data > Defined in src/pools/abstract-pool.ts:1679
+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:951
Protected Abstract destroy
@@ -727,11 +791,12 @@ Can be overridden.
workerNodeKey : number
+
+
Returns Promise < void >
Defined in src/pools/abstract-pool.ts:990
enable
@@ -745,16 +810,18 @@ Can be overridden.
enable : boolean
+
+
Optional
+
+
Returns void
Defined in src/pools/abstract-pool.ts:566
Private enqueue
@@ -769,7 +836,7 @@ Can be overridden.
task : Task < Data >
Returns number Defined in src/pools/abstract-pool.ts:1673
execute
@@ -783,21 +850,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:881
Private execute
@@ -811,15 +881,17 @@ Can be overridden.
workerNodeKey : number
+
+
task : Task < Data >
+
+
Returns void
Defined in src/pools/abstract-pool.ts:1667
Protected flush
@@ -832,7 +904,7 @@ Can be overridden.
workerNodeKey : number
Returns void Defined in src/pools/abstract-pool.ts:1687
Private flush
@@ -840,11 +912,11 @@ Can be overridden.
Returns void Defined in src/pools/abstract-pool.ts:1697
Protected get
-get ( workerNodeKey ) : undefined | WorkerInfo get ( workerNodeKey ) : WorkerInfo
@@ -854,12 +926,13 @@ Can be overridden.
workerNodeKey : number
-The worker information.
+
+
+The worker information.
Defined in src/pools/abstract-pool.ts:1603
Private get
@@ -873,12 +946,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:514
Private get
@@ -890,14 +964,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:526
+Private Readonly handle
+handle ( event ) : void
+
+
Parameters
+
+
+event : CustomEvent < WorkerNodeEventDetail > Returns void Private Readonly handle
+handle ( event ) : void
+
+
Parameters
+
+
+event : CustomEvent < WorkerNodeEventDetail > Returns void Private handle
@@ -910,7 +1011,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void Defined in src/pools/abstract-pool.ts:1549
Private handle
@@ -923,7 +1024,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void Defined in src/pools/abstract-pool.ts:1533
Private has
@@ -931,7 +1032,28 @@ Can be overridden.
Returns boolean Defined in src/pools/abstract-pool.ts:1652
+
has
@@ -945,13 +1067,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:1645
+Private initialize
+initialize ( ) : void
+Returns void Protected internal
@@ -963,7 +1094,7 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:678
Protected Abstract is
@@ -974,20 +1105,20 @@ Can be overridden.
Returns boolean
Defined in src/pools/abstract-pool.ts:846
Private redistribute
@@ -1000,7 +1131,47 @@ Can be overridden.
workerNodeKey : number
Returns void Defined in src/pools/abstract-pool.ts:1405
+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 +1190,13 @@ Can be overridden.
workerNodeKey : number
+
+
listener : ( ( message ) => void )
@@ -1038,7 +1211,28 @@ Can be overridden.
Returns void
Defined in src/pools/abstract-pool.ts:1316
+
Private remove
@@ -1052,26 +1246,25 @@ Can be overridden.
worker : Worker
+
+
Returns void
Defined in src/pools/abstract-pool.ts:1636
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:962
Protected Abstract send
@@ -1085,11 +1278,12 @@ Can be overridden.
workerNodeKey : number
+
+
Returns void
Defined in src/pools/abstract-pool.ts:1386
Private send
@@ -1103,11 +1297,40 @@ Can be overridden.
workerNodeKey : number
+
+
Returns void
Defined in src/pools/abstract-pool.ts:1393
+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,32 +1344,51 @@ Can be overridden.
workerNodeKey : number
+
+
+
+
Optional transferList : TransferListItem [] Optional
+
+
Returns void
Private set set
+set ( name ) : Promise < boolean >
+
+name : string
+Returns Promise < boolean > true if the default task function was set, false otherwise.
+
+Private set
+set ( ) : void
Returns void Defined in src/pools/abstract-pool.ts:621
set
@@ -1160,12 +1402,34 @@ Can be overridden.
+
+
Returns void
Defined in src/pools/abstract-pool.ts:580
+Private set
+set ( size ) : void
+
+Returns void Private set
+set ( ) : void
+Returns void set
@@ -1179,16 +1443,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:533
set
@@ -1202,12 +1468,13 @@ Can be overridden.
+
+
Returns void
Defined in src/pools/abstract-pool.ts:552
Protected setup
@@ -1219,7 +1486,7 @@ Can be overridden.
Returns void
Defined in src/pools/abstract-pool.ts:998
Private shall
@@ -1231,7 +1498,7 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:1188
Private shall
@@ -1244,7 +1511,7 @@ Can be overridden.
workerNodeKey : number
Returns boolean Defined in src/pools/abstract-pool.ts:872
Private shall
@@ -1258,33 +1525,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:935
Private tasks
@@ -1297,20 +1556,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:648
Private update
@@ -1325,7 +1587,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void Defined in src/pools/abstract-pool.ts:1131
Private update
@@ -1340,7 +1602,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void Defined in src/pools/abstract-pool.ts:1104
Private update
@@ -1355,7 +1617,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void Defined in src/pools/abstract-pool.ts:1086
Private update
@@ -1370,7 +1632,7 @@ Can be overridden.
taskName : string
Returns void Defined in src/pools/abstract-pool.ts:1426
Private update
@@ -1385,39 +1647,28 @@ Can be overridden.
task : Task < Data >
Returns void Protected worker poolifier - v3.0.1
\ No newline at end of file
+
Number of workers that this pool should manage.
-