DynamicClusterPool

@@ -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
+
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,37 +106,37 @@ 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

Emitter on which events can be listened to.

Events that can currently be listened to:

@@ -144,41 +146,41 @@ When the maximum number of workers is reached and workers are busy, an event is

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>[] = []

Pool worker nodes.

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

Accessors

`Protected` busy

get busy(): boolean
Whether the pool is busy or not.
@@ -219,10 +221,10 @@ When the maximum number of workers is reached and workers are busy, an event is
Returns boolean
Overrides FixedClusterPool.busy
- Defined in src/pools/cluster/dynamic.ts:48

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

`Protected` full

get full(): boolean
Whether the pool is full or not.
@@ -231,10 +233,10 @@ When the maximum number of workers is reached and workers are busy, an event is
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.
@@ -242,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:186

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

`Private` numberOfRunningTasks

get numberOfRunningTasks(): number
Number of tasks running in the pool.
@@ -253,25 +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:176

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

type

get type(): PoolType

get type(): PoolType
Pool type.

If it is 'dynamic', it provides the max property.

-
Returns PoolType
+
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.
@@ -280,21 +282,21 @@ 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:335

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

`Protected` afterWorkerSetup

afterWorkerSetup(worker: Worker): void

afterWorkerSetup(worker): void
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.
@@ -303,17 +305,17 @@ Can be overridden.

Parameters
- -
  worker: Worker
  +
  worker: Worker
  
  The newly created worker.
Returns void
Inherited from FixedClusterPool.afterWorkerSetup
- Defined in src/pools/cluster/fixed.ts:93

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.
@@ -322,66 +324,66 @@ 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:324

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

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

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

`Protected` createWorker

createWorker(): Worker

createWorker(): Worker
Returns a newly created worker.

-
Returns 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>
Shutdowns every current worker in this pool.

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

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

`Protected` destroyWorker

destroyWorker(worker: Worker): void

destroyWorker(worker): void
Shutdowns the given worker.

@@ -389,72 +391,79 @@ Can be overridden.

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
-
Performs the task specified in the constructor with the data parameter.
- -
Returns
Promise that will be resolved when the task is successfully completed.
+
Enables/disables the worker tasks queue in this pool.
Parameters
- -
  data: Data
  -
  The input for the specified task. This can only be serializable data.
  +
  enable: boolean
  +
  Whether to enable or disable the worker tasks queue.
  +
- +
  Optional tasksQueueOptions: TasksQueueOptions
  +
  The worker tasks queue options.
-
Returns Promise<Response>
-
Inherited from FixedClusterPool.execute
+
Returns void
+
Inherited from FixedClusterPool.enableTasksQueue
- Defined in src/pools/abstract-pool.ts:256

findFreeWorkerNodeKey

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

execute

execute(data?): Promise<Response>
-
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.
+
Executes the function specified in the worker constructor with the task data input parameter.
-
Returns
A worker node key if there is one, -1 otherwise.
+
Returns
Promise that will be fulfilled when the task is completed.

-
Returns number
-
Inherited from FixedClusterPool.findFreeWorkerNodeKey
+
+
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:249

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

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

`Protected` isMain

isMain(): boolean

isMain(): boolean
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

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

`Protected` registerWorkerMessageListener

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

registerWorkerMessageListener<Message>(worker, listener): void
Registers a listener callback on the given worker.

@@ -462,37 +471,37 @@ Can be overridden.

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

Constructors

Properties

Accessors

Methods

Type Parameters

Data = unknown

Data = unknown

Response = unknown

Returns boolean

Returns boolean

Returns number

Returns number

Returns PoolType

Parameters

worker: Worker

worker: Worker

message: MessageValue<Response, unknown>

message: MessageValue<Response, unknown>

Returns void

Parameters

worker: Worker

worker: Worker

Returns void

Parameters

workerNodeKey: number

workerNodeKey: number

Returns void

Returns

Returns [number, WorkerNode<Worker, Data>]

Returns

Returns Worker

Returns Worker

Returns Promise<void>

Parameters

worker: Worker

worker: Worker

data: Data

enable: boolean

Optional tasksQueueOptions: TasksQueueOptions

Parameters

message: MessageValue<Message, unknown>

message: MessageValue<Message, unknown>

Parameters

message: MessageValue<Response, unknown>

`Optional` tasksQueueOptions: TasksQueueOptions