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 and workers are busy, 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

Path to the worker-file.

max: number

Maximum number of threads that can be created by this pool.

numberOfWorkers: number

Number of workers that this pool should manage.

Options for the pool.

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.

workerChoiceStrategyContext: WorkerChoiceStrategyContext<ThreadWorkerWithMessageChannel, Data, Response>

Worker choice strategy context referencing a worker choice algorithm implementation.

Default to a round robin algorithm.

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

Inherit Doc

Accessors

  • get numberOfQueuedTasks(): number
  • Number of tasks queued in the pool.

    Returns number

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

    Returns number

Methods

  • Inherit Doc

    Parameters

    • workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"

    Returns void

  • This function is the listener registered for each worker message.

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

        Returns

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

        Parameters

        • message: MessageValue<Response, unknown>

        Returns void

Generated using TypeDoc