DynamicClusterPool | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicClusterPool.html;h=ae97fc9c47f17ba9f1c4a5f03a3d8e2956420eaf;hb=b2ec8632edaea1f4ee24a532e61ca6e5619b7bfb;hp=f92eff4efe30e223ecb47c5769754fb403723c17;hpb=6ddc8fc5fa990a91503f816001d216a002a3ddae;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index f92eff4e..ae97fc9c 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -1,4 +1,4 @@ -DynamicClusterPool | poolifier - v2.6.41

+DynamicClusterPool | poolifier - v3.0.5

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

@@ -80,32 +80,39 @@ When the maximum number of workers is reached and workers are busy, an event is

Constructors

@@ -150,13 +157,14 @@ When the maximum number of workers is reached and workers are busy, an event is

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

Properties

`Optional` `Readonly` emitter

emitter?: PoolEmitter

Emitter on which events can be listened to.

`Optional` emitter

emitter?: EventEmitterAsyncResource

Event emitter integrated with async resource on which events can be listened to. +The async tracking tooling identifier is poolifier:<PoolType>-<WorkerType>-pool.

Events that can currently be listened to:

'ready': Emitted when the number of workers created in the pool has reached the minimum size expected and are ready.

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

`Protected` `Readonly` filePath

filePath: string

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

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

`Protected` `Readonly` max

max: number

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

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

`Protected` `Readonly` numberOfWorkers

numberOfWorkers: number

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

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

`Protected` `Readonly` opts

opts: ClusterPoolOptions = {}

@@ -207,11 +215,11 @@ 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<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:89

`Protected` workerChoiceStrategyContext

workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>

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

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

`Readonly` `Internal` workerNodes

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

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

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

Accessors

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

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

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 FixedClusterPool.addTaskFunction
+
- Defined in src/pools/abstract-pool.ts:805

`Protected` afterTaskExecutionHook

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

`Protected` afterWorkerNodeSetup

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

`Protected` beforeTaskExecutionHook

`Protected` checkDynamicPoolSize

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

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

`Protected` createAndSetupDynamicWorkerNode

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

`Protected` createAndSetupWorkerNode

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

`Protected` createWorker

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

`Protected` deregisterWorkerMessageListener

deregisterWorkerMessageListener<Message>(workerNodeKey, listener): void
+
Deregisters a listener callback on the worker given its worker node key.
+
+
+
Type Parameters
+
- +
  Message
+
+
Parameters
+
- +
  workerNodeKey: number
  +
  The worker node key.
  +
  +
- +
  listener: ((message) => void)
  +
  The message listener callback.
  +
  +
  +
  - +
    - (message): void
    - +
      +
      Parameters
      +
      +
      +
      message: MessageValue<Message, unknown>
      +
      Returns void
+
Returns void
+
+
Inherited from FixedClusterPool.deregisterWorkerMessageListener
+
- Defined in src/pools/cluster/fixed.ts:117

destroy

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

`Protected` destroyWorkerNode

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

enableTasksQueue

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

execute

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

`Protected` flagWorkerNodeAsNotReady

flagWorkerNodeAsNotReady(workerNodeKey): void
+
+
Parameters
+
- +
  workerNodeKey: number
+
Returns void
+
Inherited from FixedClusterPool.flagWorkerNodeAsNotReady
+
- Defined in src/pools/abstract-pool.ts:1649

`Protected` flushTasksQueue

Returns void

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

`Protected` getWorkerInfo

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

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 FixedClusterPool.hasTaskFunction
+
- Defined in src/pools/abstract-pool.ts:792

hasWorkerNodeBackPressure

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

`Protected` internalBusy

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

`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 FixedClusterPool.listTaskFunctions
+
Inherited from FixedClusterPool.listTaskFunctionNames
+
- Defined in src/pools/abstract-pool.ts:844

`Protected` registerOnceWorkerMessageListener

registerOnceWorkerMessageListener<Message>(workerNodeKey, listener): void
+
Registers once a listener callback on the worker given its worker node key.
+
+
+
Type Parameters
+
- +
  Message
+
+
Parameters
+
- +
  workerNodeKey: number
  +
  The worker node key.
  +
  +
- +
  listener: ((message) => void)
  +
  The message listener callback.
  +
  +
  +
  - +
    - (message): void
    - +
      +
      Parameters
      +
      +
      +
      message: MessageValue<Message, unknown>
      +
      Returns void
+
Returns void
+
+
Inherited from FixedClusterPool.registerOnceWorkerMessageListener
- Defined in src/pools/abstract-pool.ts:726

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

`Protected` registerWorkerMessageListener

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

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 FixedClusterPool.removeTaskFunction
+
- Defined in src/pools/abstract-pool.ts:828

`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:960

`Protected` sendStartupMessageToWorker

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

`Protected` sendToWorker

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

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 FixedClusterPool.setDefaultTaskFunction
+
- Defined in src/pools/abstract-pool.ts:857

setTasksQueueOptions

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

setWorkerChoiceStrategy

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

setWorkerChoiceStrategyOptions

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

`Protected` setupHook

`Protected` workerListener

workerListener(): ((message) => void)
Defined in src/pools/cluster/fixed.ts:53

start

start(): void
-
This method is the listener registered for each worker message.
+
Starts the minimum number of workers in this pool.

-
Returns ((message) => void)
The listener function to execute when a message is received from a worker.
- -
- -
  - (message): void

`Protected` workerMessageListener

workerMessageListener(message): void
-
This method is the listener registered for each worker message.
+
This method is the message listener registered on each worker.
Parameters
- message: MessageValue<Response, unknown>
-
Returns void
The listener function to execute when a message is received from a worker.
- -

Returns void

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

start

workerMessageListener

Generated using TypeDoc

\ No newline at end of file +

\ No newline at end of file

Parameters

message: MessageValue<Message, unknown>

Returns void

Parameters

message: MessageValue<Message, unknown>

Returns void