X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedClusterPool.html;h=7a09afa0faab302eec9e2721794724bd6598faaa;hb=e4147fed0610be12b92f976ed274ae4737f785b5;hp=82abc2bc5a7c50a2464e6db1bd0ae67a7d364f38;hpb=a47027a0bf90ce21b528708dadd0eb23b5537b43;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index 82abc2bc..7a09afa0 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -1,4 +1,4 @@ -
Emitter on which events can be listened to.
Events that can currently be listened to:
-
+
+- '
@@ -160,7 +163,7 @@ +'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.'full'
: Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.destroy
': Emitted when the pool is destroyed.'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
workerReadonly
workerAccessors
Protected
full@@ -247,7 +250,7 @@
info
@@ -259,7 +262,7 @@
Protected
max@@ -271,7 +274,7 @@
Protected
min@@ -283,7 +286,7 @@
Private
ready@@ -295,7 +298,7 @@
Protected
type@@ -308,7 +311,7 @@
Private
utilization@@ -321,7 +324,7 @@
Protected
worker@@ -333,7 +336,7 @@
Methods
Protected
after@@ -382,7 +385,7 @@ Can be overridden.
Protected
before@@ -408,7 +411,7 @@ Can be overridden.
Protected
check@@ -424,7 +427,7 @@ Can be overridden.
Returns void
Protected
create@@ -437,7 +440,7 @@ Can be overridden.
Protected
create@@ -450,7 +453,7 @@ Can be overridden.
Protected
create@@ -463,7 +466,7 @@ Can be overridden.
destroy
@@ -475,7 +478,7 @@ Can be overridden.
Protected
destroy@@ -495,7 +498,7 @@ Can be overridden.
enable Tasks Queue
@@ -520,11 +523,11 @@ Can be overridden.
execute
-- execute(data?, name?): Promise<Response>
+- execute(data?, name?, transferList?): Promise<Response>
-
@@ -533,12 +536,17 @@ Can be overridden.
-
-
+
+-
+
+- Defined in src/pools/abstract-pool.ts:661
Tasks Queue
+- Defined in src/pools/abstract-pool.ts:1246
Worker Info
+- Defined in src/pools/abstract-pool.ts:1185
Busy
- internal
Busy(): boolean
-
-
- Defined in src/pools/abstract-pool.ts:631
Main
+- Defined in src/pools/cluster/fixed.ts:58
+
+
Worker Message Listener
+- Defined in src/pools/cluster/fixed.ts:97
+
+
Startup Message To Worker
+- Defined in src/pools/cluster/fixed.ts:89
To Worker
+- Defined in src/pools/cluster/fixed.ts:81
+- Defined in src/pools/abstract-pool.ts:592
+- Defined in src/pools/abstract-pool.ts:550
+- Defined in src/pools/abstract-pool.ts:569
Hook
+- Defined in src/pools/cluster/fixed.ts:53
Listener
+ - Defined in src/pools/abstract-pool.ts:1111
@@ -850,7 +887,9 @@ Can be overridden.
- get
Worker Info
- internal
Busy
- is
Main
+- list
Task Functions
- register
Worker Message Listener
+- send
Kill Message To Worker
- send
Startup Message To Worker
- send
To Worker
- set
Tasks Queue Options
@@ -859,7 +898,7 @@ Can be overridden.
- setup
Hook
- worker
Listener
-
Executes the specified function in the worker constructor with the task data input parameter.
-Optional
data: DataThe task input data for the specified task function. This can only be structured-cloneable data.
+The optional task input data for the specified task function. This can only be structured-cloneable data.
-Optional
name: stringThe name of the task function to execute. If not specified, the default task function will be executed.
+The optional name of the task function to execute. If not specified, the default task function will be executed.
+
+Optional
transferList: TransferListItem[]An optional array of transferable objects to transfer ownership of. Ownership of the transferred objects is given to the pool's worker_threads worker and they should not be used in the main thread afterwards.
Returns Promise<Response>
Promise that will be fulfilled when the task is completed.
@@ -546,7 +554,7 @@ Can be overridden.Protected
flush@@ -560,7 +568,7 @@ Can be overridden.
Returns void
Protected
get@@ -581,20 +589,20 @@ Can be overridden.
Protected
internalWhether worker nodes are executing at least one task.
+Whether worker nodes are executing concurrently their tasks quota or not.
Returns boolean
Worker nodes busyness boolean status.
+Protected
is@@ -606,7 +614,20 @@ Can be overridden.
list Task Functions
++- list
Task Functions(): string[]
+-
+
+
Lists the names of task function available in this pool.
+Returns string[]
The names of task function available in this pool.
+ +Protected
register@@ -647,7 +668,23 @@ Can be overridden.
Kill Message To Worker
+Protected
send+- send
Kill Message To Worker(workerNodeKey, workerId): Promise<void>
+-
+
+
+
Parameters
++-
+
+-
+
workerNodeKey: number
workerId: number
Returns Promise<void>
Protected
send@@ -667,7 +704,7 @@ Can be overridden.
Protected
send@@ -692,7 +729,7 @@ Can be overridden.
set Tasks Queue Options
@@ -712,7 +749,7 @@ Can be overridden.
set Worker Choice Strategy
@@ -737,7 +774,7 @@ Can be overridden.
set Worker Choice Strategy Options
@@ -757,7 +794,7 @@ Can be overridden.
Protected
setup@@ -770,7 +807,7 @@ Can be overridden.
Protected
worker@@ -798,7 +835,7 @@ Can be overridden.