FixedClusterPool | poolifier

@@ -18,10 +20,6 @@

It is possible to perform tasks in sync or asynchronous mode as you prefer.

This pool selects the workers in a round robin fashion.

Template

of data sent to the worker. This can only be serializable data.

- -

Template

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

Author

Christopher Quadflieg

Since

2.0.0

@@ -30,9 +28,13 @@

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 response of execution. This can only be serializable data.

Hierarchy

DynamicClusterPool

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

@@ -56,39 +58,32 @@

constructor

new FixedClusterPool<Data, Response>(numberOfWorkers: number, filePath: string, opts??: ClusterPoolOptions): FixedClusterPool<Data, Response>
new FixedClusterPool<Data, Response>(numberOfWorkers: number, filePath: string, opts?: ClusterPoolOptions): FixedClusterPool<Data, Response>
Constructs a new poolifier fixed cluster pool.

@@ -125,70 +120,60 @@
Path to an implementation of a ClusterWorker file, which can be relative or absolute.
-
Optional opts: ClusterPoolOptions = {}
+
opts: ClusterPoolOptions = {}

Options for this fixed cluster pool.

Returns FixedClusterPool<Data, Response>

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

Properties

`Optional` `Readonly` emitter

emitter?: PoolEmitter

Inherit Doc

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

`Readonly` filePath

filePath: string

`Optional` `Readonly` max

max?: number

Inherit Doc

`Protected` nextMessageId

nextMessageId: number = 0

Id of the next message.

filePath: string

Path to the worker-file.

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

`Readonly` numberOfWorkers

numberOfWorkers: number

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

`Readonly` opts

opts: ClusterPoolOptions = {}

`Protected` promiseMap

promiseMap: Map<number, PromiseWorkerResponseWrapper<Worker, Response>> = ...

The promise map.

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

`Protected` promiseResponseMap

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

The promise response map.

key: This is the message Id of each submitted task.
value: An object that contains the worker, the resolve function and the reject function.
key: The message id of each submitted task.
value: An object that contains the worker, the promise resolve and reject callbacks.

When we receive a message from the worker we get a map entry and resolve/reject the promise based on the message.

When we receive a message from the worker we get a map entry with the promise resolve/reject bound to the message.

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

`Protected` workerChoiceStrategyContext

workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>

@@ -197,23 +182,15 @@

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

`Readonly` workers

workers: Worker[] = []

Inherit Doc

`Readonly` workersTasksUsage

workersTasksUsage: Map<Worker, TasksUsage> = ...

Inherit Doc

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

Accessors

@@ -221,40 +198,51 @@

get busy(): boolean
-
-
Inherit Doc
+
{@inheritDoc}
+

Returns boolean
Overrides AbstractPool.busy
- Defined in src/pools/cluster/fixed.ts:100

numberOfRunningTasks

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

full

get full(): boolean
+
{@inheritDoc}
+
+
Returns boolean
+
Overrides AbstractPool.full
+
- Defined in src/pools/cluster/fixed.ts:104

`Private` numberOfRunningTasks

get numberOfRunningTasks(): number
-
-
Inherit Doc
+
Number of tasks concurrently running.
+

Returns number
Inherited from AbstractPool.numberOfRunningTasks
- Defined in src/pools/abstract-pool.ts:156

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

type

get type(): PoolType
-
-
Inherit Doc
+
{@inheritDoc}
+

Returns PoolType
Overrides AbstractPool.type
- Defined in src/pools/cluster/fixed.ts:95

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

Methods

`Protected` afterPromiseWorkerResponseHook

`Protected` afterPromiseResponseHook

afterPromiseWorkerResponseHook(message: MessageValue<Response, unknown>, promise: PromiseWorkerResponseWrapper<Worker, Response>): void
afterPromiseResponseHook(worker: Worker, message: MessageValue<Response, unknown>): void
Hook executed after the worker task promise resolution. Can be overridden.
@@ -263,24 +251,24 @@ Can be overridden.

Parameters
- -
  message: MessageValue<Response, unknown>
  -
  The received message.
  +
  worker: Worker
  +
  The worker.
- -
  promise: PromiseWorkerResponseWrapper<Worker, Response>
  -
  The Promise response.
  +
  message: MessageValue<Response, unknown>
  +
  The received message.
Returns void
-
Inherited from AbstractPool.afterPromiseWorkerResponseHook
+
Inherited from AbstractPool.afterPromiseResponseHook
- Defined in src/pools/abstract-pool.ts:263

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

`Protected` afterWorkerSetup

afterWorkerSetup(worker: Worker): void
-
-
Inherit Doc
+
{@inheritDoc}
+
Parameters

`Protected` beforePromiseWorkerResponseHook

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

`Protected` beforePromiseResponseHook

beforePromiseWorkerResponseHook(worker: Worker): void
beforePromiseResponseHook(workerKey: number): void
Hook executed before the worker task promise resolution. Can be overridden.
@@ -302,27 +290,27 @@ Can be overridden.

Parameters
- -
  worker: Worker
  -
  The worker.
  +
  workerKey: number
  +
  The worker key.
Returns void
-
Inherited from AbstractPool.beforePromiseWorkerResponseHook
+
Inherited from AbstractPool.beforePromiseResponseHook
- Defined in src/pools/abstract-pool.ts:252

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

`Protected` chooseWorker

chooseWorker(): Worker
chooseWorker(): [number, Worker]
Chooses a worker for the next task.

The default implementation uses a round robin algorithm to distribute the load.
-
Returns
Worker.
+
Returns
[worker key, worker].

-
Returns Worker
+
Returns [number, Worker]
Inherited from AbstractPool.chooseWorker
- Defined in src/pools/abstract-pool.ts:290

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

`Protected` createAndSetupWorker

Returns Worker

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

`Protected` createWorker

createWorker(): Worker
-
-
Inherit Doc
+
{@inheritDoc}
+

Returns Worker
Overrides AbstractPool.createWorker
- Defined in src/pools/cluster/fixed.ts:84

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

destroy

destroy(): Promise<void>
-
-
Inherit Doc
+
{@inheritDoc}
+

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

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

destroyWorker

destroyWorker(worker: Worker): void
-
-
Inherit Doc
+
{@inheritDoc}
+
Parameters

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

execute

execute(data: Data): Promise<Response>
-
-
Inherit Doc
+
{@inheritDoc}
+
Parameters

findFreeWorker

findFreeWorker(): false | Worker
-
-
Inherit Doc
-
Returns false | Worker
-
Inherited from AbstractPool.findFreeWorker
-
- Defined in src/pools/abstract-pool.ts:199

getWorkerAverageTasksRunTime

getWorkerAverageTasksRunTime(worker: Worker): undefined | number
-
-
Inherit Doc
-
-
Parameters
-
- -
  worker: Worker
-
Returns undefined | number
-
Inherited from AbstractPool.getWorkerAverageTasksRunTime
-
- Defined in src/pools/abstract-pool.ts:171

getWorkerIndex

getWorkerIndex(worker: Worker): number
-
-
Inherit Doc
-
-
Parameters
-
- -
  worker: Worker
-
Returns number
-
Inherited from AbstractPool.getWorkerIndex
-
- Defined in src/pools/abstract-pool.ts:161

getWorkerRunningTasks

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

findFreeWorkerKey

getWorkerRunningTasks(worker: Worker): undefined | number
findFreeWorkerKey(): number
-
-
Inherit Doc
-
-
Parameters
-
- -
  worker: Worker
-
Returns undefined | number
-
Inherited from AbstractPool.getWorkerRunningTasks
-
- Defined in src/pools/abstract-pool.ts:166

initWorkerTasksUsage

initWorkerTasksUsage(worker: Worker): void
-
Initializes tasks usage statistics.
+
{@inheritDoc}

-
-
Parameters
-
- -
  worker: Worker
  -
  The worker.
  -
-
Returns void
-
Inherited from AbstractPool.initWorkerTasksUsage
-
- Defined in src/pools/abstract-pool.ts:470

`Protected` internalExecute

internalExecute(worker: Worker, messageId: number): Promise<Response>
-
-
Parameters
-
- -
  worker: Worker
- -
  messageId: number
-
Returns Promise<Response>
-
Inherited from AbstractPool.internalExecute
+
Returns number
+
Inherited from AbstractPool.findFreeWorkerKey
- Defined in src/pools/abstract-pool.ts:315

`Protected` internalGetBusyStatus

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

`Protected` internalBusy

internalGetBusyStatus(): boolean
internalBusy(): boolean
Returns boolean
-
Inherited from AbstractPool.internalGetBusyStatus
+
Inherited from AbstractPool.internalBusy
- Defined in src/pools/abstract-pool.ts:191

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

`Protected` isMain

isMain(): boolean
-
-
Inherit Doc
+
{@inheritDoc}
+

Returns boolean
Overrides AbstractPool.isMain
- Defined in src/pools/cluster/fixed.ts:60

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

registerWorkerMessageListener

registerWorkerMessageListener<Message>(worker: Worker, listener: ((message: MessageValue<Message, unknown>) => void)): void
-
-
Inherit Doc
+
{@inheritDoc}
+
Type Parameters
+
Defined in src/pools/cluster/fixed.ts:80

`Protected` removeWorker

worker: Worker
-
Worker that will be removed.
+
The worker that will be removed.

Template

Template

Author

Since

Type Parameters

Data = unknown

Data = unknown

Response = unknown

Response = unknown

Hierarchy

Properties

Accessors

Methods

constructor

Optional opts: ClusterPoolOptions = {}

opts: ClusterPoolOptions = {}

Returns FixedClusterPool<Data, Response>

Properties

Optional Readonly emitter

Inherit Doc

Readonly filePath

Optional Readonly max

Inherit Doc

Protected nextMessageId

Readonly numberOfWorkers

Readonly opts

Protected promiseMap

Protected promiseResponseMap

Protected workerChoiceStrategyContext

Readonly workers

Inherit Doc

Readonly workersTasksUsage

Inherit Doc

Accessors

Inherit Doc

Returns boolean

numberOfRunningTasks

full

Returns boolean

Private numberOfRunningTasks

Inherit Doc

Returns number

type

Inherit Doc

Returns PoolType

Methods

Protected afterPromiseWorkerResponseHook

Protected afterPromiseResponseHook

Parameters

message: MessageValue<Response, unknown>

worker: Worker

promise: PromiseWorkerResponseWrapper<Worker, Response>

message: MessageValue<Response, unknown>

Returns void

Protected afterWorkerSetup

Inherit Doc

Parameters

Returns void

Protected beforePromiseWorkerResponseHook

Protected beforePromiseResponseHook

Parameters

worker: Worker

workerKey: number

Returns void

Protected chooseWorker

Returns

Returns

Returns Worker

Protected createAndSetupWorker

Returns Worker

Protected createWorker

Inherit Doc

Returns Worker

destroy

Inherit Doc

Returns Promise<void>

destroyWorker

Inherit Doc

Parameters

Returns void

`Optional` opts: ClusterPoolOptions = {}

`Optional` `Readonly` emitter

`Readonly` filePath

`Optional` `Readonly` max

`Protected` nextMessageId

`Readonly` numberOfWorkers

`Readonly` opts

`Protected` promiseMap

`Protected` promiseResponseMap

`Protected` workerChoiceStrategyContext

`Readonly` workers

`Readonly` workersTasksUsage

`Private` numberOfRunningTasks

`Protected` afterPromiseWorkerResponseHook

`Protected` afterPromiseResponseHook

`Protected` afterWorkerSetup

`Protected` beforePromiseWorkerResponseHook

`Protected` beforePromiseResponseHook

`Protected` chooseWorker

`Protected` createAndSetupWorker

`Protected` createWorker

`Protected` internalExecute

`Protected` internalGetBusyStatus

`Protected` internalBusy

`Protected` isMain

`Protected` removeWorker

`Protected` sendToWorker

`Protected` setupHook

`Protected` workerListener