X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedClusterPool.html;h=f4d30b5b8789b1620e454f5dc2c9fa2007dfec3a;hb=36df5bd40369d98d6ccb60400e66dce1aa980d54;hp=3f1be4eb31f209e8ecb7808737304bd17fbfe76f;hpb=6d59ea2c71b8a88d41498c6fb54dfad95fd3a3ac;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index 3f1be4eb..f4d30b5b 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,14 +72,17 @@ 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 +156,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 +243,7 @@
info
@@ -253,7 +255,7 @@
Protected
max@@ -265,7 +267,7 @@
Protected
min@@ -277,7 +279,16 @@
+Private
ready+- get ready(): boolean
+-
+
Returns boolean
Protected
type@@ -290,7 +301,20 @@
+Private
utilization+- get utilization(): number
+-
+
+
Gets the approximate pool utilization.
+Returns number
The pool utilization.
+ +Protected
worker@@ -302,7 +326,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:1020
Task Execution Hook
+- Defined in src/pools/abstract-pool.ts:691
+
+
And Setup Dynamic Worker
+- Defined in src/pools/abstract-pool.ts:972
And Setup Worker
+- Defined in src/pools/abstract-pool.ts:933
Worker
+- Defined in src/pools/cluster/fixed.ts:77
- destroy(): Promise<void>
-
-
- Defined in src/pools/abstract-pool.ts:646
Worker
+- Defined in src/pools/cluster/fixed.ts:63
+- Defined in src/pools/abstract-pool.ts:551
@@ -590,7 +589,7 @@ Can be overridden.
+- Defined in src/pools/cluster/fixed.ts:72
+- Defined in src/pools/abstract-pool.ts:563
+- Defined in src/pools/abstract-pool.ts:521
+- Defined in src/pools/abstract-pool.ts:540
Hook
- setup
Hook(): void
-
-
- Defined in src/pools/cluster/fixed.ts:53
Listener
+
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 +373,9 @@ Can be overridden.Returns void
+Protected
before@@ -377,7 +401,23 @@ Can be overridden.
Dynamic Pool Size
+Protected
check+- check
Dynamic Pool Size(min, max): void
+-
+
+
+
Parameters
++-
+
+-
+
min: number
max: number
Returns void
Protected
create@@ -390,7 +430,7 @@ Can be overridden.
Protected
create@@ -403,7 +443,7 @@ Can be overridden.
Protected
create@@ -416,19 +456,19 @@ Can be overridden.
destroy
Terminate every current worker in this pool.
+Terminates every current worker in this pool.
Returns Promise<void>
+Protected
destroy@@ -448,7 +488,7 @@ Can be overridden.
enable Tasks Queue
@@ -473,7 +513,7 @@ Can be overridden.
execute
@@ -486,7 +526,7 @@ Can be overridden.-
-
@@ -499,7 +539,7 @@ Can be overridden.
+- Defined in src/pools/abstract-pool.ts:611
Busy
+- Defined in src/pools/abstract-pool.ts:602
Main
-
-
+- Defined in src/pools/cluster/fixed.ts:58
To Worker
-
-
-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
internal@@ -512,7 +552,7 @@ Can be overridden.
Protected
is@@ -524,48 +564,7 @@ Can be overridden.
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: Worker
-The worker which should register a listener.
-listener: ((message) => void)
-The message listener callback.
---
-
-- (message): void
--
-
-
-
Parameters
---
-
message: MessageValue<Message, unknown, Worker | MessagePort>
Returns void
Returns void
-Protected
send@@ -582,7 +581,7 @@ Can be overridden.
message: MessageValue<Data, unknown, Worker | MessagePort>
+message: MessageValue<Data, unknown>
The message.
set Tasks Queue Options
@@ -610,7 +609,7 @@ Can be overridden.
set Worker Choice Strategy
@@ -635,7 +634,7 @@ Can be overridden.
set Worker Choice Strategy Options
@@ -655,20 +654,20 @@ Can be overridden.
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
+Protected
worker@@ -689,14 +688,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.