X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FDynamicClusterPool.html;h=2ade942cc1ea7b0e9fdd3cf7317abf0a95cd8522;hb=6c525543a7ed67a926b7c1f4bf98985aaad1f088;hp=adb3ab28e4f45c1b2df59f518299961e7f1b5319;hpb=94ab998f44abe7ed2184a0702c45621b06f5641f;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index adb3ab28..2ade942c 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -1,4 +1,4 @@ -DynamicClusterPool | poolifier
+DynamicClusterPool | poolifier
-
+
@@ -61,31 +61,31 @@ When the maximum number of workers is reached and workers are busy, an event is opts promiseResponseMap workerChoiceStrategyContext -workers +workerNodes

Accessors

Methods

-
afterPromiseResponseHook +
afterTaskExecutionHook afterWorkerSetup -beforePromiseResponseHook -chooseWorker +beforeTaskExecutionHook +chooseWorkerNode createAndSetupWorker createWorker destroy destroyWorker execute -findFreeWorkerKey +findFreeWorkerNodeKey internalBusy isMain registerWorkerMessageListener -removeWorker sendToWorker setWorkerChoiceStrategy setupHook @@ -96,7 +96,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    - +
  • Constructs a new poolifier dynamic cluster pool.

    @@ -126,20 +126,25 @@ When the maximum number of workers is reached and workers are busy, an event is
    opts: ClusterPoolOptions = {}

    Options for this dynamic cluster pool.

-

Returns DynamicClusterPool<Data, Response>

+
  • Defined in src/pools/cluster/dynamic.ts:28
  • Properties

    emitter?: PoolEmitter
    -
    -

    Inherit Doc

    +
  • Defined in src/pools/abstract-pool.ts:41
  • filePath: string
    @@ -147,14 +152,14 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:76
  • max: number

    Maximum number of workers that can be created by this pool.

    +
  • Defined in src/pools/cluster/dynamic.ts:30
  • numberOfWorkers: number
    @@ -162,7 +167,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:75
  • @@ -170,37 +175,37 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • 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:51
  • -
    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.

    -
    - -
    workers: WorkerType<Worker>[] = []
    -
    -

    Inherit Doc

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

    Pool worker nodes.

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

    @@ -208,53 +213,67 @@ When the maximum number of workers is reached and workers are busy, an event is
    • get busy(): boolean
    • -
      -

      Inherit Doc

      +

      Whether the pool is busy or not.

      +

      The pool busyness boolean status.

      +

      Returns boolean

    +
  • Defined in src/pools/cluster/dynamic.ts:48
  • +
  • Defined in src/pools/cluster/dynamic.ts:43
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:176
  • +
  • Defined in src/pools/cluster/dynamic.ts:38
  • Methods

    -
    - +
    +
      - +
    • -

      Hook executed after the worker task promise resolution. +

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

      @@ -265,140 +284,153 @@ 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:327
    • -
      -

      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
  • +
    +
    -
    - +
  • Defined in src/pools/abstract-pool.ts:316
  • +
    +
    +
  • Defined in src/pools/abstract-pool.ts:360
  • +
  • Defined in src/pools/abstract-pool.ts:422
  • +
  • Defined in src/pools/cluster/fixed.ts:88
  • +
  • Defined in src/pools/abstract-pool.ts:279
  • Returns void

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

    Returns Promise<Response>

    -
    - +
  • Defined in src/pools/abstract-pool.ts:248
  • +
    +
    +
  • Defined in src/pools/abstract-pool.ts:241
  • +
  • Defined in src/pools/abstract-pool.ts:236
  • +
  • Defined in src/pools/cluster/fixed.ts:64
  • -
    - -
    +
  • Defined in src/pools/cluster/fixed.ts:80
  • Returns void

    +
  • Defined in src/pools/cluster/fixed.ts:75
  • Returns void

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

    Generated using TypeDoc

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