DynamicClusterPool

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicClusterPool.html;h=6383bbff27f10fe587f8d7256ef7c439111292d4;hb=fbc22127e53d3ec0ecbd38ecea25fb92ebef50e7;hp=32b0a2b850c3b266fb30427676aad833abc3885f;hpb=42db2d3372ac49ab00dd1889378238b7a78ac4ce;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index 32b0a2b8..6383bbff 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -1,4 +1,4 @@ -DynamicClusterPool | poolifier

+DynamicClusterPool | poolifier

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

Type Parameters

-
Data = unknown
+
Data = unknown

Type of data sent to the worker. This can only be serializable data.
-
Response = unknown
-
Type of response of execution. This can only be serializable data.
+
Response = unknown
+
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

@@ -50,53 +50,55 @@ When the maximum number of workers is reached and workers are busy, an event is

Constructors

constructor

new DynamicClusterPool<Data, Response>(min: number, max: number, filePath: string, opts?: ClusterPoolOptions): DynamicClusterPool<Data, Response>

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

@@ -104,76 +106,81 @@ When the maximum number of workers is reached and workers are busy, an event is
Type Parameters
- -
  Data = unknown
- -
  Response = unknown

Response = unknown

Parameters

-
min: number
+
min: number

Minimum number of workers which are always active.
-
max: number
+
max: number

Maximum number of workers that can be created by this pool.
-
filePath: string
+
filePath: string

Path to an implementation of a ClusterWorker file, which can be relative or absolute.
-
opts: ClusterPoolOptions = {}
+
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:42

`Readonly` filePath

filePath: string

Path to the worker-file.

filePath: string

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

Number of workers that this pool should manage.

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

`Readonly` opts

opts: ClusterPoolOptions = {}

Options for this fixed cluster pool.

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

get numberOfQueuedTasks(): number
Number of tasks queued in the pool.
@@ -235,10 +244,10 @@ When the maximum number of workers is reached and workers are busy, an event is
Returns number
Inherited from FixedClusterPool.numberOfQueuedTasks
- Defined in src/pools/abstract-pool.ts:182

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

`Private` numberOfRunningTasks

get numberOfRunningTasks(): number
Number of tasks running in the pool.
@@ -246,24 +255,25 @@ When the maximum number of workers is reached and workers are busy, an event is
Returns number
Inherited from FixedClusterPool.numberOfRunningTasks
- Defined in src/pools/abstract-pool.ts:172

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, message): void
Hook executed after the worker task execution. Can be overridden.
@@ -272,37 +282,40 @@ Can be overridden.

Parameters
- -
  worker: Worker
  +
  worker: Worker
  
  The worker.
- -
  message: MessageValue<Response, unknown>
  +
  message: MessageValue<Response, unknown>
  
  The received message.
Returns void
Inherited from FixedClusterPool.afterTaskExecutionHook
- Defined in src/pools/abstract-pool.ts:323

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

`Protected` afterWorkerSetup

afterWorkerSetup(worker: Worker): void

afterWorkerSetup(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

beforeTaskExecutionHook(workerNodeKey: number): void

beforeTaskExecutionHook(workerNodeKey): void
Hook executed before the worker task execution. Can be overridden.
@@ -311,218 +324,286 @@ Can be overridden.

Parameters
- -
  workerNodeKey: number
  +
  workerNodeKey: number
  
  The worker node key.
Returns void
Inherited from FixedClusterPool.beforeTaskExecutionHook
- Defined in src/pools/abstract-pool.ts:312

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

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

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

`Protected` createAndSetupWorker

createAndSetupWorker(): Worker

createAndSetupWorker(): Worker
Creates a new worker and sets it up completely in the pool worker nodes.

Returns
New, completely set up worker.

-
Returns Worker
+
Returns Worker
Inherited from FixedClusterPool.createAndSetupWorker
- Defined in src/pools/abstract-pool.ts:418

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

`Protected` createWorker

createWorker(): Worker

createWorker(): Worker
-
-
Inherit Doc
-
Returns Worker
+
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>

destroy(): Promise<void>
-
-
Inherit Doc
-
Returns Promise<void>
+
Shutdowns every current worker in this pool.
+
+
Returns Promise<void>
Inherited from FixedClusterPool.destroy
- Defined in src/pools/abstract-pool.ts:275

destroyWorker

destroyWorker(worker: Worker): void
Defined in src/pools/abstract-pool.ts:338

`Protected` destroyWorker

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

Returns void

execute

execute(data: Data): Promise<Response>
Defined in src/pools/cluster/fixed.ts:69

enableTasksQueue

enableTasksQueue(enable, tasksQueueOptions?): void
-
-
Inherit Doc
+
Enables/disables the worker tasks queue in this pool.
+
Parameters
- -
  data: Data
-
Returns Promise<Response>
-
Inherited from FixedClusterPool.execute
+
enable: boolean
+
Whether to enable or disable the worker tasks queue.
+
+
Optional tasksQueueOptions: TasksQueueOptions
+
The worker tasks queue options.
+

Returns void

findFreeWorkerNodeKey

findFreeWorkerNodeKey(): number
Defined in src/pools/abstract-pool.ts:254

execute

execute(data?): Promise<Response>
-
-
Inherit Doc
-
Returns number
-
Inherited from FixedClusterPool.findFreeWorkerNodeKey
+
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
+
- +
  Optional data: Data
  +
  The task input data for the specified worker function. This can only be serializable data.
  +
+
Returns Promise<Response>
+
Inherited from FixedClusterPool.execute
- Defined in src/pools/abstract-pool.ts:237

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

`Protected` internalBusy

internalBusy(): boolean

internalBusy(): boolean
Returns boolean
Inherited from FixedClusterPool.internalBusy
- Defined in src/pools/abstract-pool.ts:232

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

`Protected` isMain

isMain(): boolean

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, listener): void
-
-
Inherit Doc
+
Registers a listener callback on the given worker.
+
Type Parameters
- -
  Message
+
Message

Parameters

-
worker: Worker

worker: Worker

The worker which should register a listener.

-
listener: ((message: MessageValue<Message, unknown>) => void)
+
listener: ((message) => void)
+
The message listener callback.
+
- -
  - (message: MessageValue<Message, unknown>): void

Returns void

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

`Protected` sendToWorker

sendToWorker(worker: Worker, message: MessageValue<Data, unknown>): void

sendToWorker(worker, message): 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): 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, 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): 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

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) => 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) => void)
- -
  - (message: MessageValue<Response, unknown>): void
Inherited from FixedClusterPool.workerListener
- Defined in src/pools/abstract-pool.ts:441

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

Theme

workerChoiceStrategyContext

afterTaskExecutionHook

afterWorkerSetup

beforeTaskExecutionHook

registerWorkerMessageListener

sendToWorker

setTasksQueueOptions

setWorkerChoiceStrategy

setWorkerChoiceStrategyOptions

WorkerChoiceStrategyContext

ClusterPoolOptions

IPool

IWorker

IWorkerChoiceStrategy

MessageValue

PoolOptions

PromiseResponseWrapper

WorkerChoiceStrategyOptions

ThreadWorkerWithMessageChannel

WorkerChoiceStrategies

Generated using TypeDoc

\ No newline at end of file

Constructors

Properties

Accessors

Methods

Type Parameters

Data = unknown

Data = unknown

Response = unknown

Inherit Doc

Returns boolean

Returns number

Returns number

Inherit Doc

Parameters

worker: Worker

worker: Worker

message: MessageValue<Response, unknown>

message: MessageValue<Response, unknown>

Returns void

Inherit Doc

Parameters

worker: Worker

worker: Worker

workerNodeKey: number

workerNodeKey: number

Parameters

message: MessageValue<Message, unknown>

message: MessageValue<Message, unknown>