X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=docs%2Fclasses%2FAbstractPool.html;h=5e92789021fa4414e60df74c0dfe581a710f39ce;hb=eedbbd20d7c77c4b62c129ebfa4a4c4a06d5d06a;hp=aff9850dd46ceb55e6088a5de0ea9e4d8b744410;hpb=0fa1d6f0433baf6ff3f67fefdbdf610612a4f3e9;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index aff9850d..5e927890 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,13 +1,13 @@
-
AbstractPool | poolifier - v2.6.32
@@ -49,19 +49,19 @@
IPool < Worker , Data , Response >
+
Defined in src/pools/abstract-pool.ts:64
- Index
+ Index
Constructors
-constructor
+
Properties
-emitter?
+
Accessors
-busy
+
Constructors
-constructor
+constructor
new Abstract Pool < Worker , Data , Response > ( numberOfWorkers , filePath , opts ) : AbstractPool < Worker , Data , Response >
@@ -188,19 +202,20 @@
Returns AbstractPool < Worker , Data , Response >
+
Defined in src/pools/abstract-pool.ts:126
Protected
Readonly
number Of Workers
number Of Workers : number
@@ -233,7 +248,7 @@
+
Defined in src/pools/abstract-pool.ts:127
Protected
Readonly
opts
@@ -241,11 +256,11 @@
+
Defined in src/pools/abstract-pool.ts:129
Protected
promise Response Map
-
+
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 Functions
+
+
+
Protected
worker Choice Strategy Context
@@ -286,7 +313,7 @@
+Defined in src/pools/abstract-pool.ts:88
Readonly
Internal
worker Nodes
@@ -295,7 +322,7 @@
+
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 Size
@@ -344,7 +371,7 @@
Returns number
+
Defined in src/pools/abstract-pool.ts:484
Protected
min Size
@@ -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
+
Defined in src/pools/abstract-pool.ts:1596
Protected
after Task Execution Hook
@@ -450,7 +508,7 @@ Can be overridden.
Returns void
+
Defined in src/pools/abstract-pool.ts:1035
Protected
after Worker Node Setup
@@ -470,7 +528,7 @@ Can be overridden.
Returns void
+
Defined in src/pools/abstract-pool.ts:1346
Protected
before Task Execution Hook
@@ -495,7 +553,7 @@ Can be overridden.
Returns void
+
Defined in src/pools/abstract-pool.ts:1005
Private
build Tasks Queue Options
@@ -508,7 +566,7 @@ Can be overridden.
+
Defined in src/pools/abstract-pool.ts:600
Private
check And Emit Dynamic Worker Creation Events
@@ -516,7 +574,7 @@ Can be overridden.
Returns void
+
Defined in src/pools/abstract-pool.ts:1571
Private
check And Emit Task Execution Events
@@ -524,7 +582,7 @@ Can be overridden.
Returns void
+
Defined in src/pools/abstract-pool.ts:1559
Private
check And Emit Task Queuing Events
@@ -532,35 +590,7 @@ Can be overridden.
Returns void
-
-Protected
check Dynamic Pool Size
-
-check Dynamic Pool Size ( min , max ) : void
-
-
-
Parameters
-
-
-min : number
-
-max : number
-Returns void
-
-Private
check File Path
-
-check File Path ( filePath ) : void
-
-
-Returns void
+
Defined in src/pools/abstract-pool.ts:1565
Private
check Message Worker Id
@@ -572,7 +602,7 @@ Can be overridden.
Parameters
@@ -581,7 +611,7 @@ Can be overridden.
Throws https://nodejs.org/api/errors.html#class-error If the worker id is invalid.
+Defined in src/pools/abstract-pool.ts:494
Private
check Number Of Workers
@@ -594,7 +624,7 @@ Can be overridden.
numberOfWorkers : number
Returns void
+Defined in src/pools/abstract-pool.ts:170
Private
check Pool Options
@@ -607,33 +637,7 @@ Can be overridden.
Returns void
-
-Private
check Valid Tasks Queue Options
-
-check Valid Tasks Queue Options ( tasksQueueOptions ) : void
-
-
-Returns void
-
-Private
check Valid Worker Choice Strategy
-
-check Valid Worker Choice Strategy ( 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 Valid Worker Choice Strategy Options
@@ -646,7 +650,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:217
Private
choose Worker Node
@@ -659,7 +663,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1162
Protected
create And Setup Dynamic Worker Node
@@ -671,7 +675,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1252
Protected
create And Setup Worker Node
@@ -683,7 +687,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1208
Protected
Abstract
create Worker
@@ -695,7 +699,20 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1201
+
+Private
delete Task Function Worker Usages
+
+delete Task Function Worker Usages ( name ) : void
+
+
+Returns void
Private
dequeue Task
@@ -708,7 +725,47 @@ Can be overridden.
workerNodeKey : number
Returns undefined | Task < Data >
+Defined in src/pools/abstract-pool.ts:1661
+
+Protected
Abstract
deregister Worker Message Listener
+
+deregister Worker Message Listener < 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 Worker Node
@@ -739,7 +796,7 @@ Can be overridden.
Returns Promise < void >
+Defined in src/pools/abstract-pool.ts:981
+Defined in src/pools/abstract-pool.ts:565
Private
enqueue Task
@@ -779,7 +836,7 @@ Can be overridden.
task : Task < Data >
Returns number
+Defined in src/pools/abstract-pool.ts:1655
+Defined in src/pools/abstract-pool.ts:870
Private
execute Task
@@ -834,7 +891,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1649
Protected
flush Tasks Queue
@@ -847,7 +904,7 @@ Can be overridden.
workerNodeKey : number
Returns void
+Defined in src/pools/abstract-pool.ts:1669
Private
flush Tasks Queues
@@ -855,11 +912,11 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1679
Protected
get Worker Info
-get Worker Info ( workerNodeKey ) : undefined | WorkerInfo
+get Worker Info ( workerNodeKey ) : WorkerInfo
@@ -871,11 +928,11 @@ Can be overridden.
-The worker information.
+The worker information.
+Defined in src/pools/abstract-pool.ts:1585
Private
get Worker Node Key By Worker
@@ -895,7 +952,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:513
Private
get Worker Node Key By Worker Id
@@ -907,7 +964,7 @@ Can be overridden.
Parameters
-workerId : number
+workerId : undefined | number
@@ -915,7 +972,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:525
Private
handle Task Execution Response
@@ -928,7 +985,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1531
Private
handle Worker Ready Response
@@ -941,7 +998,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1515
Private
has Back Pressure
@@ -949,7 +1006,28 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:1634
+
has Worker Node Back Pressure
+Defined in src/pools/abstract-pool.ts:1627
+
+Private
initialize Event Emitter
+
+initialize Event Emitter ( ) : void
+
+Returns void
Protected
internal Busy
@@ -982,7 +1068,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:667
Protected
Abstract
is Main
@@ -993,20 +1079,20 @@ Can be overridden.
Returns boolean
-
+
+Defined in src/pools/abstract-pool.ts:835
Private
redistribute Queued Tasks
@@ -1019,7 +1105,47 @@ Can be overridden.
workerNodeKey : number
Returns void
+Defined in src/pools/abstract-pool.ts:1389
+
+Protected
Abstract
register Once Worker Message Listener
+
+register Once Worker Message Listener < Message > ( workerNodeKey , listener ) : void
+
+
+
+
+
Parameters
+
+
+workerNodeKey : number
+
+
+
+listener : ( ( message ) => void )
+
+
+
+
+
+( message ) : void
+
+
+Returns void
+Returns void
+
Protected
Abstract
register Worker Message Listener
@@ -1059,7 +1185,28 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1307
+
Private
remove Worker Node
@@ -1078,22 +1225,20 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1618
Protected
send Kill Message To Worker
-send Kill Message To Worker ( workerNodeKey , workerId ) : Promise < void >
+send Kill Message To Worker ( workerNodeKey ) : Promise < void >
Parameters
-workerNodeKey : number
-
-workerId : number
+workerNodeKey : number
Returns Promise < void >
+Defined in src/pools/abstract-pool.ts:953
Protected
Abstract
send Startup Message To Worker
@@ -1112,7 +1257,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1370
Private
send Statistics Message To Worker
@@ -1131,7 +1276,35 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1377
+
+Private
send Task Function Operation To Worker
+
+send Task Function Operation To Worker ( workerNodeKey , message ) : Promise < boolean >
+
+
+
Parameters
+
+
+workerNodeKey : number
+
+
+Returns Promise < boolean >
+
+Private
send Task Function Operation To Workers
+
+send Task Function Operation To Workers ( message ) : Promise < boolean >
+
+
+Returns Promise < boolean >
Protected
Abstract
send To Worker
@@ -1160,20 +1333,36 @@ Can be overridden.
Returns void
-
-Private
set Tasks Queue Max Size
-
+
+set Default Task Function
+
+set Default Task Function ( name ) : Promise < boolean >
+
+name : string
+
+
+Returns Promise < boolean > true
if the default task function was set, false
otherwise.
+
+
+
+Private
set Task Stealing
+
+set Task Stealing ( ) : void
+
Returns void
+Defined in src/pools/abstract-pool.ts:620
+Defined in src/pools/abstract-pool.ts:579
+
+Private
set Tasks Queue Size
+
+set Tasks Queue Size ( size ) : void
+
+
+Returns void
+
+Private
set Tasks Stealing On Back Pressure
+
+set Tasks Stealing On Back Pressure ( ) : void
+
+Returns void
+Defined in src/pools/abstract-pool.ts:532
set Worker Choice Strategy Options
+Defined in src/pools/abstract-pool.ts:551
Protected
setup Hook
@@ -1250,7 +1460,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:989
Private
shall Create Dynamic Worker
@@ -1262,7 +1472,20 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1179
+
+Private
shall Execute Task
+
+shall Execute Task ( workerNodeKey ) : boolean
+
+
+Returns boolean
Private
shall Update Task Function Worker Usage
@@ -1282,15 +1505,32 @@ Can be overridden.
-
+
+start
+
+start ( ) : void
+
+
+Returns void
+
+
+Private
task Stealing On Empty Queue
-start Pool ( ) : void
+task Stealing On Empty Queue ( workerId ) : void
+
Returns void
+Defined in src/pools/abstract-pool.ts:1429
Private
tasks Queue Size
@@ -1303,7 +1543,7 @@ Can be overridden.
workerNodeKey : number
Returns number
+Defined in src/pools/abstract-pool.ts:1665
Private
tasks Stealing On Back Pressure
@@ -1316,7 +1556,23 @@ Can be overridden.
workerId : number
Returns void
+Defined in src/pools/abstract-pool.ts:1457
+
+Private
unset Task Stealing
+
+unset Task Stealing ( ) : void
+
+Returns void
+
+Private
unset Tasks Stealing On Back Pressure
+
+unset Tasks Stealing On Back Pressure ( ) : void
+
+Returns void
Private
update Elu Worker Usage
@@ -1331,7 +1587,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1122
Private
update Run Time Worker Usage
@@ -1346,7 +1602,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1095
Private
update Task Statistics Worker Usage
@@ -1361,7 +1617,22 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1077
+
+Private
update Task Stolen Statistics Worker Usage
+
+update Task Stolen Statistics Worker Usage ( workerNodeKey , taskName ) : void
+
+
+
Parameters
+
+
+workerNodeKey : number
+
+taskName : string
+Returns void
Private
update Wait Time Worker Usage
@@ -1376,7 +1647,7 @@ Can be overridden.
task : Task < Data >
Returns void
+Defined in src/pools/abstract-pool.ts:1109
Protected
worker Listener
@@ -1403,20 +1674,20 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1497
+poolifier - v2.7.3
+
-
\ No newline at end of file
+Generated using TypeDoc
+
\ No newline at end of file
Emitter on which events can be listened to.
+
+Optional
emitterEvent emitter integrated with async resource on which events can be listened to. +The async tracking tooling identifier is
poolifier:<PoolType>-<WorkerType>-pool
.Events that can currently be listened to:
'ready'
: Emitted when the number of workers created in the pool has reached the minimum size expected and are ready.'busy'
: Emitted when the number of workers created in the pool has reached the maximum size expected and are executing at least one task.'busy'
: Emitted when the number of workers created in the pool has reached the maximum size expected and are executing concurrently their tasks quota.'full'
: Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.destroy
': Emitted when the pool is destroyed.'destroy'
: Emitted when the pool is destroyed.'error'
: Emitted when an uncaught error occurs.'taskError'
: Emitted when an error occurs while executing a task.'backPressure'
: Emitted when all worker nodes have back pressure (i.e. their tasks queue is full: queue size >= maximum queue size).Protected
Readonly
fileProtected
Optional
Readonly
max