DynamicClusterPool | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicClusterPool.html;h=3c8b321fcf74e144f7d792f234d8c661977ec7ba;hb=25926072f5397949802f6af5a2f7d49d6f15cacc;hp=7a747ac53a3ee00436d4a0f6cd444f9aecf6beec;hpb=2041f3d8b2564bfab8e30db6a87dba283219ca86;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index 7a747ac5..3c8b321f 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -1,13 +1,13 @@ -DynamicClusterPool | poolifier - v2.6.40

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

DynamicClusterPool

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

Index

Constructors

constructor +

constructor

Properties

emitter? +

emitter? filePath max numberOfWorkers @@ -68,7 +68,7 @@ When the maximum number of workers is reached and workers are busy, an event is

Accessors

busy +

busy full info maxSize @@ -80,37 +80,43 @@ When the maximum number of workers is reached and workers are busy, an event is

Constructors

constructor

new DynamicClusterPool<Data, Response>(min, max, filePath, opts?): DynamicClusterPool<Data, Response>
@@ -129,30 +135,35 @@ When the maximum number of workers is reached and workers are busy, an event is
min: number

Minimum number of workers which are always active.
-

max: number

Maximum number of workers that can be created by this pool.

filePath: string

Path to an implementation of a ClusterWorker file, which can be relative or absolute.

opts: ClusterPoolOptions = {}

Options for this dynamic cluster pool.

+ +

Returns DynamicClusterPool<Data, Response>

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?: __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

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

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

`Protected` `Readonly` max

max: number

@@ -185,7 +196,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

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

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

`Protected` `Readonly` opts

opts: ClusterPoolOptions = {}

@@ -203,11 +214,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:82

`Protected` workerChoiceStrategyContext

workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>

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

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

`Readonly` `Internal` workerNodes

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

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

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

Accessors

@@ -250,7 +261,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:796

`Protected` afterTaskExecutionHook

workerNodeKey: number

The worker node key.
-

message: MessageValue<Response, unknown>

The received message.
-

+ +

Returns void

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

`Protected` afterWorkerNodeSetup

workerNodeKey: number

The newly created worker node key.
-

+ +

Returns void

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

`Protected` beforeTaskExecutionHook

workerNodeKey: number

The worker node key.
-

task: Task<Data>

The task to execute.
-

+ +

Returns void

`Protected` checkDynamicPoolSize

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

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

destroy

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

`Protected` destroyWorkerNode

workerNodeKey: number

The worker node key.
-

+ +

Returns Promise<void>

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

enableTasksQueue

enable: boolean

Whether to enable or disable the worker node tasks queue.
-

Optional tasksQueueOptions: TasksQueueOptions

The worker node tasks queue options.
-
Optional

+ +

Returns void

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

execute

Optional data: Data

The optional task input data for the specified task function. This can only be structured-cloneable data.
-
Optional

Optional name: string

The optional name of the task function to execute. If not specified, the default task function will be executed.
-
Optional

Optional transferList: TransferListItem[]

An optional array of transferable objects to transfer ownership of. Ownership of the transferred objects is given to the pool's worker_threads worker and they should not be used in the main thread afterwards.
-
Optional

+ +

Returns Promise<Response>

Promise that will be fulfilled when the task is completed.

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

`Protected` flushTasksQueue

Returns void

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

`Protected` getWorkerInfo

getWorkerInfo(workerNodeKey): undefined | WorkerInfo
getWorkerInfo(workerNodeKey): WorkerInfo
Gets the worker information given its worker node key.

@@ -584,13 +662,35 @@ Can be overridden.
workerNodeKey: number

The worker node key.
-

Returns undefined | WorkerInfo

The worker information.

+ +

Returns WorkerInfo

The worker information.

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

hasWorkerNodeBackPressure

workerNodeKey: number

The worker node key.
-

+ +

Returns boolean

true if the worker node has back pressure, false otherwise.

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

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

`Protected` registerWorkerMessageListener

workerNodeKey: number

The worker node key.
-

listener: ((message) => void)

The message listener callback.

+

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

workerNodeKey: number

The worker node key.
-

+ +

Returns void

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

`Protected` sendToWorker

workerNodeKey: number

The worker node key.
-

message: MessageValue<Data, unknown>

The message.
-

+ +

Returns void

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

setTasksQueueOptions

tasksQueueOptions: TasksQueueOptions

The worker node tasks queue options.
-

+ +

Returns void

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

setWorkerChoiceStrategy

workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"

The worker choice strategy.
-

Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptions

The worker choice strategy options.
-
Optional

+ +

Returns void

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

setWorkerChoiceStrategyOptions

workerChoiceStrategyOptions: WorkerChoiceStrategyOptions

The worker choice strategy options.
-

+ +

Returns void

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

`Protected` workerListener

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

Generated using TypeDoc

\ No newline at end of file +

\ No newline at end of file

Index

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

constructor

min: number

max: number

filePath: string

opts: ClusterPoolOptions = {}

Returns DynamicClusterPool<Data, Response>

Properties

Optional Readonly emitter

Optional emitter

Protected Readonly filePath

Protected Readonly max

Protected Readonly numberOfWorkers

Protected Readonly opts

Protected promiseResponseMap

Protected workerChoiceStrategyContext

Readonly Internal workerNodes

Accessors

Protected full

info

Protected maxSize

Protected minSize

Private ready

Protected type

Private utilization

Protected worker

Methods

addTaskFunction

Parameters

name: string

fn: TaskFunction<Data, Response>

Returns Promise<boolean>

Throws

Throws

Protected afterTaskExecutionHook

workerNodeKey: number

message: MessageValue<Response, unknown>

Returns void

Protected afterWorkerNodeSetup

workerNodeKey: number

Returns void

Protected beforeTaskExecutionHook

workerNodeKey: number

task: Task<Data>

Returns void

Protected checkDynamicPoolSize

Parameters

min: number

max: number

Returns void

Protected createAndSetupDynamicWorkerNode

Protected createAndSetupWorkerNode

Protected createWorker

Protected deregisterWorkerMessageListener

Type Parameters

Message

Parameters

workerNodeKey: number

listener: ((message) => void)

Parameters

message: MessageValue<Message, unknown>

Returns void

Returns void

destroy

Protected destroyWorkerNode

workerNodeKey: number

Returns Promise<void>

enableTasksQueue

enable: boolean

Optional tasksQueueOptions: TasksQueueOptions

Returns void

execute

Optional data: Data

`Optional` `Readonly` emitter

`Optional` emitter

`Protected` `Readonly` filePath

`Protected` `Readonly` max

`Protected` `Readonly` numberOfWorkers

`Protected` `Readonly` opts

`Protected` promiseResponseMap

`Protected` workerChoiceStrategyContext

`Readonly` `Internal` workerNodes

`Protected` full

`Protected` maxSize

`Protected` minSize

`Private` ready

`Protected` type

`Private` utilization

`Protected` worker

`Protected` afterTaskExecutionHook

`Protected` afterWorkerNodeSetup

`Protected` beforeTaskExecutionHook

`Protected` checkDynamicPoolSize

`Protected` createAndSetupDynamicWorkerNode

`Protected` createAndSetupWorkerNode

`Protected` createWorker

`Protected` deregisterWorkerMessageListener

`Protected` destroyWorkerNode

`Optional` tasksQueueOptions: TasksQueueOptions

`Optional` data: Data

`Optional` name: string

`Optional` transferList: TransferListItem[]

`Protected` flushTasksQueue

`Protected` getWorkerInfo

`Protected` internalBusy

`Protected` isMain

`Protected` registerOnceWorkerMessageListener

`Protected` registerWorkerMessageListener

`Protected` sendKillMessageToWorker

`Protected` sendStartupMessageToWorker

`Protected` sendToWorker

`Optional` workerChoiceStrategyOptions: WorkerChoiceStrategyOptions

`Protected` setupHook

`Protected` workerListener