Class FixedThreadPool<Data, Response>

A thread pool with a fixed number of threads.

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

This pool selects the threads in a round robin fashion.

Author

Alessandro Pio Ardizio

Since

0.0.1

Type Parameters

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.

Hierarchy

AbstractPool<ThreadWorkerWithMessageChannel, Data, Response>
- FixedThreadPool
  - DynamicThreadPool

Constructors

constructor

new FixedThreadPool<Data, Response>(numberOfThreads: number, filePath: string, opts?: PoolOptions<ThreadWorkerWithMessageChannel>): FixedThreadPool<Data, Response>
Constructs a new poolifier fixed thread pool.
Type Parameters
- Data = unknown
- Response = unknown
Parameters
- numberOfThreads: number
  
  Number of threads for this pool.
- filePath: string
  
  Path to an implementation of a ThreadWorker file, which can be relative or absolute.
- opts: PoolOptions<ThreadWorkerWithMessageChannel> = {}
  
  Options for this fixed thread pool.
Returns FixedThreadPool<Data, Response>
Overrides AbstractPool<ThreadWorkerWithMessageChannel, Data, Response>.constructor
- Defined in src/pools/thread/fixed.ts:40

Properties

`Optional` `Readonly` emitter

emitter?: PoolEmitter

{@inheritDoc}

`Readonly` filePath

filePath: string

Path to the worker-file.

`Readonly` numberOfWorkers

numberOfWorkers: number

Number of workers that this pool should manage.

`Readonly` opts

opts: PoolOptions<ThreadWorkerWithMessageChannel>

Options for the pool.

`Protected` promiseResponseMap

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

The promise response map.

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 with the promise resolve/reject bound to the message.

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

`Readonly` workers

workers: WorkerType<ThreadWorkerWithMessageChannel>[] = []

{@inheritDoc}

Accessors

busy

get busy(): boolean
{@inheritDoc}

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

numberOfRunningTasks

get numberOfRunningTasks(): number
{@inheritDoc}

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

type

get type(): PoolType
{@inheritDoc}

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

Methods

`Protected` afterPromiseResponseHook

afterPromiseResponseHook(worker: ThreadWorkerWithMessageChannel, message: MessageValue<Response, unknown>): void
Hook executed after the worker task promise resolution. Can be overridden.
Parameters
- worker: ThreadWorkerWithMessageChannel
  
  The worker.
- message: MessageValue<Response, unknown>
  
  The received message.
Returns void
Inherited from AbstractPool.afterPromiseResponseHook
- Defined in src/pools/abstract-pool.ts:253

`Protected` afterWorkerSetup

afterWorkerSetup(worker: ThreadWorkerWithMessageChannel): void
{@inheritDoc}
Parameters
- worker: ThreadWorkerWithMessageChannel
Returns void
Overrides AbstractPool.afterWorkerSetup
- Defined in src/pools/thread/fixed.ts:85

`Protected` beforePromiseResponseHook

beforePromiseResponseHook(workerKey: number): void
Hook executed before the worker task promise resolution. Can be overridden.
Parameters
- workerKey: number
  
  The worker key.
Returns void
Inherited from AbstractPool.beforePromiseResponseHook
- Defined in src/pools/abstract-pool.ts:242

`Protected` chooseWorker

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

The default implementation uses a round robin algorithm to distribute the load.

Returns
[worker key, worker].

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

`Protected` createAndSetupWorker

createAndSetupWorker(): ThreadWorkerWithMessageChannel
Creates a new worker for this pool and sets it up completely.

Returns
New, completely set up worker.

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

`Protected` createWorker

createWorker(): ThreadWorkerWithMessageChannel
{@inheritDoc}

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

destroy

destroy(): Promise<void>
{@inheritDoc}

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

destroyWorker

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

execute

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

findFreeWorkerKey

findFreeWorkerKey(): number | false
{@inheritDoc}

Returns number | false
Inherited from AbstractPool.findFreeWorkerKey
- Defined in src/pools/abstract-pool.ts:185

`Protected` internalGetBusyStatus

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

`Protected` isMain

isMain(): boolean
{@inheritDoc}

Returns boolean
Overrides AbstractPool.isMain
- Defined in src/pools/thread/fixed.ts:49

registerWorkerMessageListener

registerWorkerMessageListener<Message>(messageChannel: ThreadWorkerWithMessageChannel, listener: ((message: MessageValue<Message, unknown>) => void)): void
{@inheritDoc}
Type Parameters
- Message
Parameters
- messageChannel: ThreadWorkerWithMessageChannel
- listener: ((message: MessageValue<Message, unknown>) => void)
  - - (message: MessageValue<Message, unknown>): void
    - Parameters
      
      message: MessageValue<Message, unknown>
      
      Returns void
Returns void
Overrides AbstractPool.registerWorkerMessageListener
- Defined in src/pools/thread/fixed.ts:70

`Protected` removeWorker

removeWorker(worker: ThreadWorkerWithMessageChannel): void
Removes the given worker from the pool.
Parameters
- worker: ThreadWorkerWithMessageChannel
  
  The worker that will be removed.
Returns void
Inherited from AbstractPool.removeWorker
- Defined in src/pools/abstract-pool.ts:277

`Protected` sendToWorker

sendToWorker(worker: ThreadWorkerWithMessageChannel, message: MessageValue<Data, unknown>): void
{@inheritDoc}
Parameters
- worker: ThreadWorkerWithMessageChannel
- message: MessageValue<Data, unknown>
Returns void
Overrides AbstractPool.sendToWorker
- Defined in src/pools/thread/fixed.ts:62

setWorkerChoiceStrategy

setWorkerChoiceStrategy(workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"): void
{@inheritDoc}
Parameters
- workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
Returns void
Inherited from AbstractPool.setWorkerChoiceStrategy
- Defined in src/pools/abstract-pool.ts:156

`Protected` setupHook

setupHook(): void
Setup hook that can be overridden by a Poolifier pool implementation to run code before workers are created in the abstract constructor.

Returns void
Inherited from AbstractPool.setupHook
- Defined in src/pools/abstract-pool.ts:227

`Protected` workerListener

workerListener(): ((message: MessageValue<Response, unknown>) => void)
This function is the listener registered for each worker.

Returns
The listener function to execute when a message is received from a worker.

Returns ((message: MessageValue<Response, unknown>) => void)
- - (message: MessageValue<Response, unknown>): void
  - This function is the listener registered for each worker.
    
    Returns
    The listener function to execute when a message is received from a worker.
    Parameters
    - message: MessageValue<Response, unknown>
    Returns void
Inherited from AbstractPool.workerListener
- Defined in src/pools/abstract-pool.ts:364

Class FixedThreadPool<Data, Response>

Author

Since

Type Parameters

Data = unknown

Response = unknown

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Data = unknown

Response = unknown

Parameters

numberOfThreads: number

filePath: string

opts: PoolOptions<ThreadWorkerWithMessageChannel> = {}

Returns FixedThreadPool<Data, Response>

Properties

Optional Readonly emitter

Readonly filePath

Readonly numberOfWorkers

Readonly opts

Protected promiseResponseMap

Protected workerChoiceStrategyContext

Readonly workers

Accessors

busy

Returns boolean

numberOfRunningTasks

Returns number

type

Returns PoolType

Methods

Protected afterPromiseResponseHook

Parameters

worker: ThreadWorkerWithMessageChannel

message: MessageValue<Response, unknown>

Returns void

Protected afterWorkerSetup

Parameters

worker: ThreadWorkerWithMessageChannel

Returns void

Protected beforePromiseResponseHook

Parameters

workerKey: number

Returns void

Protected chooseWorker

Returns

Returns [number, ThreadWorkerWithMessageChannel]

Protected createAndSetupWorker

Returns

Returns ThreadWorkerWithMessageChannel

Protected createWorker

Returns ThreadWorkerWithMessageChannel

destroy

Returns Promise<void>

destroyWorker

Parameters

worker: ThreadWorkerWithMessageChannel

Returns Promise<void>

execute

Parameters

data: Data

Returns Promise<Response>

findFreeWorkerKey

Returns number | false

Protected internalGetBusyStatus

Returns boolean

Protected isMain

Returns boolean

registerWorkerMessageListener

Type Parameters

Message

Parameters

messageChannel: ThreadWorkerWithMessageChannel

`Optional` `Readonly` emitter

`Readonly` filePath

`Readonly` numberOfWorkers

`Readonly` opts

`Protected` promiseResponseMap

`Protected` workerChoiceStrategyContext

`Readonly` workers

`Protected` afterPromiseResponseHook

`Protected` afterWorkerSetup

`Protected` beforePromiseResponseHook

`Protected` chooseWorker

`Protected` createAndSetupWorker

`Protected` createWorker

`Protected` internalGetBusyStatus

`Protected` isMain

`Protected` removeWorker

`Protected` sendToWorker

`Protected` setupHook

`Protected` workerListener