X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=57b75a1a6da1adfb6f25fa46a5518a8e1ce7ed62;hb=b656440d69d06f603b8bc4c23ca4dfe489cbef74;hp=92d46d153c26a6e332bce691985d560adac71ee5;hpb=cc35cd9cb7323e39c9f521cdd4fbf51d1d31bbdf;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index 92d46d15..57b75a1a 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:64
-
+
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:126
Protected Readonly number number : number
@@ -233,7 +248,7 @@
+
Defined in src/pools/abstract-pool.ts:127
Protected Readonly opts
+Defined in src/pools/abstract-pool.ts:129
Protected promise Defined in src/pools/abstract-pool.ts:117
Private started started : boolean
@@ -270,15 +285,27 @@
Defined in src/pools/abstract-pool.ts:109
Private Readonly starting Private starting starting : boolean
Defined in src/pools/abstract-pool.ts:113
+Private Readonly task Protected worker Defined in src/pools/abstract-pool.ts:93
Readonly Internal worker Defined in src/pools/abstract-pool.ts:70
Protected full
@@ -321,7 +348,7 @@
Returns boolean
Defined in src/pools/abstract-pool.ts:651
+Defined in src/pools/abstract-pool.ts:271
Protected max
@@ -344,7 +371,7 @@
Returns number
Defined in src/pools/abstract-pool.ts:484
Protected min
@@ -355,7 +382,7 @@
Returns number
Defined in src/pools/abstract-pool.ts:477
Private ready
@@ -366,7 +393,7 @@
Returns boolean
Defined in src/pools/abstract-pool.ts:429
Protected Abstract type
@@ -378,7 +405,7 @@
Returns "fixed" | "dynamic"
Defined in src/pools/abstract-pool.ts:467
+Defined in src/pools/abstract-pool.ts:446
Protected Abstract worker
@@ -401,9 +428,40 @@
Returns "thread" | "cluster"
Defined in src/pools/abstract-pool.ts:472
Methods
+
Private add
@@ -417,14 +475,15 @@
worker : Worker
+
+
Returns number The added worker node key.
Defined in src/pools/abstract-pool.ts:1593
Protected after
@@ -439,15 +498,17 @@ Can be overridden.
workerNodeKey : number
+
+
message : MessageValue < Response , unknown >
+
+
Returns void
Defined in src/pools/abstract-pool.ts:1033
Protected after
@@ -462,11 +523,12 @@ Can be overridden.
workerNodeKey : number
+
+
Returns void
Defined in src/pools/abstract-pool.ts:1344
Protected before
@@ -481,15 +543,17 @@ Can be overridden.
workerNodeKey : number
+
+
task : Task < Data >
+
+
Returns void
Defined in src/pools/abstract-pool.ts:1003
Private build
@@ -502,7 +566,7 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:600
Private check
@@ -510,7 +574,7 @@ Can be overridden.
Returns void Defined in src/pools/abstract-pool.ts:1568
Private check
@@ -518,7 +582,7 @@ Can be overridden.
Returns void Defined in src/pools/abstract-pool.ts:1556
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:1562
Private check
@@ -566,15 +602,16 @@ Can be overridden.
Parameters
+
+
Returns void
Defined in src/pools/abstract-pool.ts:494
Private check
@@ -587,7 +624,7 @@ Can be overridden.
numberOfWorkers : number
Returns void Defined in src/pools/abstract-pool.ts:170
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:188
Private check
@@ -639,7 +650,7 @@ Can be overridden.
Returns void Defined in src/pools/abstract-pool.ts:217
Private choose
@@ -652,7 +663,7 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:1160
Protected create
@@ -664,7 +675,7 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:1250
Protected create
@@ -676,7 +687,7 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:1206
Protected Abstract create
@@ -688,7 +699,20 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:1199
+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:1658
+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:940
Protected Abstract destroy
@@ -727,11 +791,12 @@ Can be overridden.
workerNodeKey : number
+
+
Returns Promise < void >
Defined in src/pools/abstract-pool.ts:979
enable
@@ -745,16 +810,18 @@ Can be overridden.
enable : boolean
+
+
Optional
+
+
Returns void
Defined in src/pools/abstract-pool.ts:565
Private enqueue
@@ -769,7 +836,7 @@ Can be overridden.
task : Task < Data >
Returns number Defined in src/pools/abstract-pool.ts:1652
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:870
Private execute
@@ -811,15 +881,17 @@ Can be overridden.
workerNodeKey : number
+
+
task : Task < Data >
+
+
Returns void
Defined in src/pools/abstract-pool.ts:1646
Protected flush
@@ -832,7 +904,7 @@ Can be overridden.
workerNodeKey : number
Returns void Defined in src/pools/abstract-pool.ts:1666
Private flush
@@ -840,11 +912,11 @@ Can be overridden.
Returns void Defined in src/pools/abstract-pool.ts:1676
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:1582
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:513
Private get
@@ -890,14 +964,15 @@ 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:525
Private handle
@@ -910,7 +985,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void Defined in src/pools/abstract-pool.ts:1528
Private handle
@@ -923,7 +998,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void Defined in src/pools/abstract-pool.ts:1512
Private has
@@ -931,7 +1006,28 @@ Can be overridden.
Returns boolean Defined in src/pools/abstract-pool.ts:1631
+
has
@@ -945,13 +1041,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:1624
+Private initialize
+initialize ( ) : void
+Returns void Protected internal
@@ -963,7 +1068,7 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:667
Protected Abstract is
@@ -974,20 +1079,20 @@ Can be overridden.
Returns boolean
Defined in src/pools/abstract-pool.ts:835
Private redistribute
@@ -1000,7 +1105,47 @@ Can be overridden.
workerNodeKey : number
Returns void Defined in src/pools/abstract-pool.ts:1390
+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 +1164,13 @@ Can be overridden.
workerNodeKey : number
+
+
listener : ( ( message ) => void )
@@ -1038,7 +1185,28 @@ Can be overridden.
Returns void
Defined in src/pools/abstract-pool.ts:1305
+
Private remove
@@ -1052,26 +1220,25 @@ Can be overridden.
worker : Worker
+
+
Returns void
Defined in src/pools/abstract-pool.ts:1615
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:951
Protected Abstract send
@@ -1085,11 +1252,12 @@ Can be overridden.
workerNodeKey : number
+
+
Returns void
Defined in src/pools/abstract-pool.ts:1371
Private send
@@ -1103,11 +1271,40 @@ Can be overridden.
workerNodeKey : number
+
+
Returns void
Defined in src/pools/abstract-pool.ts:1378
+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 +1318,51 @@ Can be overridden.
workerNodeKey : number
+
+
+
+
Optional transferList : TransferListItem [] Optional
+
+
Returns void
Defined in src/pools/abstract-pool.ts:1188
+set Private set
+set ( ) : void
+Returns void set
@@ -1147,12 +1376,13 @@ Can be overridden.
+
+
Returns void
Defined in src/pools/abstract-pool.ts:579
Private set
@@ -1165,7 +1395,15 @@ Can be overridden.
size : number
Returns void Defined in src/pools/abstract-pool.ts:614
+Private set
+set ( ) : void
+Returns void set
@@ -1179,16 +1417,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:532
set
@@ -1202,12 +1442,13 @@ Can be overridden.
+
+
Returns void
Defined in src/pools/abstract-pool.ts:551
Protected setup
@@ -1219,7 +1460,7 @@ Can be overridden.
Returns void
Defined in src/pools/abstract-pool.ts:987
Private shall
@@ -1231,7 +1472,7 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:1177
Private shall
@@ -1244,7 +1485,7 @@ Can be overridden.
workerNodeKey : number
Returns boolean Defined in src/pools/abstract-pool.ts:861
Private shall
@@ -1258,20 +1499,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:924
Private task
@@ -1284,7 +1530,7 @@ Can be overridden.
workerId : number
Returns void Defined in src/pools/abstract-pool.ts:1430
Private tasks
@@ -1297,7 +1543,7 @@ Can be overridden.
workerNodeKey : number
Returns number Defined in src/pools/abstract-pool.ts:1662
Private tasks
@@ -1310,7 +1556,23 @@ Can be overridden.
workerId : number
Returns void Defined in src/pools/abstract-pool.ts:1458
+Private unset
+unset ( ) : void
+Returns void Private unset
+unset ( ) : void
+Returns void Private update
@@ -1325,7 +1587,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void Defined in src/pools/abstract-pool.ts:1120
Private update
@@ -1340,7 +1602,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void Defined in src/pools/abstract-pool.ts:1093
Private update
@@ -1355,7 +1617,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void Defined in src/pools/abstract-pool.ts:1075
Private update
@@ -1370,7 +1632,7 @@ Can be overridden.
taskName : string
Returns void Defined in src/pools/abstract-pool.ts:1411
Private update
@@ -1385,39 +1647,28 @@ Can be overridden.
task : Task < Data >
Returns void Protected worker poolifier - v3.0.0
\ No newline at end of file
+
Number of workers that this pool should manage.
-