Class DynamicClusterPool<Data, Response>

A cluster pool with a dynamic number of workers, but a guaranteed minimum number of workers.

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

Author

Christopher Quadflieg

Since

2.0.0

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

  • Constructs a new poolifier dynamic cluster pool.

    Type Parameters

    • Data = unknown

    • Response = unknown

    Parameters

    • min: number

      Minimum number of workers which are always active.

    • max: number

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

    • filePath: string

      Path to an implementation of a ClusterWorker file, which can be relative or absolute.

    • opts: ClusterPoolOptions = {}

      Options for this dynamic cluster pool.

    Returns DynamicClusterPool<Data, Response>

Properties

emitter?: PoolEmitter

Inherit Doc

filePath: string

Path to the worker-file.

max: number

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

numberOfWorkers: number

Number of workers that this pool should manage.

Options for this fixed cluster pool.

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

The execution response promise map.

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

workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>

Worker choice strategy context referencing a worker choice algorithm implementation.

Default to a round robin algorithm.

workerNodes: WorkerNode<Worker, 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

  • Hook executed after the worker task promise resolution. Can be overridden.

    Parameters

    • worker: Worker

      The worker.

    • message: MessageValue<Response, unknown>

      The received message.

    Returns void

  • Chooses a worker node for the next task.

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

    Returns

    [worker node key, worker node].

    Returns [number, WorkerNode<Worker, Data>]

  • Inherit Doc

    Type Parameters

    • Message

    Parameters

    • worker: Worker
    • listener: ((message: MessageValue<Message, unknown>) => void)
        • (message: MessageValue<Message, unknown>): void
        • Parameters

          • message: MessageValue<Message, unknown>

          Returns void

    Returns void

  • 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