X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=905e085b6ed963eb2e2a81ee9ea6fc6774756b6f;hb=5543cb1ca8011b99a67fcd5fd3a7a5c2b1c4a85e;hp=92d46d153c26a6e332bce691985d560adac71ee5;hpb=cc35cd9cb7323e39c9f521cdd4fbf51d1d31bbdf;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index 92d46d15..905e085b 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
+
Methods
-add
+
add
+
add after after before
@@ -95,19 +97,17 @@
check check check
-
check
-
check check check check
-
check
-
check check choose create create create
+
delete dequeue
+
deregister destroy destroy enable
@@ -122,29 +122,39 @@
handle handle has
+
has has internal is
-
list
+
list redistribute
+
register register
+
remove remove send send send
+
send
+
send send
+
set
+
set set set
+
set set set setup shall shall shall
-
start
+
start task tasks tasks
+
unset
+
unset update update update
@@ -155,7 +165,7 @@
Constructors
constructor constructor
new < Worker , Data , Response > ( numberOfWorkers , filePath , opts ) : AbstractPool < Worker , Data , Response >
@@ -176,19 +186,22 @@
numberOfWorkers : number
+
+
filePath : string
+
Returns AbstractPool < Worker , Data , Response >
+
Defined in src/pools/abstract-pool.ts:126
Protected Readonly file file : string
@@ -217,7 +230,7 @@
+Defined in src/pools/abstract-pool.ts:128
Protected Optional Readonly max max ?: number
@@ -225,7 +238,7 @@
+
Defined in src/pools/abstract-pool.ts:97
Protected Readonly number number : number
@@ -233,7 +246,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 +283,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:88
Readonly Internal worker Defined in src/pools/abstract-pool.ts:70
Protected full
@@ -321,7 +346,7 @@
Returns boolean
Defined in src/pools/abstract-pool.ts:645
+Defined in src/pools/abstract-pool.ts:265
Protected max
@@ -344,7 +369,7 @@
Returns number
Defined in src/pools/abstract-pool.ts:478
Protected min
@@ -355,7 +380,7 @@
Returns number
Defined in src/pools/abstract-pool.ts:471
Private ready
@@ -366,7 +391,7 @@
Returns boolean
Defined in src/pools/abstract-pool.ts:423
Protected Abstract type
@@ -378,7 +403,7 @@
Returns "fixed" | "dynamic"
Defined in src/pools/abstract-pool.ts:461
+Defined in src/pools/abstract-pool.ts:440
Protected Abstract worker
@@ -401,9 +426,40 @@
Returns "thread" | "cluster"
Defined in src/pools/abstract-pool.ts:466
Methods
+
Private add
@@ -417,14 +473,15 @@
worker : Worker
+
+
Returns number The added worker node key.
Defined in src/pools/abstract-pool.ts:1587
Protected after
@@ -439,15 +496,17 @@ Can be overridden.
workerNodeKey : number
+
+
message : MessageValue < Response , unknown >
+
+
Returns void
Defined in src/pools/abstract-pool.ts:1026
Protected after
@@ -462,11 +521,12 @@ Can be overridden.
workerNodeKey : number
+
+
Returns void
Defined in src/pools/abstract-pool.ts:1337
Protected before
@@ -481,15 +541,17 @@ Can be overridden.
workerNodeKey : number
+
+
task : Task < Data >
+
+
Returns void
Defined in src/pools/abstract-pool.ts:996
Private build
@@ -502,7 +564,7 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:594
Private check
@@ -510,7 +572,7 @@ Can be overridden.
Returns void Defined in src/pools/abstract-pool.ts:1562
Private check
@@ -518,7 +580,7 @@ Can be overridden.
Returns void Defined in src/pools/abstract-pool.ts:1550
Private check
@@ -526,35 +588,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:1556
Private check
@@ -566,15 +600,16 @@ Can be overridden.
Parameters
+
+
Returns void
Defined in src/pools/abstract-pool.ts:488
Private check
@@ -587,7 +622,7 @@ Can be overridden.
numberOfWorkers : number
Returns void Defined in src/pools/abstract-pool.ts:170
Private check
@@ -600,33 +635,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 +648,7 @@ Can be overridden.
Returns void Defined in src/pools/abstract-pool.ts:217
Private choose
@@ -652,7 +661,7 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:1153
Protected create
@@ -664,7 +673,7 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:1243
Protected create
@@ -676,7 +685,7 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:1199
Protected Abstract create
@@ -688,7 +697,20 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:1192
+Private delete
+delete ( name ) : void
+
+Returns void Private dequeue
@@ -701,7 +723,47 @@ Can be overridden.
workerNodeKey : number
Returns undefined | Task < Data > Defined in src/pools/abstract-pool.ts:1652
+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:934
Protected Abstract destroy
@@ -727,11 +789,12 @@ Can be overridden.
workerNodeKey : number
+
+
Returns Promise < void >
Defined in src/pools/abstract-pool.ts:972
enable
@@ -745,16 +808,18 @@ Can be overridden.
enable : boolean
+
+
Optional
+
+
Returns void
Defined in src/pools/abstract-pool.ts:559
Private enqueue
@@ -769,7 +834,7 @@ Can be overridden.
task : Task < Data >
Returns number Defined in src/pools/abstract-pool.ts:1646
execute
@@ -783,21 +848,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:864
Private execute
@@ -811,15 +879,17 @@ Can be overridden.
workerNodeKey : number
+
+
task : Task < Data >
+
+
Returns void
Defined in src/pools/abstract-pool.ts:1640
Protected flush
@@ -832,7 +902,7 @@ Can be overridden.
workerNodeKey : number
Returns void Defined in src/pools/abstract-pool.ts:1660
Private flush
@@ -840,11 +910,11 @@ Can be overridden.
Returns void Defined in src/pools/abstract-pool.ts:1670
Protected get
-get ( workerNodeKey ) : undefined | WorkerInfo get ( workerNodeKey ) : WorkerInfo
@@ -854,12 +924,13 @@ Can be overridden.
workerNodeKey : number
-The worker information.
+
+
+The worker information.
Defined in src/pools/abstract-pool.ts:1576
Private get
@@ -873,12 +944,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:507
Private get
@@ -890,14 +962,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:519
Private handle
@@ -910,7 +983,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void Defined in src/pools/abstract-pool.ts:1522
Private handle
@@ -923,7 +996,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void Defined in src/pools/abstract-pool.ts:1506
Private has
@@ -931,7 +1004,28 @@ Can be overridden.
Returns boolean Defined in src/pools/abstract-pool.ts:1625
+
has
@@ -945,13 +1039,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:1618
Protected internal
@@ -963,7 +1058,7 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:661
Protected Abstract is
@@ -974,20 +1069,20 @@ Can be overridden.
Returns boolean
Defined in src/pools/abstract-pool.ts:829
Private redistribute
@@ -1000,7 +1095,47 @@ Can be overridden.
workerNodeKey : number
Returns void Defined in src/pools/abstract-pool.ts:1380
+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 +1154,13 @@ Can be overridden.
workerNodeKey : number
+
+
listener : ( ( message ) => void )
@@ -1038,7 +1175,28 @@ Can be overridden.
Returns void
Defined in src/pools/abstract-pool.ts:1298
+
Private remove
@@ -1052,26 +1210,25 @@ Can be overridden.
worker : Worker
+
+
Returns void
Defined in src/pools/abstract-pool.ts:1609
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:944
Protected Abstract send
@@ -1085,11 +1242,12 @@ Can be overridden.
workerNodeKey : number
+
+
Returns void
Defined in src/pools/abstract-pool.ts:1361
Private send
@@ -1103,11 +1261,40 @@ Can be overridden.
workerNodeKey : number
+
+
Returns void
Defined in src/pools/abstract-pool.ts:1368
+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 +1308,51 @@ Can be overridden.
workerNodeKey : number
+
+
+
+
Optional transferList : TransferListItem [] Optional
+
+
Returns void
Defined in src/pools/abstract-pool.ts:1181
+set Private set
+set ( ) : void
+Returns void set
@@ -1147,12 +1366,13 @@ Can be overridden.
+
+
Returns void
Defined in src/pools/abstract-pool.ts:573
Private set
@@ -1165,7 +1385,15 @@ Can be overridden.
size : number
Returns void Defined in src/pools/abstract-pool.ts:608
+Private set
+set ( ) : void
+Returns void set
@@ -1179,16 +1407,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:526
set
@@ -1202,12 +1432,13 @@ Can be overridden.
+
+
Returns void
Defined in src/pools/abstract-pool.ts:545
Protected setup
@@ -1219,7 +1450,7 @@ Can be overridden.
Returns void
Defined in src/pools/abstract-pool.ts:980
Private shall
@@ -1231,7 +1462,7 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:1170
Private shall
@@ -1244,7 +1475,7 @@ Can be overridden.
workerNodeKey : number
Returns boolean Defined in src/pools/abstract-pool.ts:855
Private shall
@@ -1258,20 +1489,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:918
Private task
@@ -1284,7 +1520,7 @@ Can be overridden.
workerId : number
Returns void Defined in src/pools/abstract-pool.ts:1420
Private tasks
@@ -1297,7 +1533,7 @@ Can be overridden.
workerNodeKey : number
Returns number Defined in src/pools/abstract-pool.ts:1656
Private tasks
@@ -1310,7 +1546,23 @@ Can be overridden.
workerId : number
Returns void Defined in src/pools/abstract-pool.ts:1448
+Private unset
+unset ( ) : void
+Returns void Private unset
+unset ( ) : void
+Returns void Private update
@@ -1325,7 +1577,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void Defined in src/pools/abstract-pool.ts:1113
Private update
@@ -1340,7 +1592,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void Defined in src/pools/abstract-pool.ts:1086
Private update
@@ -1355,7 +1607,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void Defined in src/pools/abstract-pool.ts:1068
Private update
@@ -1370,7 +1622,7 @@ Can be overridden.
taskName : string
Returns void Defined in src/pools/abstract-pool.ts:1401
Private update
@@ -1385,7 +1637,7 @@ Can be overridden.
task : Task < Data >
Returns void Defined in src/pools/abstract-pool.ts:1100
Protected worker
@@ -1412,20 +1664,20 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:1488
+poolifier - v2.7.1
\ No newline at end of file
+
Number of workers that this pool should manage.
-