X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedClusterPool.html;h=2955f106307ee1d2a91a2a866401ba734088a841;hb=761b0c73be0bf581f50a78123913f933bd405f52;hp=e1d8f60f59a2a08efcdf7e52ddbe801da25de458;hpb=1b0aa06b3ab5cf8ae8bd135087143165889901cc;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index e1d8f60f..2955f106 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -1,4 +1,4 @@ -FixedClusterPool | poolifier
+FixedClusterPool | poolifier
-
@@ -103,7 +100,7 @@
-

Returns FixedClusterPool<Data, Response>

Properties

emitter?: PoolEmitter
-
-

Inherit Doc

+
  • 'full': Emitted when the pool is dynamic and full.
  • +
  • 'busy': Emitted when the pool is busy.
  • + +
    filePath: string
    -

    Path to the worker-file.

    +

    Path to the worker file.

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

    Number of workers that this pool should manage.

    +
  • Defined in src/pools/abstract-pool.ts:76
  • Options for this fixed cluster pool.

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

    The promise response map.

    +
    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 promise resolve and reject callbacks.
    • +
    • 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.

    +

    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:52
  • -
    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:62
  • -
    workerNodes: WorkerNode<Worker, Data>[] = []
    -
    -

    Inherit Doc

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

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

      Inherit Doc

      +

      Whether the pool is full or not.

      +

      The pool filling boolean status.

      +

      Returns boolean

    +
  • Defined in src/pools/cluster/fixed.ts:104
  • +
  • Defined in src/pools/abstract-pool.ts:195
  • +
  • Defined in src/pools/abstract-pool.ts:185
  • +
  • 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.

      @@ -272,35 +277,38 @@ Can be overridden.

      The worker.

    • -
      message: MessageValue<Response, unknown>
      +
      message: MessageValue<Response, unknown>

      The received message.

    Returns void

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

      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

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

      Hook executed before the worker task promise resolution. +

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

      @@ -311,23 +319,23 @@ Can be overridden.

      The worker node key.

    Returns void

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

    Returns void

    -
    - -
    +
    + +

    Returns void

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

    Returns Promise<Response>

    +
  • Defined in src/pools/abstract-pool.ts:310
  • -
    - -
    -
    - -
    +
  • Defined in src/pools/abstract-pool.ts:303
  • +
  • Defined in src/pools/abstract-pool.ts:298
  • -
    - -
    +
    + +
    -
    - -
    +
    + +
    -
    - -
    +
    + +

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:266
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:218
  • +
    + +
    -
    - -
    +
  • Defined in src/pools/cluster/fixed.ts:59
  • - +
    +
    -
    +
  • constructor
  • +
  • emitter
  • +
  • filePath
  • +
  • numberOfWorkers
  • +
  • opts
  • +
  • promiseResponseMap
  • +
  • workerChoiceStrategyContext
  • +
  • workerNodes
  • +
  • busy
  • +
  • full
  • +
  • numberOfQueuedTasks
  • +
  • numberOfRunningTasks
  • +
  • type
  • +
  • afterTaskExecutionHook
  • +
  • afterWorkerSetup
  • +
  • beforeTaskExecutionHook
  • +
  • chooseWorkerNode
  • +
  • createAndSetupWorker
  • +
  • createWorker
  • +
  • destroy
  • +
  • destroyWorker
  • +
  • enableTasksQueue
  • +
  • execute
  • +
  • findFreeWorkerNodeKey
  • +
  • internalBusy
  • +
  • isMain
  • +
  • registerWorkerMessageListener
  • +
  • sendToWorker
  • +
  • setTasksQueueOptions
  • +
  • setWorkerChoiceStrategy
  • +
  • setWorkerChoiceStrategyOptions
  • +
  • setupHook
  • +
  • workerListener
  • + +

    Generated using TypeDoc

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