Class DynamicThreadPool<Data, Response>

A thread pool with a dynamic number of threads, but a guaranteed minimum number of threads.

This thread pool creates new threads when the others are busy, up to the maximum number of threads. When the maximum number of threads is reached, an event is emitted. If you want to listen to this event, use the pool's emitter.

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

Constructors

Properties

emitter?: PoolEmitter

Inherit Doc

filePath: string
max: number
nextMessageId: number = 0

Id of the next message.

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

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

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

workerChoiceStrategyContext: WorkerChoiceStrategyContext<ThreadWorkerWithMessageChannel, Data, Response>

Worker choice strategy instance implementing the worker choice algorithm.

Default to a strategy implementing a round robin algorithm.

Inherit Doc

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

Inherit Doc

Accessors

  • get numberOfRunningTasks(): number
  • Inherit Doc

    Returns number

Methods

  • Inherit Doc

    Parameters

    • workerChoiceStrategy: "ROUND_ROBIN" | "LESS_RECENTLY_USED" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"

    Returns 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

Generated using TypeDoc