X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FFixedThreadPool.html;h=75f41dbfacfc286e76e82cd0faf227fc2fa63e22;hb=a6d9dccfaf39e185c896747260d668fcb683a8ed;hp=5d0045b7e211049cc1e627a05a865acbb21a923a;hpb=4f487526a63c873d168386250b40ad8103c5a4d8;p=poolifier.git diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index 5d0045b7..75f41dbf 100644 --- a/docs/classes/FixedThreadPool.html +++ b/docs/classes/FixedThreadPool.html @@ -17,8 +17,6 @@
A thread pool with a fixed number of threads.
-It is possible to perform tasks in sync or asynchronous mode as you prefer.
-This pool selects the threads in a round robin fashion.
Author
Alessandro Pio Ardizio
@@ -30,24 +28,24 @@Data = unknown
-Type of data sent to the worker. This can only be serializable data.
+Type of data sent to the worker. This can only be structured-cloneable data.
Response = unknown
-Type of execution response. This can only be serializable data.
+Type of execution response. This can only be structured-cloneable data.
Hierarchy
-- AbstractPool<ThreadWorkerWithMessageChannel, Data, Response>
+
- AbstractPool<Worker, Data, Response>
- FixedThreadPool
- DynamicThreadPool
@@ -80,9 +78,9 @@
after Task Execution Hook
-after Worker Setup
+after Worker Setup
before Task Execution Hook
-choose Worker Node
+create And Setup Dynamic Worker
create And Setup Worker
create Worker
destroy
@@ -91,7 +89,6 @@
execute
internal Busy
is Main
-register Worker Message Listener
send To Worker
set Tasks Queue Options
set Worker Choice Strategy
@@ -137,7 +134,7 @@
+- Defined in src/pools/thread/fixed.ts:48
@@ -155,7 +152,7 @@
+- Defined in src/pools/abstract-pool.ts:55
Path
file Path: string
@@ -164,7 +161,7 @@
+- Defined in src/pools/abstract-pool.ts:88
Of Workers
number Of Workers: number
@@ -173,7 +170,7 @@
+- Defined in src/pools/abstract-pool.ts:87
opts: ThreadPoolOptions = {}
@@ -182,10 +179,10 @@
+- Defined in src/pools/thread/fixed.ts:51
promise Response Map: Map<string, PromiseResponseWrapper<ThreadWorkerWithMessageChannel, Response>> = ...
+promise Response Map: Map<string, PromiseResponseWrapper<Worker, Response>> = ...
@@ -196,26 +193,25 @@
+- Defined in src/pools/abstract-pool.ts:65
worker Choice Strategy Context: WorkerChoiceStrategyContext<ThreadWorkerWithMessageChannel, Data, Response>
+worker Choice Strategy Context: WorkerChoiceStrategyContext<Worker, Data, Response>
+- Defined in src/pools/abstract-pool.ts:73
worker Nodes: WorkerNode<ThreadWorkerWithMessageChannel, Data>[] = []
+worker Nodes: WorkerNode<Worker, Data>[] = []
+- Defined in src/pools/abstract-pool.ts:52
@@ -230,7 +226,7 @@
+- Defined in src/pools/thread/fixed.ts:101
+- Defined in src/pools/abstract-pool.ts:392
+- Defined in src/pools/abstract-pool.ts:240
Size
+- Defined in src/pools/thread/fixed.ts:96
Size
+- Defined in src/pools/thread/fixed.ts:91
+- Defined in src/pools/thread/fixed.ts:81
+- Defined in src/pools/thread/fixed.ts:86
@@ -319,12 +315,12 @@ Can be overridden.
-
-
-
-
@@ -332,32 +328,32 @@ Can be overridden.
-
+- Defined in src/pools/abstract-pool.ts:506
+
Methods
Properties
Protected
Readonly
fileProtected
Readonly
numberProtected
Readonly
opts Response Map
-Protected
promiseThe execution response promise map.
key
: The message id of each submitted task. Choice Strategy Context
-Protected
workerWorker choice strategy context referencing a worker choice algorithm implementation.
-Default to a round robin algorithm.
Nodes
-Readonly
workerPool worker nodes.
Accessors
Protected
full@@ -243,7 +239,7 @@
info
@@ -255,7 +251,7 @@
Protected
max@@ -267,7 +263,7 @@
Protected
min@@ -279,7 +275,7 @@
Protected
type@@ -292,7 +288,7 @@
Protected
worker@@ -304,7 +300,7 @@
Methods
Parameters
worker: ThreadWorkerWithMessageChannel
+worker: Worker
The worker.
message: MessageValue<Response, Worker | MessagePort>
+message: MessageValue<Response, unknown>
The received message.
Worker Setup
-Protected
after+- after
Worker Setup(worker): void
-
-
-
-
- Defined in src/pools/abstract-pool.ts:699
Task Execution Hook
-
-- Defined in src/pools/abstract-pool.ts:490
+
+ And Setup Dynamic Worker
Function that can be hooked up when a worker has been newly created and moved to the pool worker nodes.
-Can be used to update the
+maxListeners
or binding themain-worker
<->worker
connection if not bind by default.Function that can be hooked up when a worker has been newly created and moved to the pool worker nodes. +Can be overridden.
Parameters
worker: ThreadWorkerWithMessageChannel
+worker: Worker
The newly created worker.
Returns void
+Protected
before-- before
Task Execution Hook(workerNodeKey): void
+- before
Task Execution Hook(workerNodeKey, task): void
-
+
+-
+
Hook executed before the worker task execution. Can be overridden.
@@ -369,75 +365,80 @@ Can be overridden.workerNodeKey: number
The worker node key.
task: Task<Data>
+The task to execute.
+Returns void
Worker Node
+Protected
chooseProtected
create-- choose
Worker Node(): number
+- create
And Setup Dynamic Worker(): Worker
-
-
-- Defined in src/pools/abstract-pool.ts:742
And Setup Worker
+- Defined in src/pools/abstract-pool.ts:709
Worker
Chooses a worker node for the next task.
-The default worker choice strategy uses a round robin algorithm to distribute the load.
+Creates a new dynamic worker and sets it up completely in the pool worker nodes.
Returns number
The worker node key
+Returns Worker
New, completely set up dynamic worker.
+Protected
create-- create
And Setup Worker(): ThreadWorkerWithMessageChannel
+- create
And Setup Worker(): Worker
-
-
Creates a new worker and sets it up completely in the pool worker nodes.
Returns ThreadWorkerWithMessageChannel
New, completely set up worker.
+Returns Worker
New, completely set up worker.
Protected
create-- create
Worker(): ThreadWorkerWithMessageChannel
+- create
Worker(): Worker
-
-
-- Defined in src/pools/thread/fixed.ts:73
- destroy(): Promise<void>
-
-
- Defined in src/pools/abstract-pool.ts:451
Worker
- destroy
Worker(worker): Promise<void>
-
-
-
-
@@ -445,7 +446,7 @@ Can be overridden.
+- Defined in src/pools/thread/fixed.ts:62
+- Defined in src/pools/abstract-pool.ts:357
+- Defined in src/pools/thread/fixed.ts:68
+- Defined in src/pools/abstract-pool.ts:369
+- Defined in src/pools/abstract-pool.ts:324
+- Defined in src/pools/abstract-pool.ts:346
Hook
- setup
Hook(): void
-
-
+- Defined in src/pools/abstract-pool.ts:474
Listener
+
+ - Defined in src/pools/abstract-pool.ts:769
@@ -725,9 +689,9 @@ Can be overridden
- type
- worker
- after
Task Execution Hook
-- after
Worker Setup
+- after
Worker Setup
- before
Task Execution Hook
-- choose
Worker Node
+- create
And Setup Dynamic Worker
- create
And Setup Worker
- create
Worker
- destroy
@@ -736,7 +700,6 @@ Can be overridden
- execute
- internal
Busy
- is
Main
-- register
Worker Message Listener
- send
To Worker
- set
Tasks Queue Options
- set
Worker Choice Strategy
@@ -759,39 +722,46 @@ Can be overridden
- Thread
Worker
- Worker
Choice Strategy Context
- Cluster
Pool Options
+- Event
Loop Utilization Measurement Statistics
- IPool
- IWorker
- IWorker
Choice Strategy
+- Measurement
Options
+- Measurement
Statistics
+- Measurement
Statistics Requirements
- Message
Value
- Pool
Info
- Pool
Options
- Promise
Response Wrapper
+- Strategy
Policy
- Task
+- Task
Error
- Task
Performance
- Task
Statistics
+- Task
Statistics Requirements
- Tasks
Queue Options
-- Tasks
Usage
- Thread
Pool Options
- Worker
Choice Strategy Options
- Worker
Node
- Worker
Options
- Worker
Statistics
-- Draft
-- Error
Handler
+- Worker
Usage
+- Error
Handler
- Exit
Handler
- Kill
Behavior
+- Measurement
- Message
Handler
- Online
Handler
- Pool
Event
- Pool
Type
- Task
Functions
-- Thread
Worker With Message Channel
- Worker
Async Function
- Worker
Choice Strategy
- Worker
Function
- Worker
Sync Function
- Worker
Type
- Kill
Behaviors
+- Measurements
- Pool
Events
- Pool
Types
- Worker
Choice Strategies
Returns a newly created worker.
+Creates a new worker.
Returns ThreadWorkerWithMessageChannel
+Returns Worker
Newly created worker.
+ +destroy
Shutdowns every current worker in this pool.
+Terminate every current worker in this pool.
Returns Promise<void>
+Protected
destroyShutdowns the given worker.
+Terminates the given worker.
Parameters
worker: ThreadWorkerWithMessageChannel
+worker: Worker
A worker within
workerNodes
.enable Tasks Queue
@@ -470,7 +471,7 @@ Can be overridden.
execute
@@ -483,7 +484,7 @@ Can be overridden.-
-
@@ -496,16 +497,20 @@ Can be overridden.
+- Defined in src/pools/abstract-pool.ts:417
Busy
- internal
Busy(): boolean
-
-
+- Defined in src/pools/abstract-pool.ts:408
Main
-
-
+- Defined in src/pools/thread/fixed.ts:57
To Worker
@@ -583,7 +547,7 @@ Can be overridden.
-Optional
data: DataThe task input data for the specified worker function. This can only be serializable data.
+The task input data for the specified worker function. This can only be structured-cloneable data.
Protected
internalReturns boolean
Protected
is@@ -517,48 +522,7 @@ Can be overridden.
Overrides AbstractPool.isMain
-- Defined in src/pools/thread/fixed.ts:67
Worker Message Listener
-Protected
register-- register
Worker Message Listener<Message>(worker, listener): void
--
-
-
-
-
-
-
-
Registers a listener callback on the given worker.
-Type Parameters
---
-
Message
Parameters
---
-
-
--
-
-
-
worker: ThreadWorkerWithMessageChannel
-The worker which should register a listener.
-listener: ((message) => void)
-The message listener callback.
---
-
-- (message): void
--
-
-
-
Parameters
---
-
message: MessageValue<Message, Worker | MessagePort>
Returns void
Returns void
-Overrides AbstractPool.registerWorkerMessageListener
--- Defined in src/pools/thread/fixed.ts:88
Protected
send@@ -570,12 +534,12 @@ Can be overridden.-
-
-
-
Parameters
worker: ThreadWorkerWithMessageChannel
+worker: Worker
The worker which should receive the message.
message: MessageValue<Data, Worker | MessagePort>
+message: MessageValue<Data, unknown>
The message.
Overrides AbstractPool.sendToWorker
-- Defined in src/pools/thread/fixed.ts:80
set Tasks Queue Options
@@ -603,7 +567,7 @@ Can be overridden.
Inherited from AbstractPool.setTasksQueueOptions
-- Defined in src/pools/abstract-pool.ts:340
set Worker Choice Strategy
@@ -615,7 +579,7 @@ Can be overridden.-
-
@@ -628,7 +592,7 @@ Can be overridden.
Parameters
workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
+workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
The worker choice strategy.
Inherited from AbstractPool.setWorkerChoiceStrategy
-- Defined in src/pools/abstract-pool.ts:285
set Worker Choice Strategy Options
@@ -648,20 +612,20 @@ Can be overridden.
Inherited from AbstractPool.setWorkerChoiceStrategyOptions
-- Defined in src/pools/abstract-pool.ts:317
Protected
setupSetup hook to execute code before worker node are created in the abstract constructor. -Can be overridden
+Setup hook to execute code before worker nodes are created in the abstract constructor. +Can be overridden.
Returns void
Inherited from AbstractPool.setupHook
-- Defined in src/pools/abstract-pool.ts:441
Protected
worker@@ -682,14 +646,14 @@ Can be overridden-
-
Parameters
message: MessageValue<Response, Worker | MessagePort>
message: MessageValue<Response, unknown>
Returns void
The listener function to execute when a message is received from a worker.
Inherited from AbstractPool.workerListener
-- Defined in src/pools/abstract-pool.ts:653