X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedClusterPool.html;h=7cb87fa3afc73f600a7b47574969cd6f8a735f81;hb=8d98e603c79d8d00b2b6a33e5f732701a7466234;hp=d626a13078bc4e47f2b438e7073fdcc85ca848df;hpb=21402562176f7550bcd9ba620cf551972fca6e98;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index d626a130..7cb87fa3 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -1,4 +1,4 @@ -FixedClusterPool | poolifier
+FixedClusterPool | 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:43
  • @@ -52,118 +52,129 @@

    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:54
  • Properties

    -
    +
    -
    emitter?: PoolEmitter
    -
    -

    Inherit Doc

    -
    - -
    filePath: string
    -

    Path to the worker-file.

    +
    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.
    • +
    • 'error': Emitted when an uncaught error occurs.
    • +
    • 'taskError': Emitted when an error occurs while executing a task.
    • +
    +
    +
    + +
    filePath: string
    +

    Path to the worker file.

    -
    - -
    numberOfWorkers: number
    +
  • Defined in src/pools/abstract-pool.ts:82
  • +
    + +
    numberOfWorkers: number

    Number of workers that this pool should manage.

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

    Options for this fixed cluster pool.

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

    The execution response promise map.

    • key: The message id of each submitted task.
    • @@ -171,366 +182,462 @@

    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:57
  • +
    -
    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    +
    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>

    Worker choice strategy context referencing a worker choice algorithm implementation.

    Default to a round robin algorithm.

    -
    +
  • Defined in src/pools/abstract-pool.ts:67
  • +
    -
    workerNodes: WorkerNode<Worker, Data>[] = []
    -
    -

    Inherit Doc

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

    -
    - -
    +
    + +
    • get full(): boolean
    • -
      -

      Inherit Doc

      +

      Whether the pool is full or not.

      +

      The pool filling boolean status.

      +

      Returns boolean

    -
    - -
    +
    + +
    +
    + +
      +
    • get maxSize(): number
    • -

      Number of tasks queued in the pool.

      +

      Pool maximum size.

      Returns number

    -
    - -
    +
    + +
      +
    • get minSize(): number
    • -

      Number of tasks running in the pool.

      +

      Pool minimum size.

      Returns number

    -
    - -
    +
    + +
      +
    • get type(): "fixed" | "dynamic"
    • -
      -

      Inherit Doc

      -

      Returns PoolType

    +
  • Defined in src/pools/cluster/fixed.ts:103
  • +
    + +
      +
    • get worker(): "cluster" | "thread"
    • +
    • +

      Gets the worker type.

      +
      +

      Returns "cluster" | "thread"

    Methods

    -
    - -
      - +
      + +
        +
      • -

        Hook executed after the worker task promise resolution. +

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

        Parameters

        • -
          worker: Worker
          +
          worker: Worker

          The worker.

        • -
          message: MessageValue<Response, unknown>
          +
          message: MessageValue<Response, Worker | MessagePort>

          The received message.

        Returns void

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

        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

      • -
        workerNodeKey: number
        +
        workerNodeKey: number

        The worker node key.

      Returns void

    -
    +
  • Defined in src/pools/abstract-pool.ts:453
  • +
    -
      - +
        +
      • 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].

        +

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

        -

        Returns [number, WorkerNode<Worker, Data>]

    -
    +
  • Defined in src/pools/abstract-pool.ts:532
  • +
    -
      - +
        +
      • Creates a new worker and sets it up completely in the pool worker nodes.

        - -

        Returns

        New, completely set up worker.

        -

        Returns Worker

    -
    +
  • Defined in src/pools/abstract-pool.ts:596
  • +
    -
    -
    +
  • Defined in src/pools/cluster/fixed.ts:92
  • +
    -
    +
    + +
    -
    - -
    +
    + +
      +
    • -
      -

      Inherit Doc

      +

      Enables/disables the worker tasks queue in this pool.

      +

      Parameters

      • -
        worker: Worker
      +
      enable: boolean
      +

      Whether to enable or disable the worker tasks queue.

      +
    • +
    • +
      Optional tasksQueueOptions: TasksQueueOptions
      +

      The worker tasks queue options.

      +

    Returns void

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

        Inherit Doc

        +

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

        +

        Parameters

        • -
          data: Data
        -

        Returns Promise<Response>

    -
    - -
      - -
    • -
      -

      Inherit Doc

      -

      Returns number

    • +
    • +
      Optional name: string
      +

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

      +
    +

    Returns Promise<Response>

    Promise that will be fulfilled when the task is completed.

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

    Parameters

    Returns void

    Returns void

    -
    +
  • Defined in src/pools/cluster/fixed.ts:84
  • +
    -
    +
    + +

    Returns void

    -
    +
  • Defined in src/pools/abstract-pool.ts:337
  • +
    -
    -
    +
  • Defined in src/pools/abstract-pool.ts:284
  • +
    + +
    +
    -
    -
    +
  • Defined in src/pools/cluster/fixed.ts:63
  • +
    -
    - +

    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
  • +
  • info
  • +
  • maxSize
  • +
  • minSize
  • +
  • type
  • +
  • worker
  • +
  • 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