X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedClusterPool.html;h=15f01272545e185515b0038899441c4f564cdfe6;hb=76b46937556ea55049d5c413aa0a77d0c7f47f48;hp=bad5c3ca4d6a07e3cc5d1ec139e84d24827952d9;hpb=aac8863d208eadcb0ecb33dc44d045c26f5a444f;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index bad5c3ca..15f01272 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -1,4 +1,4 @@ -
Generated using TypeDoc
A cluster pool with a fixed number of workers.
-It is possible to perform tasks in sync or asynchronous mode as you prefer.
Author
Christopher Quadflieg
@@ -29,12 +28,12 @@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.
@@ -73,24 +72,30 @@ info max Size
min Size
+ready
type
+utilization
worker
Methods
Properties
Emitter on which events can be listened to.
Events that can currently be listened to:
-
-
+
+
+
@@ -154,7 +160,7 @@ +'full'
: Emitted when the pool is dynamic and full.'busy'
: Emitted when the pool is busy.'full'
: Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.'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.'error'
: Emitted when an uncaught error occurs.'taskError'
: Emitted when an error occurs while executing a task.Protected
Readonly
fileProtected
Readonly
numberProtected
Readonly
optsProtected
promiseProtected
worker Nodes
-Readonly
workerPool worker nodes.
Accessors
Protected
full@@ -241,7 +247,7 @@
info
@@ -253,7 +259,7 @@
Protected
max@@ -265,7 +271,7 @@
Protected
min@@ -277,7 +283,16 @@
+Private
ready+- get ready(): boolean
+-
+
Returns boolean
Protected
type@@ -290,7 +305,20 @@
+Private
utilization+- get utilization(): number
+-
+
+
Gets the approximate pool utilization.
+Returns number
The pool utilization.
+ +Protected
worker@@ -302,7 +330,7 @@
Methods
message: MessageValue<Response, unknown, 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:941
Task Execution Hook
-
-- Defined in src/pools/abstract-pool.ts:696
+
+ Dynamic Pool Size
+ - Defined in src/pools/abstract-pool.ts:992
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
@@ -349,9 +377,9 @@ Can be overridden.Returns void
+Protected
before@@ -377,21 +405,36 @@ Can be overridden.
Worker Node
+Protected
chooseProtected
check-- choose
Worker Node(): number
+- check
Dynamic Pool Size(min, max): void
-
-
+
+
+
+- Defined in src/pools/abstract-pool.ts:896
And Setup Worker
+- Defined in src/pools/abstract-pool.ts:856
Worker
- create
Worker(): Worker
-
-
-- Defined in src/pools/cluster/fixed.ts:93
- destroy(): Promise<void>
-
-
- Defined in src/pools/abstract-pool.ts:651
Worker
- destroy
Worker(worker): void
-
-
- Defined in src/pools/cluster/fixed.ts:63
+- Defined in src/pools/abstract-pool.ts:556
+- Defined in src/pools/cluster/fixed.ts:85
+
+
To Worker
-
-
@@ -586,7 +698,7 @@ Can be overridden.
+- Defined in src/pools/cluster/fixed.ts:72
+- Defined in src/pools/abstract-pool.ts:568
+- Defined in src/pools/abstract-pool.ts:526
+- Defined in src/pools/abstract-pool.ts:545
Hook
- setup
Hook(): void
-
-
+- Defined in src/pools/cluster/fixed.ts:53
Listener
+
Chooses a worker node for the next task.
-The default worker choice strategy uses a round robin algorithm to distribute the load.
+Parameters
++-
+
+-
+
min: number
max: number
Returns void
+ And Setup Dynamic Worker
+Protected
create+- create
And Setup Dynamic Worker(): Worker
+-
+
-
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@@ -404,37 +447,38 @@ Can be overridden.
Protected
createReturns 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>
+Protected
destroyShutdowns the given worker.
+Terminates the given worker.
Parameters
@@ -448,7 +492,7 @@ Can be overridden. +enable Tasks Queue
@@ -473,7 +517,7 @@ Can be overridden.
execute
@@ -486,7 +530,7 @@ Can be overridden.-
-
@@ -499,16 +543,64 @@ Can be overridden.
+- Defined in src/pools/abstract-pool.ts:616
+
+
+
+
Busy
- internal
Busy(): boolean
-
-
+- Defined in src/pools/abstract-pool.ts:607
Main
+- Defined in src/pools/cluster/fixed.ts:58
Worker Message Listener
+
-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.
Worker Info By Worker
+Protected
get+- get
Worker Info By Worker(worker): WorkerInfo
+-
+
+
+
+
+
Gets the worker information from the given worker.
+Parameters
++-
+
+
worker: Worker
+The worker.
+Returns WorkerInfo
The worker information.
+ +Throws
https://nodejs.org/api/errors.html#class-error If the worker is not found.
+ Worker Node Key
+Protected
get+- get
Worker Node Key(worker): number
+-
+
+
+
+
Gets the given worker its worker node key.
+Parameters
++-
+
+
worker: Worker
+The worker.
+Returns number
The worker node key if found in the pool worker nodes,
+ +-1
otherwise.Protected
internalReturns boolean
Protected
is@@ -520,7 +612,7 @@ Can be overridden.
Overrides AbstractPool.isMain
-- Defined in src/pools/cluster/fixed.ts:65
Protected
register@@ -555,13 +647,33 @@ Can be overridden.-
-
Parameters
message: MessageValue<Message, unknown, Worker | MessagePort>
message: MessageValue<Message, unknown>
Returns void
Returns void
Overrides AbstractPool.registerWorkerMessageListener
-- Defined in src/pools/cluster/fixed.ts:81
Startup Message To Worker
+Protected
send+- send
Startup Message To Worker(worker): void
+-
+
+
+
+
+
Sends the startup message to the given worker.
+Parameters
++-
+
+
worker: Worker
+The worker which should receive the startup message.
+Returns void
+Overrides AbstractPool.sendStartupMessageToWorker
++- Defined in src/pools/cluster/fixed.ts:77
Protected
send@@ -578,7 +690,7 @@ Can be overridden.
message: MessageValue<Data, unknown, Worker | MessagePort>
+message: MessageValue<Data, unknown>
The message.
Overrides AbstractPool.sendToWorker
-- Defined in src/pools/cluster/fixed.ts:76
set Tasks Queue Options
@@ -606,7 +718,7 @@ Can be overridden.
Inherited from AbstractPool.setTasksQueueOptions
-- Defined in src/pools/abstract-pool.ts:348
set Worker Choice Strategy
@@ -631,7 +743,7 @@ Can be overridden.
Inherited from AbstractPool.setWorkerChoiceStrategy
-- Defined in src/pools/abstract-pool.ts:303
set Worker Choice Strategy Options
@@ -651,20 +763,20 @@ Can be overridden.
Inherited from AbstractPool.setWorkerChoiceStrategyOptions
-- Defined in src/pools/abstract-pool.ts:325
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
Overrides AbstractPool.setupHook
-- Defined in src/pools/cluster/fixed.ts:60
Protected
worker@@ -685,14 +797,14 @@ Can be overridden-
-
Parameters
message: MessageValue<Response, unknown, 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:716