X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=30969c24eba5305e5ab3a9f7431500638caca2a7;hb=5ee29ca61ee790da371ad3a83fc7b9c79fb02de2;hp=92d46d153c26a6e332bce691985d560adac71ee5;hpb=cc35cd9cb7323e39c9f521cdd4fbf51d1d31bbdf;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index 92d46d15..30969c24 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:60
-
+
Constructors
-constructor
+
Properties
-emitter?
+
Accessors
-busy
+
Methods
-add
+
add
+
add after after before
@@ -107,6 +109,7 @@
create create create
+
delete dequeue destroy destroy
@@ -122,29 +125,38 @@
handle handle has
+
has has internal is
-
list
+
list redistribute 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 +167,7 @@
Constructors
constructor constructor
new < Worker , Data , Response > ( numberOfWorkers , filePath , opts ) : AbstractPool < Worker , Data , Response >
@@ -176,19 +188,22 @@
numberOfWorkers : number
+
+
filePath : string
+
Returns AbstractPool < Worker , Data , Response >
+
Defined in src/pools/abstract-pool.ts:122
Protected Readonly file file : string
@@ -217,7 +232,7 @@
+Defined in src/pools/abstract-pool.ts:124
Protected Optional Readonly max max ?: number
@@ -225,7 +240,7 @@
+
Defined in src/pools/abstract-pool.ts:93
Protected Readonly number number : number
@@ -233,7 +248,7 @@
+
Defined in src/pools/abstract-pool.ts:123
Protected Readonly opts
+Defined in src/pools/abstract-pool.ts:125
Protected promise Defined in src/pools/abstract-pool.ts:113
Private started started : boolean
@@ -270,15 +285,27 @@
Defined in src/pools/abstract-pool.ts:105
Private Readonly starting Private starting starting : boolean
Defined in src/pools/abstract-pool.ts:109
+Private Readonly task Protected worker Defined in src/pools/abstract-pool.ts:84
Readonly Internal worker Defined in src/pools/abstract-pool.ts:66
Protected full
@@ -321,7 +348,7 @@
Returns boolean
Defined in src/pools/abstract-pool.ts:732
+Defined in src/pools/abstract-pool.ts:352
Protected max
@@ -344,7 +371,7 @@
Returns number
Defined in src/pools/abstract-pool.ts:565
Protected min
@@ -355,7 +382,7 @@
Returns number
Defined in src/pools/abstract-pool.ts:558
Private ready
@@ -366,7 +393,7 @@
Returns boolean
Defined in src/pools/abstract-pool.ts:510
Protected Abstract type
@@ -378,7 +405,7 @@
Returns "fixed" | "dynamic"
Defined in src/pools/abstract-pool.ts:548
+Defined in src/pools/abstract-pool.ts:527
Protected Abstract worker
@@ -401,9 +428,40 @@
Returns "thread" | "cluster"
Defined in src/pools/abstract-pool.ts:553
Methods
+
Private add
@@ -417,14 +475,15 @@
worker : Worker
+
+
Returns number The added worker node key.
Defined in src/pools/abstract-pool.ts:1624
Protected after
@@ -439,15 +498,17 @@ Can be overridden.
workerNodeKey : number
+
+
message : MessageValue < Response , unknown >
+
+
Returns void
Defined in src/pools/abstract-pool.ts:1090
Protected after
@@ -462,11 +523,12 @@ Can be overridden.
workerNodeKey : number
+
+
Returns void
Defined in src/pools/abstract-pool.ts:1374
Protected before
@@ -481,15 +543,17 @@ Can be overridden.
workerNodeKey : number
+
+
task : Task < Data >
+
+
Returns void
Defined in src/pools/abstract-pool.ts:1060
Private build
@@ -502,7 +566,7 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:681
Private check
@@ -510,7 +574,7 @@ Can be overridden.
Returns void Defined in src/pools/abstract-pool.ts:1599
Private check
@@ -518,7 +582,7 @@ Can be overridden.
Returns void Defined in src/pools/abstract-pool.ts:1587
Private check
@@ -526,7 +590,7 @@ Can be overridden.
Returns void Defined in src/pools/abstract-pool.ts:1593
Protected check
@@ -541,7 +605,7 @@ Can be overridden.
max : number
Returns void Defined in src/pools/abstract-pool.ts:197
Private check
@@ -554,7 +618,7 @@ Can be overridden.
filePath : string
Returns void Defined in src/pools/abstract-pool.ts:166
Private check
@@ -568,13 +632,14 @@ Can be overridden.
message : MessageValue < Response , unknown >
+
+
Returns void
Defined in src/pools/abstract-pool.ts:575
Private check
@@ -587,7 +652,7 @@ Can be overridden.
numberOfWorkers : number
Returns void Defined in src/pools/abstract-pool.ts:179
Private check
@@ -600,7 +665,7 @@ Can be overridden.
Returns void Defined in src/pools/abstract-pool.ts:223
Private check
@@ -613,7 +678,7 @@ Can be overridden.
Returns void Defined in src/pools/abstract-pool.ts:314
Private check
@@ -626,7 +691,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:254
Private check
@@ -639,7 +704,7 @@ Can be overridden.
Returns void Defined in src/pools/abstract-pool.ts:267
Private choose
@@ -652,7 +717,7 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:1217
Protected create
@@ -664,7 +729,7 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:1307
Protected create
@@ -676,7 +741,7 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:1263
Protected Abstract create
@@ -688,7 +753,20 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:1256
+Private delete
+delete ( name ) : void
+
+Returns void Private dequeue
@@ -701,7 +779,7 @@ Can be overridden.
workerNodeKey : number
Returns undefined | Task < Data > Defined in src/pools/abstract-pool.ts:1689
+Defined in src/pools/abstract-pool.ts:1000
Protected Abstract destroy
@@ -727,11 +805,12 @@ Can be overridden.
workerNodeKey : number
+
+
Returns Promise < void >
Defined in src/pools/abstract-pool.ts:1036
enable
@@ -745,16 +824,18 @@ Can be overridden.
enable : boolean
+
+
Optional
+
+
Returns void
Defined in src/pools/abstract-pool.ts:646
Private enqueue
@@ -769,7 +850,7 @@ Can be overridden.
task : Task < Data >
Returns number Defined in src/pools/abstract-pool.ts:1683
execute
@@ -783,21 +864,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:930
Private execute
@@ -811,15 +895,17 @@ Can be overridden.
workerNodeKey : number
+
+
task : Task < Data >
+
+
Returns void
Defined in src/pools/abstract-pool.ts:1677
Protected flush
@@ -832,7 +918,7 @@ Can be overridden.
workerNodeKey : number
Returns void Defined in src/pools/abstract-pool.ts:1697
Private flush
@@ -840,11 +926,11 @@ Can be overridden.
Returns void Defined in src/pools/abstract-pool.ts:1707
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:1613
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:594
Private get
@@ -890,14 +978,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:606
Private handle
@@ -910,7 +999,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void Defined in src/pools/abstract-pool.ts:1559
Private handle
@@ -923,7 +1012,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void Defined in src/pools/abstract-pool.ts:1543
Private has
@@ -931,7 +1020,28 @@ Can be overridden.
Returns boolean Defined in src/pools/abstract-pool.ts:1662
+
has
@@ -945,13 +1055,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:1655
Protected internal
@@ -963,7 +1074,7 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:748
Protected Abstract is
@@ -974,20 +1085,20 @@ Can be overridden.
Returns boolean
Defined in src/pools/abstract-pool.ts:895
Private redistribute
@@ -1000,7 +1111,7 @@ Can be overridden.
workerNodeKey : number
Returns void Defined in src/pools/abstract-pool.ts:1417
Protected Abstract register
@@ -1019,11 +1130,13 @@ Can be overridden.
workerNodeKey : number
+
+
listener : ( ( message ) => void )
@@ -1038,7 +1151,28 @@ Can be overridden.
Returns void
Defined in src/pools/abstract-pool.ts:1361
+
Private remove
@@ -1052,26 +1186,25 @@ Can be overridden.
worker : Worker
+
+
Returns void
Defined in src/pools/abstract-pool.ts:1646
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:1010
Protected Abstract send
@@ -1085,11 +1218,12 @@ Can be overridden.
workerNodeKey : number
+
+
Returns void
Defined in src/pools/abstract-pool.ts:1398
Private send
@@ -1103,11 +1237,40 @@ Can be overridden.
workerNodeKey : number
+
+
Returns void
Defined in src/pools/abstract-pool.ts:1405
+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 +1284,51 @@ Can be overridden.
workerNodeKey : number
+
+
+
+
Optional transferList : TransferListItem [] Optional
+
+
Returns void
Defined in src/pools/abstract-pool.ts:1245
+set Private set
+set ( ) : void
+Returns void set
@@ -1147,12 +1342,13 @@ Can be overridden.
+
+
Returns void
Defined in src/pools/abstract-pool.ts:660
Private set
@@ -1165,7 +1361,15 @@ Can be overridden.
size : number
Returns void Defined in src/pools/abstract-pool.ts:695
+Private set
+set ( ) : void
+Returns void set
@@ -1179,16 +1383,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:613
set
@@ -1202,12 +1408,13 @@ Can be overridden.
+
+
Returns void
Defined in src/pools/abstract-pool.ts:632
Protected setup
@@ -1219,7 +1426,7 @@ Can be overridden.
Returns void
Defined in src/pools/abstract-pool.ts:1044
Private shall
@@ -1231,7 +1438,7 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:1234
Private shall
@@ -1244,7 +1451,7 @@ Can be overridden.
workerNodeKey : number
Returns boolean Defined in src/pools/abstract-pool.ts:921
Private shall
@@ -1258,20 +1465,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:984
Private task
@@ -1284,7 +1496,7 @@ Can be overridden.
workerId : number
Returns void Defined in src/pools/abstract-pool.ts:1457
Private tasks
@@ -1297,7 +1509,7 @@ Can be overridden.
workerNodeKey : number
Returns number Defined in src/pools/abstract-pool.ts:1693
Private tasks
@@ -1310,7 +1522,23 @@ Can be overridden.
workerId : number
Returns void Defined in src/pools/abstract-pool.ts:1485
+Private unset
+unset ( ) : void
+Returns void Private unset
+unset ( ) : void
+Returns void Private update
@@ -1325,7 +1553,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void Defined in src/pools/abstract-pool.ts:1177
Private update
@@ -1340,7 +1568,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void Defined in src/pools/abstract-pool.ts:1150
Private update
@@ -1355,7 +1583,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void Defined in src/pools/abstract-pool.ts:1132
Private update
@@ -1370,7 +1598,7 @@ Can be overridden.
taskName : string
Returns void Defined in src/pools/abstract-pool.ts:1438
Private update
@@ -1385,7 +1613,7 @@ Can be overridden.
task : Task < Data >
Returns void Defined in src/pools/abstract-pool.ts:1164
Protected worker
@@ -1412,20 +1640,20 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:1525
+poolifier - v2.7.0
\ No newline at end of file
+
Number of workers that this pool should manage.
-