X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedClusterPool.html;h=ac4cba8dad727ddb95933a043820c68f29850599;hb=70353024c44987c467dadcec306c699ce4ae1f06;hp=2076e589ebc674bd8efa60f795f3d55155a6273a;hpb=bfed591d93e26b1e424e916abdb27c6f91dc9b45;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index 2076e589..a7d98267 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -1,4 +1,4 @@ -FixedClusterPool | poolifier
+FixedClusterPool | poolifier
  • Preparing search index...
  • -
  • The search index is not available
poolifier
+
  • The search index is not available
  • poolifier
    -
    +
    -
    +

    Type Parameters

    -
      +
      • -

        Data = unknown

        +

        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.

        +

        Response = unknown

        +

        Type of execution response. This can only be serializable data.

    Hierarchy

    +
  • Defined in src/pools/cluster/fixed.ts:39
  • @@ -52,588 +52,579 @@

    Constructors

    -
    +
    -
      - +
        +
      • Constructs a new poolifier fixed cluster pool.

        -
        +

        Type Parameters

        -
          +
          • -

            Data = unknown

          • +

            Data = unknown

          • -

            Response = unknown

        +

        Response = unknown

    Parameters

    • -
      numberOfWorkers: number
      +
      numberOfWorkers: number

      Number of workers for this pool.

    • -
      filePath: string
      +
      filePath: string

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

    • -
      opts: ClusterPoolOptions = {}
      +
      opts: ClusterPoolOptions = {}

      Options for this fixed cluster pool.

    -

    Returns FixedClusterPool<Data, Response>

    +
  • Defined in src/pools/cluster/fixed.ts:50
  • Properties

    -
    +
    -
    emitter?: PoolEmitter
    -
    -

    Inherit Doc

    -
    +
  • 'full': Emitted when the pool is dynamic and full.
  • +
  • 'busy': Emitted when the pool is busy.
  • +
  • 'error': Emitted when an error occurs.
  • + +
    +
    -
    filePath: string
    -
    - -
    max?: number
    -
    -

    Inherit Doc

    -
    - -
    nextMessageId: number = 0
    -

    Id of the next message.

    +
    filePath: string
    +

    Path to the worker file.

    -
    +
  • Defined in src/pools/abstract-pool.ts:79
  • +
    -
    numberOfWorkers: number
    -
    +
  • Defined in src/pools/abstract-pool.ts:78
  • +
    -
    -
    - -
    promiseMap: Map<number, PromiseWorkerResponseWrapper<Worker, Response>> = ...
    -

    The promise map.

    +
  • Defined in src/pools/cluster/fixed.ts:53
  • +
    + +
    promiseResponseMap: Map<string, PromiseResponseWrapper<Worker, Response>> = ...
    +

    The execution response promise map.

      -
    • key: This is the message Id of each submitted task.
    • -
    • value: An object that contains the worker, the resolve function and the reject function.
    • +
    • 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 and resolve/reject the promise based on the message.

    +

    When we receive a message from the worker, we get a map entry with the promise resolve/reject bound to the message id.

    -
    +
  • Defined in src/pools/abstract-pool.ts:54
  • +
    -
    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    -

    Worker choice strategy instance implementing the worker choice algorithm.

    -

    Default to a strategy implementing a round robin algorithm.

    +
    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    +

    Worker choice strategy context referencing a worker choice algorithm implementation.

    +

    Default to a round robin algorithm.

    -
    - -
    workers: Worker[] = []
    -
    -

    Inherit Doc

    -
    - -
    workersTasksUsage: Map<Worker, TasksUsage> = ...
    -
    -

    Inherit Doc

    +

    Inherited from AbstractPool.workerChoiceStrategyContext

    + +
    + +
    workerNodes: WorkerNode<Worker, Data>[] = []
    +

    Pool worker nodes.

    +

    Accessors

    -
    - -
    +
    + +
      +
    • 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
    • -
      -

      Inherit Doc

      +

      Number of tasks running in the pool.

      +

      Returns number

    -
    +
  • Defined in src/pools/abstract-pool.ts:220
  • +
    + +
    +
    -
      -
    • get type(): PoolType
    • +
    +
  • Defined in src/pools/cluster/fixed.ts:99
  • Methods

    -
    - -
      - +
      + +
        +
      • -

        Hook executed after the worker task promise resolution. +

        Hook executed after the worker task execution. Can be overridden.

        Parameters

        • -
          message: MessageValue<Response, unknown>
          -

          The received message.

          +
          worker: Worker
          +

          The worker.

        • -
          promise: PromiseWorkerResponseWrapper<Worker, Response>
          -

          The Promise response.

          +
          message: MessageValue<Response, Worker | MessagePort>
          +

          The received message.

        Returns void

      -
      +
    • Defined in src/pools/abstract-pool.ts:430
    +
    -
      - +
        +
      • -
        -

        Inherit Doc

        +

        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
        +
        worker: Worker
        +

        The newly created worker.

        +

    Returns void

    -
    - -
    +
    + +
      +
    • -

      Hook executed before the worker task promise resolution. +

      Hook executed before the worker task execution. Can be overridden.

      Parameters

      • -
        worker: Worker
        -

        The worker.

        +
        workerNodeKey: number
        +

        The worker node key.

      Returns void

    -
    - -
    +
    + +
      +
    • -

      Chooses a worker for the next task.

      -

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

      - -

      Returns

      Worker.

      +

      Chooses a worker node for the next task.

      +

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

      -

      Returns Worker

    -
    +
  • Defined in src/pools/abstract-pool.ts:498
  • +
    -
      - +
        +
      • -

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

        - -

        Returns

        New, completely set up worker.

        +

        Creates a new worker and sets it up completely in the pool worker nodes.

        -

        Returns Worker

    -
    +
  • Defined in src/pools/abstract-pool.ts:561
  • +
    -
    -
    +
  • Defined in src/pools/cluster/fixed.ts:88
  • +
    -
      - +
    -
    - -
    +
    + +
      +
    • -
      -

      Inherit Doc

      +

      Shutdowns the given worker.

      +

      Parameters

      • -
        worker: Worker
      +
      worker: Worker
      +

      A worker within workerNodes.

      +

    Returns void

    -
    - -
    -
    - -
    -
    - -
    -
    - -
    -
    - -
    -
    - -
    +
    + +
    -
    - -
    +
    + +
    -
    - - +

    Returns Promise<Response>

    Promise that will be fulfilled when the task is completed.

    +
    +
    + +
    -
    +
  • Defined in src/pools/abstract-pool.ts:338
  • +
    -
    -
    - -
    +
    + +

    Parameters

    Returns void

    Returns void

    +
    + +
    -
    - -
    +
    + +
    -
    - -
    +
    + +

    Returns void

    -
    - -
    +
    + +

    Returns void

    -
    +
  • Defined in src/pools/abstract-pool.ts:283
  • +
    -
    -
    +
  • Defined in src/pools/cluster/fixed.ts:59
  • +
    -
    - +

    Returns void

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

    + +
    +
    +
    +

    On This Page

    - -
    +
  • constructor
  • +
  • emitter
  • +
  • filePath
  • +
  • numberOfWorkers
  • +
  • opts
  • +
  • promiseResponseMap
  • +
  • workerChoiceStrategyContext
  • +
  • workerNodes
  • +
  • busy
  • +
  • full
  • +
  • numberOfQueuedTasks
  • +
  • numberOfRunningTasks
  • +
  • size
  • +
  • type
  • +
  • afterTaskExecutionHook
  • +
  • afterWorkerSetup
  • +
  • beforeTaskExecutionHook
  • +
  • chooseWorkerNode
  • +
  • createAndSetupWorker
  • +
  • createWorker
  • +
  • destroy
  • +
  • destroyWorker
  • +
  • enableTasksQueue
  • +
  • execute
  • +
  • internalBusy
  • +
  • isMain
  • +
  • registerWorkerMessageListener
  • +
  • sendToWorker
  • +
  • setTasksQueueOptions
  • +
  • setWorkerChoiceStrategy
  • +
  • setWorkerChoiceStrategyOptions
  • +
  • setupHook
  • +
  • workerListener
  • + +

    Generated using TypeDoc

    -
    \ No newline at end of file +
    \ No newline at end of file