X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedClusterPool.html;h=f52bd444f7e096f06c75c0598f0f43c0e575ce1a;hb=c914a50e9996ca3f869c130974bff87b117f70f5;hp=88503f4b01c351be97f5300d28499c699e150755;hpb=fddf9cc424b3ace38fd414899c666c76a03c3aff;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index 88503f4b..f52bd444 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -1,4 +1,4 @@ -FixedClusterPool | poolifier

+FixedClusterPool | poolifier - v2.6.9

@@ -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 @@

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.

@@ -47,7 +45,7 @@

DynamicClusterPool

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

@@ -74,15 +72,19 @@ info maxSize minSize +ready +starting type +utilization worker

Methods

afterTaskExecutionHook -afterWorkerSetup +afterWorkerSetup beforeTaskExecutionHook -chooseWorkerNode +checkDynamicPoolSize +createAndSetupDynamicWorker createAndSetupWorker createWorker destroy @@ -91,7 +93,6 @@ execute internalBusy isMain -registerWorkerMessageListener sendToWorker setTasksQueueOptions setWorkerChoiceStrategy @@ -137,7 +138,7 @@

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

Properties

@@ -146,8 +147,9 @@

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

@@ -155,7 +157,7 @@

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

`Protected` `Readonly` filePath

filePath: string

@@ -164,7 +166,7 @@

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

`Protected` `Readonly` numberOfWorkers

numberOfWorkers: number

@@ -173,7 +175,7 @@

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

`Protected` `Readonly` opts

opts: ClusterPoolOptions = {}

@@ -182,7 +184,7 @@

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

`Protected` promiseResponseMap

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

@@ -196,26 +198,25 @@

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

`Protected` workerChoiceStrategyContext

workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>

Worker choice strategy context referencing a worker choice algorithm implementation.

Default to a round robin algorithm.

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

@@ -230,7 +231,7 @@

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

`Private` ready

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

`Private` starting

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

`Protected` type

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

`Private` utilization

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

`Protected` worker

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

Methods

@@ -324,7 +356,7 @@ Can be overridden.

message: MessageValue<Response, Worker | MessagePort>

message: MessageValue<Response, unknown>

The received message.

@@ -332,14 +364,14 @@ Can be overridden.

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

`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
@@ -351,13 +383,13 @@ Can be overridden.

Returns void

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

`Protected` beforeTaskExecutionHook

beforeTaskExecutionHook(workerNodeKey): void
beforeTaskExecutionHook(workerNodeKey, task): void
Hook executed before the worker task execution. Can be overridden.
@@ -369,26 +401,46 @@ Can be overridden.

workerNodeKey: number

The worker node key.

+
+
task: Task<Data>
+
The task to execute.
+

Returns void

`Protected` chooseWorkerNode

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

`Protected` checkDynamicPoolSize

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

`Protected` createAndSetupDynamicWorker

chooseWorkerNode(): number
createAndSetupDynamicWorker(): Worker
-
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.
-
Inherited from AbstractPool.chooseWorkerNode
+
Inherited from AbstractPool.createAndSetupDynamicWorker
- Defined in src/pools/abstract-pool.ts:554

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

`Protected` createAndSetupWorker

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

`Protected` createWorker

createWorker(): Worker
-
Returns a newly created worker.
+
Creates a new worker.

-
Returns Worker
+
Returns Worker
Newly created worker.
+
Overrides AbstractPool.createWorker
- Defined in src/pools/cluster/fixed.ts:92

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

destroy

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

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

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

`Protected` destroyWorker

destroyWorker(worker): void
-
Shutdowns the given worker.
+
Terminates the given worker.
Parameters
@@ -445,7 +498,7 @@ Can be overridden.
Overrides AbstractPool.destroyWorker
- Defined in src/pools/cluster/fixed.ts:73

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

enableTasksQueue

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

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.
@@ -496,16 +549,20 @@ Can be overridden.
Inherited from AbstractPool.execute
- Defined in src/pools/abstract-pool.ts:383

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

`Protected` internalBusy

internalBusy(): boolean
-
Returns boolean
+
Whether worker nodes are executing at least one task.
+
+
Returns boolean
Worker nodes busyness boolean status.
+ +
Inherited from AbstractPool.internalBusy
- Defined in src/pools/abstract-pool.ts:374

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

`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, Worker | MessagePort>
      -
      Returns void
-
Returns void
-
-
Overrides AbstractPool.registerWorkerMessageListener
-
- Defined in src/pools/cluster/fixed.ts:84

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

`Protected` sendToWorker

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

The message.

@@ -583,7 +599,7 @@ Can be overridden.

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

setTasksQueueOptions

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

setWorkerChoiceStrategy

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.

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

setWorkerChoiceStrategyOptions

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

`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
Overrides AbstractPool.setupHook
- Defined in src/pools/cluster/fixed.ts:63

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

`Protected` workerListener

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.

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

WorkerTypes

availableParallelism

Generated using TypeDoc

\ No newline at end of file

Parameters

message: MessageValue<Message, Worker | MessagePort>

Returns void