X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FFixedThreadPool.html;h=5692b8d6161266d01e2f1ba2976630bfa329fa59;hb=20ebfb03d96dc805e59643cf1f90667545a3fef2;hp=a1fecefd0d80aef3fcc6686da10fdc2d0c0537c6;hpb=fddf9cc424b3ace38fd414899c666c76a03c3aff;p=poolifier.git
diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html
index a1fecefd..5692b8d6 100644
--- a/docs/classes/FixedThreadPool.html
+++ b/docs/classes/FixedThreadPool.html
@@ -17,8 +17,6 @@
Class FixedThreadPool<Data, Response>
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 @@-
-
+- Defined in src/pools/thread/fixed.ts:37
after
-
-
+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
@@ -74,15 +72,17 @@ info max
Methods
opts: PoolOptions<ThreadWorkerWithMessageChannel> = {}
+opts: ThreadPoolOptions = {}
Options for this fixed thread pool.
Properties
ProtectedReadonlyfileProtectedReadonlynumber
-ProtectedReadonlyoptsOptions for the pool.
+Options for this fixed thread pool.
-ProtectedpromiseThe execution response promise map.
key: The message id of each submitted task.
-ProtectedworkerWorker choice strategy context referencing a worker choice algorithm implementation.
-Default to a round robin algorithm.
-ReadonlyworkerPool worker nodes.
Accessors
Protectedfull@@ -243,7 +241,7 @@
info
@@ -255,7 +253,7 @@
Protectedmax@@ -267,7 +265,7 @@
Protectedmin@@ -279,7 +277,20 @@
+Privaterun+- get runTime(): number
+-
+
Gets the pool run time.
+Returns number
The pool run time in milliseconds.
+ +Protectedtype@@ -292,7 +303,20 @@
+Privateutilization+- get utilization(): number
+-
+
Gets the approximate pool utilization.
+Returns number
The pool utilization.
+ +Protectedworker@@ -304,7 +328,7 @@
Methods
Parameters
worker: ThreadWorkerWithMessageChannel
+worker: Worker
The worker.
message: MessageValue<Response, Worker | MessagePort>
+message: MessageValue<Response, unknown>
The received message.
-Protectedafter+- after
-
-
-
-
- Defined in src/pools/abstract-pool.ts:764
-
-- Defined in src/pools/abstract-pool.ts:556
+
+
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
+maxListenersor binding themain-worker<->workerconnection 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
+Protectedbefore-- before
+- before
-
-
+
Hook executed before the worker task execution. Can be overridden.
@@ -369,75 +393,80 @@ Can be overridden.workerNodeKey: number
The worker node key.
task: Task<Data>
+The task to execute.
+Returns void
+ProtectedchooseProtectedcreate-- choose
+- create
-
-
- Defined in src/pools/abstract-pool.ts:834
+- Defined in src/pools/abstract-pool.ts:774
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.
+Protectedcreate-- create
+- create
-
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.
Protectedcreate-- create
+- create
-
-
- Defined in src/pools/thread/fixed.ts:73
- destroy(): Promise<void>
-
-
- Defined in src/pools/abstract-pool.ts:511
- destroy
-
-
-
-
@@ -445,7 +474,7 @@ Can be overridden.
+- Defined in src/pools/thread/fixed.ts:62
+- Defined in src/pools/abstract-pool.ts:417
+- Defined in src/pools/thread/fixed.ts:68
+- Defined in src/pools/abstract-pool.ts:429
+- Defined in src/pools/abstract-pool.ts:384
+- Defined in src/pools/abstract-pool.ts:406
- setup
-
-
- Defined in src/pools/abstract-pool.ts:540
- Defined in src/pools/abstract-pool.ts:859
@@ -722,12 +714,14 @@ Can be overridden
- info
- max
- min
+- run
- type
+- utilization
- worker
- after
-- after
+- after
- before
-- choose
+- create
- create
- create
- destroy
@@ -736,7 +730,6 @@ Can be overridden
- execute
- internal
- is
-- register
- send
- set
- set
@@ -759,40 +752,52 @@ Can be overridden
- Thread
- Worker
- Cluster
+- Event
- IPool
- IWorker
- IWorker
+- Measurement
+- Measurement
+- Measurement
- Message
- Pool
- Pool
- Promise
+- Strategy
- Task
+- Task
+- Task
- Task
+- Task
- Tasks
-- Tasks
+- Thread
- Worker
+- Worker
- Worker
- Worker
-- Draft
-- Error
+- Worker
+- Worker
+- Error
- Exit
- Kill
+- Measurement
- Message
- Online
- Pool
- Pool
- Task
-- Thread
- Worker
- Worker
- Worker
- Worker
- Worker
- Kill
+- Measurements
- Pool
- Pool
- Worker
-- Worker
+ - Worker
+- available
Returns a newly created worker.
+Creates a new worker.
Returns ThreadWorkerWithMessageChannel
+Returns Worker
Newly created worker.
+ +destroy
Shutdowns every current worker in this pool.
+Terminates every current worker in this pool.
Returns Promise<void>
+ProtecteddestroyShutdowns the given worker.
+Terminates the given worker.
Parameters
worker: ThreadWorkerWithMessageChannel
+worker: Worker
A worker within
workerNodes.enable
@@ -470,7 +499,7 @@ Can be overridden.
execute
@@ -483,7 +512,7 @@ Can be overridden.-
-
@@ -496,16 +525,20 @@ Can be overridden.
+- Defined in src/pools/abstract-pool.ts:477
- internal
-
-
+- Defined in src/pools/abstract-pool.ts:468
-
-
+- Defined in src/pools/thread/fixed.ts:57
-Optionaldata: 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.
ProtectedinternalReturns boolean
Protectedis@@ -517,48 +550,7 @@ Can be overridden.
-Protectedregister-- register
--
-
-
-
-
-
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
-Protectedsend@@ -570,12 +562,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.
set
@@ -603,7 +595,7 @@ Can be overridden.
set
@@ -615,7 +607,7 @@ Can be overridden.-
-
@@ -628,7 +620,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.
set
@@ -648,20 +640,20 @@ Can be overridden.
ProtectedsetupSetup 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
+Protectedworker@@ -682,14 +674,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.
Generated using TypeDoc