DynamicClusterPool

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicClusterPool.html;h=909eb463fafa2a8a77fd8217a6a920f8823018e5;hb=761b0c73be0bf581f50a78123913f933bd405f52;hp=e58245ddb04ce54782236ec11b5eedbc2a8ece25;hpb=18ba88e2f8612c6137bf564388ce8f905ae6d4ee;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index e58245dd..909eb463 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -1,4 +1,4 @@ -DynamicClusterPool | poolifier

+DynamicClusterPool | poolifier

Response = unknown

Type of response of execution. This can only be serializable data.

Type of execution response. This can only be serializable data.

Hierarchy

FixedClusterPool<Data, Response> +
FixedClusterPool<Data, Response>
- DynamicClusterPool

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

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

Accessors

busy -full +

busy +full numberOfQueuedTasks numberOfRunningTasks type @@ -80,14 +80,17 @@ When the maximum number of workers is reached and workers are busy, an event is createAndSetupWorker createWorker destroy -destroyWorker +destroyWorker +enableTasksQueue execute findFreeWorkerNodeKey internalBusy isMain -registerWorkerMessageListener +registerWorkerMessageListener sendToWorker +setTasksQueueOptions setWorkerChoiceStrategy +setWorkerChoiceStrategyOptions setupHook workerListener

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

constructor

new DynamicClusterPool<Data, Response>(min: number, max: number, filePath: string, opts?: ClusterPoolOptions): DynamicClusterPool<Data, Response>
new DynamicClusterPool<Data, Response>(min: number, max: number, filePath: string, opts?: ClusterPoolOptions): DynamicClusterPool<Data, Response>
Constructs a new poolifier dynamic cluster pool.

@@ -126,35 +129,40 @@ When the maximum number of workers is reached and workers are busy, an event is
opts: ClusterPoolOptions = {}

Options for this dynamic cluster pool.

Returns DynamicClusterPool<Data, Response>

Properties

`Optional` `Readonly` emitter

emitter?: PoolEmitter

Inherit Doc

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

`Readonly` filePath

filePath: string

Path to the worker-file.

Path to the worker file.

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

`Readonly` max

max: number

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

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

`Readonly` numberOfWorkers

numberOfWorkers: number

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

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

`Readonly` opts

opts: ClusterPoolOptions = {}

@@ -170,10 +178,10 @@ When the maximum number of workers is reached and workers are busy, an event is

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

`Protected` promiseResponseMap

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

The execution response promise map.

key: The message id of each submitted task.

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

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

`Readonly` workerNodes

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

Inherit Doc

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

Accessors

busy

`Protected` busy

get busy(): boolean
-
-
Inherit Doc
+
Whether the pool is busy or not.
+
The pool busyness boolean status.
+

Returns boolean
Overrides FixedClusterPool.busy
- Defined in src/pools/cluster/dynamic.ts:48

full

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

`Protected` full

get full(): boolean
-
-
Inherit Doc
+
Whether the pool is full or not.
+
The pool filling boolean status.
+

Returns boolean
Overrides FixedClusterPool.full
- Defined in src/pools/cluster/dynamic.ts:43

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

`Private` numberOfQueuedTasks

Returns number

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

`Private` numberOfRunningTasks

Returns number

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

type

get type(): PoolType
get type(): PoolType
-
-
Inherit Doc
-
Returns PoolType
+
Pool type.
+
If it is 'dynamic', it provides the max property.
+
+
Returns PoolType
Overrides FixedClusterPool.type
- Defined in src/pools/cluster/dynamic.ts:38

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

Methods

`Protected` afterTaskExecutionHook

afterTaskExecutionHook(worker: Worker, message: MessageValue<Response, unknown>): void
afterTaskExecutionHook(worker: Worker, message: MessageValue<Response, unknown>): void
Hook executed after the worker task execution. Can be overridden.
@@ -276,29 +287,32 @@ Can be overridden.

The worker.
-
message: MessageValue<Response, unknown>
+
message: MessageValue<Response, unknown>

The received message.

Returns void

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

`Protected` afterWorkerSetup

afterWorkerSetup(worker: Worker): void
-
-
Inherit Doc
+
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.
+
Parameters
- -
  worker: Worker
+
worker: Worker
+
The newly created worker.
+

Returns void

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

`Protected` beforeTaskExecutionHook

Returns void

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

`Protected` chooseWorkerNode

chooseWorkerNode(): [number, WorkerNode<Worker, Data>]
chooseWorkerNode(): [number, WorkerNode<Worker, Data>]
Chooses a worker node for the next task.

The default uses a round robin algorithm to distribute the load.

Returns
[worker node key, worker node].

-
Returns [number, WorkerNode<Worker, Data>]
+
Returns [number, WorkerNode<Worker, Data>]
Inherited from FixedClusterPool.chooseWorkerNode
- Defined in src/pools/abstract-pool.ts:337

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

`Protected` createAndSetupWorker

Returns Worker

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

`Protected` createWorker

createWorker(): Worker
-
-
Inherit Doc
+
Returns a newly created worker.
+

Returns Worker
Inherited from FixedClusterPool.createWorker
- Defined in src/pools/cluster/fixed.ts:88

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

destroy

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

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

destroyWorker

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

`Protected` destroyWorker

destroyWorker(worker: Worker): void
-
-
Inherit Doc
+
Shutdowns the given worker.
+
Parameters
- -
  worker: Worker
+
worker: Worker
+
A worker within workerNodes.
+

Returns void

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

enableTasksQueue

enableTasksQueue(enable: boolean, tasksQueueOptions?: TasksQueueOptions): void
+
Enables/disables the worker tasks queue in this pool.
+
+
+
Parameters
+
- +
  enable: boolean
  +
  Whether to enable or disable the worker tasks queue.
  +
- +
  Optional tasksQueueOptions: TasksQueueOptions
  +
  The worker tasks queue options.
  +
+
Returns void
+
Inherited from FixedClusterPool.enableTasksQueue
+
- Defined in src/pools/abstract-pool.ts:254

execute

execute(data: Data): Promise<Response>
execute(data?: Data): Promise<Response>
-
-
Inherit Doc
+
Executes the function specified in the worker constructor with the task data input parameter.
+ +
Returns
Promise that will be fulfilled when the task is completed.
+
Parameters
- -
  data: Data
-
Returns Promise<Response>
+
Optional data: Data
+
The task input data for the specified worker function. This can only be serializable data.
+

Returns Promise<Response>

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

findFreeWorkerNodeKey

findFreeWorkerNodeKey(): number
-
-
Inherit Doc
+
Finds a free worker node key based on the number of tasks the worker has applied.
+
If a worker is found with 0 running tasks, it is detected as free and its worker node key is returned.
+
If no free worker is found, -1 is returned.
+ +
Returns
A worker node key if there is one, -1 otherwise.
+

Returns number
Inherited from FixedClusterPool.findFreeWorkerNodeKey
- Defined in src/pools/abstract-pool.ts:221

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

`Protected` internalBusy

Returns boolean

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

`Protected` isMain

isMain(): boolean
-
-
Inherit Doc
+
Should return whether the worker is the main worker or not.
+

Returns boolean
Inherited from FixedClusterPool.isMain
- Defined in src/pools/cluster/fixed.ts:64

registerWorkerMessageListener

registerWorkerMessageListener<Message>(worker: Worker, listener: ((message: MessageValue<Message, unknown>) => void)): void
Defined in src/pools/cluster/fixed.ts:64

`Protected` registerWorkerMessageListener

registerWorkerMessageListener<Message>(worker: Worker, listener: ((message: MessageValue<Message, unknown>) => void)): void
-
-
Inherit Doc
+
Registers a listener callback on the given worker.
+
Type Parameters
Returns void
Inherited from FixedClusterPool.registerWorkerMessageListener
- Defined in src/pools/cluster/fixed.ts:80

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

`Protected` sendToWorker

sendToWorker(worker: Worker, message: MessageValue<Data, unknown>): void
sendToWorker(worker: Worker, message: MessageValue<Data, unknown>): void
-
-
Inherit Doc
+
Sends a message to the given worker.
+
Parameters
- -
  worker: Worker
- -
  message: MessageValue<Data, unknown>
+
message: MessageValue<Data, unknown>
+
The message.
+

Returns void

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

setTasksQueueOptions

setTasksQueueOptions(tasksQueueOptions: TasksQueueOptions): void
+
Sets the worker tasks queue options in this pool.
+
+
+
Parameters
+
- +
  tasksQueueOptions: TasksQueueOptions
  +
  The worker tasks queue options.
  +
+
Returns void
+
Inherited from FixedClusterPool.setTasksQueueOptions
+
- Defined in src/pools/abstract-pool.ts:266

setWorkerChoiceStrategy

setWorkerChoiceStrategy(workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"): void
setWorkerChoiceStrategy(workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN", workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions): void
-
-
Inherit Doc
+
Sets the worker choice strategy in this pool.
+
Parameters
- -
  workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
+
workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
+
The worker choice strategy.
+
+
Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
+
The worker choice strategy options.
+

Returns void

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

setWorkerChoiceStrategyOptions

setWorkerChoiceStrategyOptions(workerChoiceStrategyOptions: WorkerChoiceStrategyOptions): void
+
Sets the worker choice strategy options in this pool.
+
+
+
Parameters
+
- +
  workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
  +
  The worker choice strategy options.
  +
+
Returns void
+
Inherited from FixedClusterPool.setWorkerChoiceStrategyOptions
+
- Defined in src/pools/abstract-pool.ts:244

`Protected` setupHook

setupHook(): void
-
-
Inherit Doc
+
Setup hook to execute code before worker node are created in the abstract constructor. +Can be overridden
+

Returns void
Inherited from FixedClusterPool.setupHook
- Defined in src/pools/cluster/fixed.ts:59

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

`Protected` workerListener

workerListener(): ((message: MessageValue<Response, unknown>) => void)
workerListener(): ((message: MessageValue<Response, unknown>) => void)
This function is the listener registered for each worker message.

Returns
The listener function to execute when a message is received from a worker.

-
Returns ((message: MessageValue<Response, unknown>) => void)
+
Returns ((message: MessageValue<Response, unknown>) => void)
- - (message: MessageValue<Response, unknown>): void
  - (message: MessageValue<Response, unknown>): void
  - This function is the listener registered for each worker message.
    @@ -532,15 +629,16 @@ Can be overridden.
    
    Parameters
    - -
      message: MessageValue<Response, unknown>
    +
    message: MessageValue<Response, unknown>
  Returns void

- + - + +

Generated using TypeDoc

\ No newline at end of file +

\ No newline at end of file

Inherit Doc

Returns boolean

worker: Worker

worker: Worker

enable: boolean

`Optional` tasksQueueOptions: TasksQueueOptions

data: Data

worker: Worker

worker: Worker

listener: ((message: MessageValue<Message, unknown>) => void)

listener: ((message: MessageValue<Message, unknown>) => void)

Parameters

message: MessageValue<Message, unknown>

message: MessageValue<Message, unknown>

Returns void

worker: Worker

message: MessageValue<Data, unknown>

tasksQueueOptions: TasksQueueOptions

workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"

workerChoiceStrategyOptions: WorkerChoiceStrategyOptions

Parameters

message: MessageValue<Response, unknown>

message: MessageValue<Response, unknown>

Member Visibility

Theme