DynamicClusterPool

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicClusterPool.html;h=3e421373a21db07a80264558cd01a3a152be85b9;hb=b45edd35eec0fb1d5fd8fa979ff00f17f4e3c24e;hp=e577eba9ec89f43f998bf05516222da86c571d00;hpb=21402562176f7550bcd9ba620cf551972fca6e98;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index e577eba9..3e421373 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,27 +65,27 @@ When the maximum number of workers is reached and workers are busy, an event is

Accessors

busy -full +

busy +full numberOfQueuedTasks numberOfRunningTasks type

Methods

afterPromiseResponseHook +

afterTaskExecutionHook afterWorkerSetup -beforePromiseResponseHook +beforeTaskExecutionHook chooseWorkerNode createAndSetupWorker createWorker destroy -destroyWorker +destroyWorker execute findFreeWorkerNodeKey internalBusy isMain -registerWorkerMessageListener +registerWorkerMessageListener sendToWorker setWorkerChoiceStrategy setupHook @@ -96,7 +96,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,20 +126,25 @@ 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>

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

Properties

`Optional` `Readonly` emitter

emitter?: PoolEmitter

Inherit Doc

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

`Readonly` filePath

filePath: string

@@ -147,14 +152,14 @@ When the maximum number of workers is reached and workers are busy, an event is

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

`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 +167,7 @@ When the maximum number of workers is reached and workers are busy, an event is

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

`Readonly` opts

opts: ClusterPoolOptions = {}

@@ -170,10 +175,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:51

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

`Readonly` workerNodes

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

Inherit Doc

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

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

`Private` numberOfRunningTasks

Returns number

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

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` afterPromiseResponseHook

`Protected` afterTaskExecutionHook

afterPromiseResponseHook(worker: Worker, message: MessageValue<Response, unknown>): void
afterTaskExecutionHook(worker: Worker, message: MessageValue<Response, unknown>): void
-
Hook executed after the worker task promise resolution. +
Hook executed after the worker task execution. Can be overridden.

@@ -276,35 +284,38 @@ 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:335

`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

`Protected` beforePromiseResponseHook

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

`Protected` beforeTaskExecutionHook

beforePromiseResponseHook(workerNodeKey: number): void
beforeTaskExecutionHook(workerNodeKey: number): void
-
Hook executed before the worker task promise resolution. +
Hook executed before the worker task execution. Can be overridden.

@@ -315,23 +326,23 @@ Can be overridden.

The worker node key.

Returns void

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

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

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

`Protected` createAndSetupWorker

Returns Worker

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

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

destroyWorker

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

`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

execute

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

Returns Promise<Response>

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

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

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

`Protected` internalBusy

Returns boolean

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

`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

setWorkerChoiceStrategy

setWorkerChoiceStrategy(workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"): 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.
+

Returns void

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

`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 +564,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

constructor

opts: ClusterPoolOptions = {}

Inherit Doc

Returns boolean

worker: Worker

worker: Worker

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>

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

Parameters

message: MessageValue<Response, unknown>

message: MessageValue<Response, unknown>

Member Visibility

Theme