FixedClusterPool | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=docs%2Fclasses%2FFixedClusterPool.html;h=98f5c30d4c20f78c2b940cc01118016592505737;hb=447eca603b96bc46303dfa16f3048b68ae576b0c;hp=be66f8d7da6d193a1488ab3d3f7a6ce1dbdd84c6;hpb=7455be54c58f74c6f0d0dd597aa431a88da0a9d8;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index be66f8d7..98f5c30d 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -1,4 +1,4 @@ -FixedClusterPool | poolifier - v2.6.42

+FixedClusterPool | poolifier - v2.7.0

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

DynamicClusterPool

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

@@ -80,7 +80,8 @@

@@ -145,7 +150,7 @@

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

Properties

@@ -166,7 +171,7 @@

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

`Protected` `Readonly` filePath

filePath: string

@@ -175,7 +180,7 @@

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

`Protected` `Optional` `Readonly` max

max?: number

@@ -184,7 +189,7 @@

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

`Protected` `Readonly` numberOfWorkers

numberOfWorkers: number

@@ -193,7 +198,7 @@

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

`Protected` `Readonly` opts

opts: ClusterPoolOptions = {}

@@ -202,11 +207,11 @@

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

`Protected` promiseResponseMap

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

The task execution response promise map.

The task execution response promise map:

key: The message id of each submitted task.
value: An object that contains the worker, the execution response promise resolve and reject callbacks.

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

`Protected` workerChoiceStrategyContext

workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>

@@ -225,7 +230,7 @@

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

`Readonly` `Internal` workerNodes

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

@@ -234,7 +239,7 @@

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

Accessors

@@ -249,7 +254,7 @@

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

Methods

addTaskFunction

addTaskFunction(name, fn): Promise<boolean>
+
Adds a task function to this pool. +If a task function with the same name already exists, it will be overwritten.
+
+
+
Parameters
+
- +
  name: string
  +
  The name of the task function.
  +
  +
- +
  fn: TaskFunction<Data, Response>
  +
  The task function.
  +
  +
+
Returns Promise<boolean>
true if the task function was added, false otherwise.
+ +
+
Throws
https://nodejs.org/api/errors.html#class-typeerror If the name parameter is not a string or an empty string.
+ +
Throws
https://nodejs.org/api/errors.html#class-typeerror If the fn parameter is not a function.
+
+
Inherited from AbstractPool.addTaskFunction
+
- Defined in src/pools/abstract-pool.ts:856

`Protected` afterTaskExecutionHook

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

`Protected` afterWorkerNodeSetup

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

`Protected` beforeTaskExecutionHook

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

`Protected` checkDynamicPoolSize

Returns void

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

`Protected` createAndSetupDynamicWorkerNode

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

`Protected` createAndSetupWorkerNode

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

`Protected` createWorker

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

destroy

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

`Protected` destroyWorkerNode

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

enableTasksQueue

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

execute

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

`Protected` flushTasksQueue

Returns void

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

`Protected` getWorkerInfo

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

hasTaskFunction

hasTaskFunction(name): boolean
+
Whether the specified task function exists in this pool.
+
+
+
Parameters
+
- +
  name: string
  +
  The name of the task function.
  +
  +
+
Returns boolean
true if the task function exists, false otherwise.
+ +
+
Inherited from AbstractPool.hasTaskFunction
+
- Defined in src/pools/abstract-pool.ts:843

hasWorkerNodeBackPressure

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

`Protected` internalBusy

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

`Protected` isMain

listTaskFunctions

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

listTaskFunctionNames

listTaskFunctions(): string[]
listTaskFunctionNames(): string[]
Lists the names of task function available in this pool.

Returns string[]
The names of task function available in this pool.
-
Inherited from AbstractPool.listTaskFunctions
+
Inherited from AbstractPool.listTaskFunctionNames
- Defined in src/pools/abstract-pool.ts:726

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

`Protected` registerWorkerMessageListener

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

removeTaskFunction

removeTaskFunction(name): Promise<boolean>
+
Removes a task function from this pool.
+
+
+
Parameters
+
- +
  name: string
  +
  The name of the task function.
  +
  +
+
Returns Promise<boolean>
true if the task function was removed, false otherwise.
+ +
+
Inherited from AbstractPool.removeTaskFunction
+
- Defined in src/pools/abstract-pool.ts:879

`Protected` sendKillMessageToWorker

sendKillMessageToWorker(workerNodeKey, workerId): Promise<void>
sendKillMessageToWorker(workerNodeKey): Promise<void>
Parameters
- -
  workerNodeKey: number
- -
  workerId: number
+
workerNodeKey: number

Returns Promise<void>

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

`Protected` sendStartupMessageToWorker

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

`Protected` sendToWorker

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

setDefaultTaskFunction

setDefaultTaskFunction(name): Promise<boolean>
+
Sets the default task function in this pool.
+
+
+
Parameters
+
- +
  name: string
  +
  The name of the task function.
  +
  +
+
Returns Promise<boolean>
true if the default task function was set, false otherwise.
+ +
+
Inherited from AbstractPool.setDefaultTaskFunction
+
- Defined in src/pools/abstract-pool.ts:908

setTasksQueueOptions

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

setWorkerChoiceStrategy

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

setWorkerChoiceStrategyOptions

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

`Protected` setupHook

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

start

start(): void
+
Starts the minimum number of workers in this pool.
+
+
Returns void
+
+
Inherited from AbstractPool.start
+
- Defined in src/pools/abstract-pool.ts:984

`Protected` workerListener

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