X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=docs%2Fclasses%2FFixedThreadPool.html;h=0d1b7df1ba15a94c819c585c8e752b08e43f9b97;hb=a2742ce794032ee57b3ec1203c500b1aecca34f0;hp=f8dc274d99246367287aeda7b11c8bac89b4b505;hpb=88d983fa5c8db26fa52b8a69a2b724ade989db9b;p=poolifier.git diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index f8dc274d..0d1b7df1 100644 --- a/docs/classes/FixedThreadPool.html +++ b/docs/classes/FixedThreadPool.html @@ -44,7 +44,7 @@
+'full'
: Emitted when the pool is dynamic and full.'busy'
: Emitted when the pool is busy.'error'
: Emitted when an uncaught error occurs.'taskError'
: Emitted when an error occurs while executing a task.Readonly
fileReadonly
numberReadonly
optsProtected
promiseProtected
workerReadonly
workerProtected
fullPrivate
number
Number of tasks queued in the pool.
+Pool information.
Returns number
+ Size
+Protected
max+- get maxSize(): number
-
-
-
-
-
+
+
@@ -648,9 +650,9 @@ Can be overridden
- worker
Nodes
- busy
- full
-- number
Of Queued Tasks
-- number
Of Running Tasks
-- size
+- info
+- max
Size
+- min
Size
- type
- after
Task Execution Hook
- after
Worker Setup
@@ -674,7 +676,6 @@ Can be overridden
Number of tasks running in the pool.
+Pool maximum size.
Returns number
Inherited from AbstractPool.numberOfRunningTasks
+Overrides AbstractPool.maxSize
-- Defined in src/pools/abstract-pool.ts:219
size
--- get size(): number
+- Defined in src/pools/thread/fixed.ts:104
Size
+Protected
min+- get minSize(): number
-
-
-
+- Defined in src/pools/thread/fixed.ts:99
+- Defined in src/pools/thread/fixed.ts:94
@@ -294,7 +296,7 @@ Can be overridden.
+- Defined in src/pools/abstract-pool.ts:450
Worker Setup
+- Defined in src/pools/thread/fixed.ts:84
Task Execution Hook
+- Defined in src/pools/abstract-pool.ts:439
Worker Node
+- Defined in src/pools/abstract-pool.ts:518
And Setup Worker
+- Defined in src/pools/abstract-pool.ts:581
Worker
+- Defined in src/pools/thread/fixed.ts:77
+- Defined in src/pools/abstract-pool.ts:402
Worker
+- Defined in src/pools/thread/fixed.ts:53
+- Defined in src/pools/abstract-pool.ts:314
+- Defined in src/pools/abstract-pool.ts:367
Busy
+- Defined in src/pools/abstract-pool.ts:358
Main
+- Defined in src/pools/thread/fixed.ts:48
Worker Message Listener
+- Defined in src/pools/thread/fixed.ts:69
To Worker
+- Defined in src/pools/thread/fixed.ts:61
+- Defined in src/pools/abstract-pool.ts:326
+- Defined in src/pools/abstract-pool.ts:273
+- Defined in src/pools/abstract-pool.ts:303
Hook
+- Defined in src/pools/abstract-pool.ts:424
Listener
+ - Defined in src/pools/abstract-pool.ts:614
Pool maximum size.
+Pool minimum size.
Returns number
Overrides AbstractPool.size
+Overrides AbstractPool.minSize
-- Defined in src/pools/thread/fixed.ts:100
type
-- get type(): PoolType
+- get type(): "fixed" | "dynamic"
-
-
+
Pool type.
If it is
'dynamic'
, it provides themax
property.Returns PoolType
Returns "fixed" | "dynamic"
Overrides AbstractPool.type
-- Defined in src/pools/thread/fixed.ts:95
Methods
Returns void
Inherited from AbstractPool.afterTaskExecutionHook
-- Defined in src/pools/abstract-pool.ts:423
Protected
after@@ -313,7 +315,7 @@ Can be overridden.
Returns void
Overrides AbstractPool.afterWorkerSetup
-- Defined in src/pools/thread/fixed.ts:85
Protected
before@@ -332,20 +334,20 @@ Can be overridden.
Returns void
Inherited from AbstractPool.beforeTaskExecutionHook
-- Defined in src/pools/abstract-pool.ts:412
Protected
choose-- choose
Worker Node(): [number, WorkerNode<ThreadWorkerWithMessageChannel, Data>]
+- choose
Worker Node(): number
-
-
Chooses a worker node for the next task.
-The default uses a round robin algorithm to distribute the load.
+The default worker choice strategy uses a round robin algorithm to distribute the load.
Returns [number, WorkerNode<ThreadWorkerWithMessageChannel, Data>]
[worker node key, worker node].
+Returns number
The worker node key
Inherited from AbstractPool.chooseWorkerNode
-- Defined in src/pools/abstract-pool.ts:460
Protected
create@@ -357,7 +359,7 @@ Can be overridden.
Inherited from AbstractPool.createAndSetupWorker
-- Defined in src/pools/abstract-pool.ts:523
Protected
create@@ -368,7 +370,7 @@ Can be overridden.
Returns ThreadWorkerWithMessageChannel
Overrides AbstractPool.createWorker
-- Defined in src/pools/thread/fixed.ts:78
destroy
@@ -379,7 +381,7 @@ Can be overridden.
Returns Promise<void>
Inherited from AbstractPool.destroy
-- Defined in src/pools/abstract-pool.ts:375
Protected
destroy@@ -397,7 +399,7 @@ Can be overridden.
Returns Promise<void>
Overrides AbstractPool.destroyWorker
-- Defined in src/pools/thread/fixed.ts:54
enable Tasks Queue
@@ -419,7 +421,7 @@ Can be overridden.
Returns void
Inherited from AbstractPool.enableTasksQueue
-- Defined in src/pools/abstract-pool.ts:289
execute
@@ -442,7 +444,7 @@ Can be overridden.
Inherited from AbstractPool.execute
-- Defined in src/pools/abstract-pool.ts:342
Protected
internal@@ -451,7 +453,7 @@ Can be overridden.
Returns boolean
Inherited from AbstractPool.internalBusy
-- Defined in src/pools/abstract-pool.ts:333
Protected
is@@ -462,7 +464,7 @@ Can be overridden.
Returns boolean
Overrides AbstractPool.isMain
-- Defined in src/pools/thread/fixed.ts:49
Protected
register@@ -500,7 +502,7 @@ Can be overridden.
Returns void
Overrides AbstractPool.registerWorkerMessageListener
-- Defined in src/pools/thread/fixed.ts:70
Protected
send@@ -522,7 +524,7 @@ Can be overridden.
Returns void
Overrides AbstractPool.sendToWorker
-- Defined in src/pools/thread/fixed.ts:62
set Tasks Queue Options
@@ -540,7 +542,7 @@ Can be overridden.
Returns void
Inherited from AbstractPool.setTasksQueueOptions
-- Defined in src/pools/abstract-pool.ts:301
set Worker Choice Strategy
@@ -552,7 +554,7 @@ Can be overridden.-
-
-
@@ -562,7 +564,7 @@ Can be overridden.
Parameters
workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
+workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
The worker choice strategy.
Returns void
Inherited from AbstractPool.setWorkerChoiceStrategy
-- Defined in src/pools/abstract-pool.ts:252
set Worker Choice Strategy Options
@@ -580,7 +582,7 @@ Can be overridden.
Returns void
Inherited from AbstractPool.setWorkerChoiceStrategyOptions
-- Defined in src/pools/abstract-pool.ts:278
Protected
setup@@ -592,7 +594,7 @@ Can be overridden
Returns void
Inherited from AbstractPool.setupHook
-- Defined in src/pools/abstract-pool.ts:397
Protected
worker@@ -618,7 +620,7 @@ Can be overridden
Inherited from AbstractPool.workerListener
-- Defined in src/pools/abstract-pool.ts:546
Generated using TypeDoc