Class FixedClusterPool<Data, Response>

A cluster pool with a fixed number of workers.

It is possible to perform tasks in sync or asynchronous mode as you prefer.

This pool selects the workers in a round robin fashion.

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

constructor

Properties

emitter? filePath numberOfWorkers opts promiseResponseMap workerChoiceStrategyContext workers

Accessors

busy full numberOfRunningTasks type

Methods

afterPromiseResponseHook afterWorkerSetup beforePromiseResponseHook chooseWorker createAndSetupWorker createWorker destroy destroyWorker execute findFreeWorkerKey internalBusy isMain registerWorkerMessageListener removeWorker sendToWorker setWorkerChoiceStrategy setupHook workerListener

Constructors

constructor

  • Constructs a new poolifier fixed cluster pool.

    Type Parameters

    • Data = unknown

    • Response = unknown

    Parameters

    • numberOfWorkers: number

      Number of workers for this pool.

    • filePath: string

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

    • opts: ClusterPoolOptions = {}

      Options for this fixed cluster pool.

    Returns FixedClusterPool<Data, Response>

Properties

Optional Readonly emitter

emitter?: PoolEmitter

{@inheritDoc}

Readonly filePath

filePath: string

Path to the worker-file.

Readonly numberOfWorkers

numberOfWorkers: number

Number of workers that this pool should manage.

Readonly opts

opts: ClusterPoolOptions = {}

Options for this fixed cluster pool.

Protected promiseResponseMap

promiseResponseMap: Map<string, PromiseResponseWrapper<Worker, 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.

Protected workerChoiceStrategyContext

workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>

Worker choice strategy context referencing a worker choice algorithm implementation.

Default to a round robin algorithm.

Readonly workers

workers: WorkerType<Worker>[] = []

{@inheritDoc}

Accessors

busy

full

Private numberOfRunningTasks

  • get numberOfRunningTasks(): number

  • Number of tasks concurrently running in the pool.

    Returns number

type

Methods

Protected afterPromiseResponseHook

  • 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

Protected afterWorkerSetup

  • {@inheritDoc}

    Parameters

    • worker: Worker

    Returns void

Protected beforePromiseResponseHook

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

    Parameters

    • workerKey: number

      The worker key.

    Returns void

Protected chooseWorker

  • Chooses a worker for the next task.

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

    Returns

    [worker key, worker].

    Returns [number, Worker]

Protected createAndSetupWorker

  • Creates a new worker for this pool and sets it up completely.

    Returns

    New, completely set up worker.

    Returns Worker

Protected createWorker

destroy

destroyWorker

  • {@inheritDoc}

    Parameters

    • worker: Worker

    Returns void

execute

  • {@inheritDoc}

    Parameters

    • data: Data

    Returns Promise<Response>

findFreeWorkerKey

Protected internalBusy

Protected isMain

registerWorkerMessageListener

  • {@inheritDoc}

    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

Protected removeWorker

  • Removes the given worker from the pool.

    Parameters

    • worker: Worker

      The worker that will be removed.

    Returns void

Protected sendToWorker

  • {@inheritDoc}

    Parameters

    • worker: Worker
    • message: MessageValue<Data, unknown>

    Returns void

setWorkerChoiceStrategy

  • {@inheritDoc}

    Parameters

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

    Returns void

Protected setupHook

Protected workerListener

  • 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

Settings

Member Visibility

Theme

Generated using TypeDoc