DynamicClusterPool

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicClusterPool.html;h=56a8c10129ef4d388725b6564228823a09fa8ee8;hb=68da37cdc5b2d146b0f1b139092e6063dcdd16bb;hp=c220e4e5fa869366b3d1d485c1465920689a4da7;hpb=6d59ea2c71b8a88d41498c6fb54dfad95fd3a3ac;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index c220e4e5..56a8c101 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -1,4 +1,4 @@ -DynamicClusterPool | poolifier

+DynamicClusterPool | poolifier - v2.6.12

@@ -30,12 +30,12 @@ When the maximum number of workers is reached and workers are busy, an event is

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.

@@ -45,7 +45,7 @@ When the maximum number of workers is reached and workers are busy, an event is

DynamicClusterPool

Defined in src/pools/cluster/dynamic.ts:15

@@ -73,7 +73,10 @@ When the maximum number of workers is reached and workers are busy, an event is info maxSize minSize +ready +starting type +utilization worker

@@ -81,6 +84,7 @@ When the maximum number of workers is reached and workers are busy, an event is

afterTaskExecutionHook afterWorkerSetup beforeTaskExecutionHook +checkDynamicPoolSize createAndSetupDynamicWorker createAndSetupWorker createWorker @@ -90,7 +94,6 @@ When the maximum number of workers is reached and workers are busy, an event is execute internalBusy isMain -registerWorkerMessageListener sendToWorker setTasksQueueOptions setWorkerChoiceStrategy @@ -141,7 +144,7 @@ When the maximum number of workers is reached and workers are busy, an event is

Defined in src/pools/cluster/dynamic.ts:27

Properties

@@ -150,8 +153,9 @@ When the maximum number of workers is reached and workers are busy, an event is

Emitter on which events can be listened to.

Events that can currently be listened to:

'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.

@@ -159,7 +163,7 @@ When the maximum number of workers is reached and workers are busy, an event is

Defined in src/pools/abstract-pool.ts:58

`Protected` `Readonly` filePath

filePath: string

@@ -168,7 +172,7 @@ When the maximum number of workers is reached and workers are busy, an event is

Defined in src/pools/abstract-pool.ts:96

`Protected` `Readonly` max

max: number

@@ -176,7 +180,7 @@ When the maximum number of workers is reached and workers are busy, an event is

Defined in src/pools/cluster/dynamic.ts:29

`Protected` `Readonly` numberOfWorkers

numberOfWorkers: number

@@ -185,7 +189,7 @@ When the maximum number of workers is reached and workers are busy, an event is

Defined in src/pools/abstract-pool.ts:95

`Protected` `Readonly` opts

opts: ClusterPoolOptions = {}

@@ -194,7 +198,7 @@ When the maximum number of workers is reached and workers are busy, an event is

Defined in src/pools/cluster/fixed.ts:47

`Protected` promiseResponseMap

promiseResponseMap: Map<string, PromiseResponseWrapper<Worker, Response>> = ...

@@ -208,7 +212,7 @@ When the maximum number of workers is reached and workers are busy, an event is

Defined in src/pools/abstract-pool.ts:68

`Protected` workerChoiceStrategyContext

workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>

@@ -217,16 +221,16 @@ When the maximum number of workers is reached and workers are busy, an event is

Defined in src/pools/abstract-pool.ts:76

`Readonly` workerNodes

workerNodes: WorkerNode<Worker, Data>[] = []

workerNodes: IWorkerNode<Worker, Data>[] = []

Pool worker nodes.

Defined in src/pools/abstract-pool.ts:55

Accessors

@@ -241,7 +245,7 @@ When the maximum number of workers is reached and workers are busy, an event is

Defined in src/pools/cluster/dynamic.ts:48

`Private` ready

get ready(): boolean
+
Returns boolean
+
Inherited from FixedClusterPool.ready
+
- Defined in src/pools/abstract-pool.ts:412

`Private` starting

get starting(): boolean
+
Returns boolean
+
Inherited from FixedClusterPool.starting
+
- Defined in src/pools/abstract-pool.ts:404

`Protected` type

Defined in src/pools/cluster/dynamic.ts:38

`Private` utilization

get utilization(): number
+
Gets the approximate pool utilization.
+
+
Returns number
The pool utilization.
+ +
+
Inherited from FixedClusterPool.utilization
+
- Defined in src/pools/abstract-pool.ts:424

`Protected` worker

Defined in src/pools/cluster/fixed.ts:87

Methods

@@ -335,7 +370,7 @@ Can be overridden.

message: MessageValue<Response, unknown, Worker | MessagePort>

message: MessageValue<Response, unknown>

The received message.

@@ -343,14 +378,14 @@ Can be overridden.

Defined in src/pools/abstract-pool.ts:683

`Protected` afterWorkerSetup

afterWorkerSetup(worker): void
-
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 the main-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
@@ -364,7 +399,7 @@ Can be overridden.
Inherited from FixedClusterPool.afterWorkerSetup
- Defined in src/pools/cluster/fixed.ts:94

Defined in src/pools/abstract-pool.ts:911

`Protected` beforeTaskExecutionHook

Defined in src/pools/abstract-pool.ts:667

`Protected` checkDynamicPoolSize

checkDynamicPoolSize(min, max): void
+
+
Parameters
+
- +
  min: number
- +
  max: number
+
Returns void
+
Inherited from FixedClusterPool.checkDynamicPoolSize
+
- Defined in src/pools/abstract-pool.ts:160

`Protected` createAndSetupDynamicWorker

Defined in src/pools/abstract-pool.ts:994

`Protected` createAndSetupWorker

Defined in src/pools/abstract-pool.ts:928

`Protected` createWorker

Defined in src/pools/cluster/fixed.ts:77

destroy

destroy(): Promise<void>
-
Terminate every current worker in this pool.
+
Terminates every current worker in this pool.

Returns Promise<void>
Inherited from FixedClusterPool.destroy
- Defined in src/pools/abstract-pool.ts:450

Defined in src/pools/abstract-pool.ts:622

`Protected` destroyWorker

Defined in src/pools/cluster/fixed.ts:63

enableTasksQueue

Defined in src/pools/abstract-pool.ts:527

execute

Optional data: Data
-
The 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.
@@ -512,7 +563,7 @@ Can be overridden.
Inherited from FixedClusterPool.execute
- Defined in src/pools/abstract-pool.ts:416

Defined in src/pools/abstract-pool.ts:587

`Protected` internalBusy

Defined in src/pools/abstract-pool.ts:578

`Protected` isMain

`Protected` registerWorkerMessageListener

registerWorkerMessageListener<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
-
-
Inherited from FixedClusterPool.registerWorkerMessageListener
-
- Defined in src/pools/cluster/fixed.ts:81

Defined in src/pools/cluster/fixed.ts:58

`Protected` sendToWorker

-
message: MessageValue<Data, unknown, Worker | MessagePort>
+
message: MessageValue<Data, unknown>

The message.

@@ -603,7 +613,7 @@ Can be overridden.

Defined in src/pools/cluster/fixed.ts:72

setTasksQueueOptions

Defined in src/pools/abstract-pool.ts:539

setWorkerChoiceStrategy

Defined in src/pools/abstract-pool.ts:497

setWorkerChoiceStrategyOptions

Defined in src/pools/abstract-pool.ts:516

`Protected` setupHook

setupHook(): void
-
Setup 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
Inherited from FixedClusterPool.setupHook
- Defined in src/pools/cluster/fixed.ts:60

Defined in src/pools/cluster/fixed.ts:53

`Protected` workerListener

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.

Defined in src/pools/abstract-pool.ts:1025

WorkerTypes

availableParallelism

Generated using TypeDoc

\ No newline at end of file

Parameters

message: MessageValue<Message, unknown, Worker | MessagePort>

Returns void