FixedThreadPool | poolifier

@@ -52,56 +52,54 @@

Constructors

Properties

emitter? -filePath -nextMessageId -numberOfWorkers -opts -promiseMap -workerChoiceStrategyContext -workers -workersTasksUsage +

emitter? +filePath +numberOfWorkers +opts +promiseResponseMap +workerChoiceStrategyContext +workerNodes

Accessors

busy -numberOfRunningTasks -type +

busy +full +numberOfQueuedTasks +numberOfRunningTasks +type

Constructors

constructor

new FixedThreadPool<Data, Response>(numberOfThreads: number, filePath: string, opts?: PoolOptions<ThreadWorkerWithMessageChannel>): FixedThreadPool<Data, Response>

new FixedThreadPool<Data, Response>(numberOfThreads, filePath, opts?): FixedThreadPool<Data, Response>
Constructs a new poolifier fixed thread pool.

@@ -109,477 +107,495 @@
Type Parameters
- -
  Data = unknown
- -
  Response = unknown

Response = unknown

Parameters

-
numberOfThreads: number
+
numberOfThreads: number

Number of threads for this pool.
-
filePath: string
+
filePath: string

Path to an implementation of a ThreadWorker file, which can be relative or absolute.
-
opts: PoolOptions<ThreadWorkerWithMessageChannel> = {}
+
opts: PoolOptions<ThreadWorkerWithMessageChannel> = {}

Options for this fixed thread pool.

Returns FixedThreadPool<Data, Response>

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

Properties

`Optional` `Readonly` emitter

emitter?: PoolEmitter

{@inheritDoc}

`Readonly` filePath

filePath: string

Path to the worker-file.

'full': Emitted when the pool is dynamic and full.

'busy': Emitted when the pool is busy.

`Protected` nextMessageId

nextMessageId: number = 0

Id of the next message.

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

`Readonly` filePath

filePath: string

Path to the worker file.

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

`Readonly` numberOfWorkers

numberOfWorkers: number

Number of workers that this pool should manage.

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

`Readonly` opts

opts: PoolOptions<ThreadWorkerWithMessageChannel>

Options for the pool.

`Protected` promiseMap

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

The promise map.

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

`Protected` promiseResponseMap

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

The execution response promise 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 execution response 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 id.

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

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

workerChoiceStrategyContext: WorkerChoiceStrategyContext<ThreadWorkerWithMessageChannel, Data, Response>

Worker choice strategy context referencing a worker choice algorithm implementation.

Default to a round robin algorithm.

`Readonly` workers

workers: ThreadWorkerWithMessageChannel[] = []

{@inheritDoc}

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

`Readonly` workerNodes

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

Pool worker nodes.

`Readonly` workersTasksUsage

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

{@inheritDoc}

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

Accessors

busy

`Protected` busy

get busy(): boolean
-
{@inheritDoc}
+
Whether the pool is busy or not.
+
The pool busyness boolean status.

Returns boolean
Overrides AbstractPool.busy
- Defined in src/pools/thread/fixed.ts:95

numberOfRunningTasks

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

`Protected` full

get full(): boolean
+
Whether the pool is full or not.
+
The pool filling boolean status.
+
+
Returns boolean
+
Overrides AbstractPool.full
+
- Defined in src/pools/thread/fixed.ts:100

`Private` numberOfQueuedTasks

get numberOfQueuedTasks(): number
+
Number of tasks queued in the pool.
+
+
Returns number
+
Inherited from AbstractPool.numberOfQueuedTasks
+
- Defined in src/pools/abstract-pool.ts:195

`Private` numberOfRunningTasks

get numberOfRunningTasks(): number
-
{@inheritDoc}
+
Number of tasks running in the pool.

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

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

type

get type(): PoolType

get type(): PoolType
-
{@inheritDoc}
+
Pool type.
+
If it is 'dynamic', it provides the max property.

-
Returns PoolType
+
Returns PoolType
Overrides AbstractPool.type
- Defined in src/pools/thread/fixed.ts:90

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

Methods

`Protected` afterPromiseWorkerResponseHook

afterPromiseWorkerResponseHook(message: MessageValue<Response, unknown>, promise: PromiseWorkerResponseWrapper<ThreadWorkerWithMessageChannel, Response>): void

`Protected` afterTaskExecutionHook

afterTaskExecutionHook(worker, message): void
-
Hook executed after the worker task promise resolution. +
Hook executed after the worker task execution. 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.afterTaskExecutionHook
- Defined in src/pools/abstract-pool.ts:265

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

`Protected` afterWorkerSetup

afterWorkerSetup(worker: ThreadWorkerWithMessageChannel): void

afterWorkerSetup(worker): void
-
{@inheritDoc}
+
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: ThreadWorkerWithMessageChannel
+
worker: ThreadWorkerWithMessageChannel
+
The newly created worker.
+

Returns void

`Protected` beforePromiseWorkerResponseHook

beforePromiseWorkerResponseHook(worker: ThreadWorkerWithMessageChannel): void
Defined in src/pools/thread/fixed.ts:85

`Protected` beforeTaskExecutionHook

beforeTaskExecutionHook(workerNodeKey): void
-
Hook executed before the worker task promise resolution. +
Hook executed before the worker task execution. Can be overridden.
Parameters
- -
  worker: ThreadWorkerWithMessageChannel
  -
  The worker.
  +
  workerNodeKey: number
  +
  The worker node key.
Returns void
-
Inherited from AbstractPool.beforePromiseWorkerResponseHook
+
Inherited from AbstractPool.beforeTaskExecutionHook
- Defined in src/pools/abstract-pool.ts:254

`Protected` chooseWorker

chooseWorker(): ThreadWorkerWithMessageChannel
Defined in src/pools/abstract-pool.ts:375

`Protected` chooseWorkerNode

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

-
Returns ThreadWorkerWithMessageChannel
-
Inherited from AbstractPool.chooseWorker
+
Returns [number, WorkerNode<ThreadWorkerWithMessageChannel, Data>]
+
Inherited from AbstractPool.chooseWorkerNode
- Defined in src/pools/abstract-pool.ts:292

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

`Protected` createAndSetupWorker

createAndSetupWorker(): ThreadWorkerWithMessageChannel

createAndSetupWorker(): ThreadWorkerWithMessageChannel
-
Creates a new worker for this pool and sets it up completely.
+
Creates a new worker and sets it up completely in the pool worker nodes.

Returns
New, completely set up worker.

-
Returns ThreadWorkerWithMessageChannel
-
Inherited from AbstractPool.createAndSetupWorker
+
Returns ThreadWorkerWithMessageChannel
+
Inherited from AbstractPool.createAndSetupWorker
- Defined in src/pools/abstract-pool.ts:336

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

`Protected` createWorker

createWorker(): ThreadWorkerWithMessageChannel

createWorker(): ThreadWorkerWithMessageChannel
-
{@inheritDoc}
+
Returns a newly created worker.

-
Returns ThreadWorkerWithMessageChannel
-
Overrides AbstractPool.createWorker
+
Returns ThreadWorkerWithMessageChannel
+
Overrides AbstractPool.createWorker
- Defined in src/pools/thread/fixed.ts:73

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

destroy

destroy(): Promise<void>

destroy(): Promise<void>
-
{@inheritDoc}
+
Shutdowns every current worker in this pool.

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

destroyWorker

destroyWorker(worker: ThreadWorkerWithMessageChannel): Promise<void>

Returns Promise<void>

`Protected` destroyWorker

destroyWorker(worker): Promise<void>
-
{@inheritDoc}
+
Shutdowns the given worker.
Parameters
- -
  worker: ThreadWorkerWithMessageChannel
-
Returns Promise<void>
-
Overrides AbstractPool.destroyWorker
-
- Defined in src/pools/thread/fixed.ts:49

execute

execute(data: Data): Promise<Response>
-
{@inheritDoc}
-
-
-
Parameters
-
- -
  data: Data
-
Returns Promise<Response>
-
Inherited from AbstractPool.execute
-
- Defined in src/pools/abstract-pool.ts:205

findFreeWorker

findFreeWorker(): false | ThreadWorkerWithMessageChannel
-
{@inheritDoc}
-
-
Returns false | ThreadWorkerWithMessageChannel
-
Inherited from AbstractPool.findFreeWorker
-
- Defined in src/pools/abstract-pool.ts:194

getWorkerAverageTasksRunTime

getWorkerAverageTasksRunTime(worker: ThreadWorkerWithMessageChannel): undefined | number

worker: ThreadWorkerWithMessageChannel

A worker within workerNodes.

Returns Promise<void>

enableTasksQueue

enableTasksQueue(enable, tasksQueueOptions?): void
-
{@inheritDoc}
+
Enables/disables the worker tasks queue in this pool.
Parameters
- -
  worker: ThreadWorkerWithMessageChannel
-
Returns undefined | number
-
Inherited from AbstractPool.getWorkerAverageTasksRunTime
-
- Defined in src/pools/abstract-pool.ts:166

getWorkerIndex

getWorkerIndex(worker: ThreadWorkerWithMessageChannel): number
-
{@inheritDoc}
-
-
-
Parameters
-
- -
  worker: ThreadWorkerWithMessageChannel
-
Returns number
-
Inherited from AbstractPool.getWorkerIndex
+
Optional tasksQueueOptions: TasksQueueOptions
+
The worker tasks queue options.
+

Response = unknown

Constructors

Properties

Accessors

Methods

Type Parameters

Data = unknown

Data = unknown

Response = unknown

numberOfThreads: number

numberOfThreads: number

filePath: string

filePath: string

opts: PoolOptions<ThreadWorkerWithMessageChannel> = {}

opts: PoolOptions<ThreadWorkerWithMessageChannel> = {}

Protected busy

Returns boolean

numberOfRunningTasks

Returns boolean

Returns number

Returns number

Returns PoolType

Protected afterTaskExecutionHook

Parameters

message: MessageValue<Response, unknown>

worker: ThreadWorkerWithMessageChannel

promise: PromiseWorkerResponseWrapper<ThreadWorkerWithMessageChannel, Response>

message: MessageValue<Response, unknown>

Returns void

Parameters

worker: ThreadWorkerWithMessageChannel

worker: ThreadWorkerWithMessageChannel

Parameters

worker: ThreadWorkerWithMessageChannel

workerNodeKey: number

Returns

Returns

Returns

Returns ThreadWorkerWithMessageChannel

Returns ThreadWorkerWithMessageChannel

Returns Promise<void>

Parameters

worker: ThreadWorkerWithMessageChannel

data: Data

worker: ThreadWorkerWithMessageChannel

worker: ThreadWorkerWithMessageChannel

worker: ThreadWorkerWithMessageChannel

Parameters

message: MessageValue<Message, unknown>

message: MessageValue<Message, unknown>

worker: ThreadWorkerWithMessageChannel

`Protected` busy

`Protected` afterTaskExecutionHook