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 execution response. 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

Emitter on which events can be listened to.

Events that can currently be listened to:

  • 'full': Emitted when the pool is dynamic and full.
  • 'busy': Emitted when the pool is busy.
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>[] = []

Pool worker nodes.

Accessors

  • get busy(): boolean
  • Whether the pool is busy or not.

    The pool busyness boolean status.

    Returns boolean

  • get full(): boolean
  • Whether the pool is full or not.

    The pool filling boolean status.

    Returns boolean

  • 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

  • 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: Worker

      The newly created worker.

    Returns void

  • Executes the function specified in the worker constructor with the task data input parameter.

    Returns

    Promise that will be fulfilled when the task is completed.

    Parameters

    • Optional data: Data

      The task input data for the specified worker function. This can only be serializable data.

    Returns Promise<Response>

  • Finds a free worker node key based on the number of tasks the worker has applied.

    If a worker is found with 0 running tasks, it is detected as free and its worker node key is returned.

    If no free worker is found, -1 is returned.

    Returns

    A worker node key if there is one, -1 otherwise.

    Returns number

  • Registers a listener callback on the given worker.

    Type Parameters

    • Message

    Parameters

    • worker: Worker

      The worker which should register a listener.

    • listener: ((message) => void)

      The message listener callback.

        • (message): void
        • Parameters

          Returns void

    Returns void

  • Sets the worker choice strategy in this pool.

    Parameters

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

      The worker choice strategy.

    • Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptions

      The worker choice strategy options.

    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) => void)

      • (message): 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

        Returns void

Generated using TypeDoc