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 structured-cloneable data.

  • Response = unknown

    Type of execution response. This can only be structured-cloneable 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:

  • 'ready': Emitted when the number of workers created in the pool has reached the minimum size expected and are ready.
  • 'busy': Emitted when the number of workers created in the pool has reached the maximum size expected and are executing at least one task.
  • 'full': Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.
  • 'destroy': Emitted when the pool is destroyed.
  • 'error': Emitted when an uncaught error occurs.
  • 'taskError': Emitted when an error occurs while executing a task.
  • 'backPressure': Emitted when all worker nodes have back pressure (i.e. their tasks queue is full: queue size >= maximum queue size).
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<Response>> = ...

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

workerNodes: IWorkerNode<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 ready(): boolean
  • The pool readiness boolean status.

    Returns boolean

  • get type(): "fixed" | "dynamic"
  • The pool type.

    If it is 'dynamic', it provides the max property.

    Returns "fixed" | "dynamic"

  • get utilization(): number
  • The approximate pool utilization.

    Returns number

    The pool utilization.

  • get worker(): "thread" | "cluster"
  • The worker type.

    Returns "thread" | "cluster"

Methods

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

    Parameters

    • Optional data: Data

      The optional task input data for the specified task function. This can only be structured-cloneable data.

      Optional
    • Optional name: string

      The optional name of the task function to execute. If not specified, the default task function will be executed.

      Optional
    • Optional transferList: TransferListItem[]

      An optional array of transferable objects to transfer ownership of. Ownership of the transferred objects is given to the pool's worker_threads worker and they should not be used in the main thread afterwards.

      Optional

    Returns Promise<Response>

    Promise that will be fulfilled when the task is completed.

  • Internal

    Whether the worker node has back pressure (i.e. its tasks queue is full).

    Parameters

    • workerNodeKey: number

      The worker node key.

    Returns boolean

    true if the worker node has back pressure, false otherwise.

  • Registers a listener callback on the worker given its worker node key.

    Type Parameters

    • Message

    Parameters

    • workerNodeKey: number

      The worker node key.

    • 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" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"

      The worker choice strategy.

    • Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptions

      The worker choice strategy options.

      Optional

    Returns void

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

    Returns ((message) => void)

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

      • (message): void
      • This method is the listener registered for each worker message.

        Parameters

        Returns void

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

Generated using TypeDoc