X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedClusterPool.html;h=b00d1c78b4e76effc3ad44b4415be91947e3444d;hb=2a6631992868d900762f62e4c228dce4e4ee549a;hp=ed3678d2fd17d971d75f6404b727a3381cc732e9;hpb=15d6dfaf877ec6a99e2bde48cb3c8a9e8671c075;p=poolifier.git
diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html
index ed3678d2..b00d1c78 100644
--- a/docs/classes/FixedClusterPool.html
+++ b/docs/classes/FixedClusterPool.html
@@ -17,8 +17,6 @@
Class FixedClusterPool<Data, Response>
A cluster pool with a fixed number of workers.
-It is possible to perform tasks in sync or asynchronous mode as you prefer.
-This pool selects the workers in a round robin fashion.
Author
Christopher Quadflieg
@@ -30,12 +28,12 @@-
-
@@ -47,7 +45,7 @@
- DynamicClusterPool
+- Defined in src/pools/cluster/fixed.ts:38
after- Defined in src/pools/cluster/fixed.ts:49
@@ -155,7 +154,7 @@
+- Defined in src/pools/abstract-pool.ts:58
file
@@ -164,7 +163,7 @@
+- Defined in src/pools/abstract-pool.ts:96
number
@@ -173,7 +172,7 @@
+- Defined in src/pools/abstract-pool.ts:95
opts: ClusterPoolOptions = {}
@@ -182,7 +181,7 @@
+- Defined in src/pools/cluster/fixed.ts:52
promise
@@ -196,17 +195,16 @@
+- Defined in src/pools/abstract-pool.ts:68
worker
+- Defined in src/pools/abstract-pool.ts:76
worker
@@ -215,7 +213,7 @@
+- Defined in src/pools/abstract-pool.ts:55
@@ -230,7 +228,7 @@
+- Defined in src/pools/cluster/fixed.ts:107
+- Defined in src/pools/abstract-pool.ts:441
+- Defined in src/pools/abstract-pool.ts:250
+- Defined in src/pools/cluster/fixed.ts:102
+- Defined in src/pools/cluster/fixed.ts:97
+
+
+- Defined in src/pools/cluster/fixed.ts:87
+
+
+- Defined in src/pools/cluster/fixed.ts:92
@@ -324,7 +348,7 @@ Can be overridden.
-
-
-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.
@@ -74,15 +72,17 @@ info max
Methods
Properties
ProtectedReadonlyfileProtectedReadonlynumberProtectedReadonlyoptsProtectedpromiseProtectedworkerWorker choice strategy context referencing a worker choice algorithm implementation.
-Default to a round robin algorithm.
ReadonlyworkerAccessors
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
message: MessageValue<Response, Worker | MessagePort>
+message: MessageValue<Response, unknown>
The received message.
-Protectedafter+- after
-
-
- Defined in src/pools/abstract-pool.ts:747
-
-- Defined in src/pools/abstract-pool.ts:539
+
+
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
@@ -351,13 +375,13 @@ Can be overridden.Returns void
+Protectedbefore-- before
+- before
-
-
+
Hook executed before the worker task execution. Can be overridden.
@@ -369,26 +393,30 @@ 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:790
+- Defined in src/pools/abstract-pool.ts:757
- create
-
-
- Defined in src/pools/cluster/fixed.ts:82
- destroy(): Promise<void>
-
-
- Defined in src/pools/abstract-pool.ts:500
- destroy
-
-
- Defined in src/pools/cluster/fixed.ts:68
+- Defined in src/pools/abstract-pool.ts:406
@@ -583,7 +575,7 @@ Can be overridden.
+- Defined in src/pools/cluster/fixed.ts:77
+- Defined in src/pools/abstract-pool.ts:418
+- Defined in src/pools/abstract-pool.ts:373
+- Defined in src/pools/abstract-pool.ts:395
- setup
-
-
- Defined in src/pools/cluster/fixed.ts:58
- Defined in src/pools/abstract-pool.ts:815
@@ -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
-- Required
+- 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
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@@ -401,37 +429,38 @@ Can be overridden.
ProtectedcreateReturns a newly created worker.
+Creates a new worker.
Returns Worker
+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
@@ -445,7 +474,7 @@ Can be overridden. +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:466
- internal
-
-
+- Defined in src/pools/abstract-pool.ts:457
-
-
+- Defined in src/pools/cluster/fixed.ts:63
-
-
-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: Worker
-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@@ -575,7 +567,7 @@ Can be overridden.
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