FixedClusterPool | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedClusterPool.html;h=dff66fdd08f442f39ad5e998942b04b4375a0253;hb=9d96ba4ea0e2e4b06216657cb1641551b59f58ee;hp=15300e68c3ac6e51bde0f9c6a83ca2732d1da3f7;hpb=e905ea64c054a25ef73885e41fc063279bc599ca;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index 15300e68..dff66fdd 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -1,4 +1,4 @@ -FixedClusterPool | poolifier - v2.6.44

+FixedClusterPool | poolifier - v2.7.4

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

DynamicClusterPool

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

@@ -80,31 +80,37 @@

@@ -145,13 +151,14 @@

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

Properties

`Optional` `Readonly` emitter

emitter?: PoolEmitter

Emitter on which events can be listened to.

`Optional` emitter

emitter?: __module | 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:73

`Protected` `Readonly` filePath

filePath: string

@@ -175,7 +182,7 @@

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

`Protected` `Optional` `Readonly` max

max?: number

@@ -184,7 +191,7 @@

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

`Protected` `Readonly` numberOfWorkers

numberOfWorkers: number

@@ -193,7 +200,7 @@

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

`Protected` `Readonly` opts

opts: ClusterPoolOptions = {}

@@ -202,11 +209,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:82

`Protected` workerChoiceStrategyContext

workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>

@@ -225,7 +232,7 @@

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

`Readonly` `Internal` workerNodes

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

@@ -234,7 +241,7 @@

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

Accessors

@@ -249,7 +256,7 @@

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

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:796

`Protected` afterTaskExecutionHook

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

`Protected` afterWorkerNodeSetup

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

`Protected` beforeTaskExecutionHook

`Protected` checkDynamicPoolSize

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

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

`Protected` createAndSetupDynamicWorkerNode

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

`Protected` createAndSetupWorkerNode

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

`Protected` createWorker

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

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

destroy

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

`Protected` destroyWorkerNode

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

enableTasksQueue

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

execute

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

`Protected` flushTasksQueue

Returns void

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

`Protected` getWorkerInfo

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

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:783

hasWorkerNodeBackPressure

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

`Protected` internalBusy

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

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

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

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

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

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

setTasksQueueOptions

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

setWorkerChoiceStrategy

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

setWorkerChoiceStrategyOptions

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

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

`Protected` workerListener

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

Generated using TypeDoc

Parameters

message: MessageValue<Message, unknown>

Returns void

Parameters

message: MessageValue<Message, unknown>

Returns void