FixedThreadPool | poolifier

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

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

This pool selects the threads 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

Alessandro Pio Ardizio

Since

0.0.1

@@ -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

DynamicThreadPool

Defined in src/pools/thread/fixed.ts:29

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

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: PoolOptions<ThreadWorkerWithMessageChannel>

`Protected` promiseMap

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

The promise map.

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

`Protected` promiseResponseMap

promiseResponseMap: Map<string, PromiseResponseWrapper<ThreadWorkerWithMessageChannel, 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<ThreadWorkerWithMessageChannel, Data, Response>

Worker choice strategy instance implementing the worker choice algorithm.

Default to a strategy implementing a round robin algorithm.

Worker choice strategy context referencing a worker choice algorithm implementation.

Default to a round robin algorithm.

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

`Readonly` workers

workers: ThreadWorkerWithMessageChannel[] = []

workers: WorkerType<ThreadWorkerWithMessageChannel>[] = []

Inherit Doc

`Readonly` workersTasksUsage

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

Inherit Doc

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

Accessors

@@ -226,18 +203,29 @@

Returns boolean

numberOfRunningTasks

get numberOfRunningTasks(): number
Defined in src/pools/thread/fixed.ts:105

full

get full(): boolean
Inherit Doc
+
Returns boolean
+
Overrides AbstractPool.full
+
- Defined in src/pools/thread/fixed.ts:100

`Private` numberOfRunningTasks

get numberOfRunningTasks(): number
+
Number of tasks concurrently running in the pool.
+

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

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

type

Returns PoolType

Defined in src/pools/thread/fixed.ts:95

Methods

`Protected` afterPromiseWorkerResponseHook

`Protected` afterPromiseResponseHook

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

Parameters
- -
  message: MessageValue<Response, unknown>
  -
  The received message.
  +
  worker: ThreadWorkerWithMessageChannel
  +
  The worker.
- -
  promise: PromiseWorkerResponseWrapper<ThreadWorkerWithMessageChannel, 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:281

`Protected` afterWorkerSetup

Returns void

`Protected` beforePromiseWorkerResponseHook

Defined in src/pools/thread/fixed.ts:85

`Protected` beforePromiseResponseHook

beforePromiseWorkerResponseHook(worker: ThreadWorkerWithMessageChannel): 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: ThreadWorkerWithMessageChannel
  -
  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:270

`Protected` chooseWorker

chooseWorker(): ThreadWorkerWithMessageChannel
chooseWorker(): [number, ThreadWorkerWithMessageChannel]
Chooses a worker for the next task.
-
The default implementation uses a round robin algorithm to distribute the load.
+
The default uses a round robin algorithm to distribute the load.
-
Returns
Worker.
+
Returns
[worker key, worker].

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

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

`Protected` createAndSetupWorker

Returns ThreadWorkerWithMessageChannel

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

`Protected` createWorker

Returns ThreadWorkerWithMessageChannel

Defined in src/pools/thread/fixed.ts:78

destroy

Returns Promise<void>

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

destroyWorker

Returns Promise<void>

Defined in src/pools/thread/fixed.ts:54

execute

Returns Promise<Response>

findFreeWorker

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

findFreeWorkerKey

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

getWorkerAverageTasksRunTime

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

getWorkerIndex

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

getWorkerRunningTasks

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

initWorkerTasksUsage

initWorkerTasksUsage(worker: ThreadWorkerWithMessageChannel): void
-
Initializes tasks usage statistics.
-
-
-
Parameters
-
- -
  worker: ThreadWorkerWithMessageChannel
  -
  The worker.
  -
-
Returns void
-
Inherited from AbstractPool.initWorkerTasksUsage
-
- Defined in src/pools/abstract-pool.ts:470

`Protected` internalExecute

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

`Protected` internalGetBusyStatus

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

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

`Protected` isMain

Returns boolean

Defined in src/pools/thread/fixed.ts:49

registerWorkerMessageListener

Returns void

Defined in src/pools/thread/fixed.ts:70

`Protected` removeWorker

Returns void

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

`Protected` sendToWorker

Returns void

Defined in src/pools/thread/fixed.ts:62

setWorkerChoiceStrategy

setWorkerChoiceStrategy(workerChoiceStrategy: "ROUND_ROBIN" | "LESS_RECENTLY_USED" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"): void
setWorkerChoiceStrategy(workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"): void
Inherit Doc
@@ -584,23 +490,24 @@ Can be overridden.

Parameters
- -
  workerChoiceStrategy: "ROUND_ROBIN" | "LESS_RECENTLY_USED" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"

Template

Template

Author

Since

Type Parameters

Data = unknown

Data = unknown

Response = unknown

Response = unknown

Hierarchy

Properties

Accessors

Methods

Returns FixedThreadPool<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

Returns boolean

numberOfRunningTasks

full

Inherit Doc

Returns boolean

Private numberOfRunningTasks

Returns number

type

Returns PoolType

Methods

Protected afterPromiseWorkerResponseHook

Protected afterPromiseResponseHook

Parameters

message: MessageValue<Response, unknown>

worker: ThreadWorkerWithMessageChannel

promise: PromiseWorkerResponseWrapper<ThreadWorkerWithMessageChannel, Response>

message: MessageValue<Response, unknown>

Returns void

Protected afterWorkerSetup

Returns void

Protected beforePromiseWorkerResponseHook

Protected beforePromiseResponseHook

Parameters

worker: ThreadWorkerWithMessageChannel

workerKey: number

Returns void

Protected chooseWorker

Returns

Returns

Returns ThreadWorkerWithMessageChannel

Protected createAndSetupWorker

Returns ThreadWorkerWithMessageChannel

Protected createWorker

Returns ThreadWorkerWithMessageChannel

destroy

Returns Promise<void>

destroyWorker

Returns Promise<void>

execute

Returns Promise<Response>

findFreeWorker

findFreeWorkerKey

Inherit Doc

Returns false | ThreadWorkerWithMessageChannel

getWorkerAverageTasksRunTime

Inherit Doc

Parameters

worker: ThreadWorkerWithMessageChannel

Returns undefined | number

`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