X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedClusterPool.html;h=04dfcd3e09e7f9352982ca3ff9d7a83820827bf3;hb=40baeb4e66efa6646d3221029cd012fb7bda8955;hp=297bbb751e4fad5b8275205b0b9509eb5eee4e30;hpb=74f29142ea20199700ef7021402616ea9de714a8;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index 297bbb75..04dfcd3e 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -44,7 +44,7 @@ +
  • Defined in src/pools/cluster/fixed.ts:39
    • @@ -74,28 +74,22 @@

    Methods

    -
    afterPromiseResponseHook +
    afterTaskExecutionHook afterWorkerSetup -beforePromiseResponseHook +beforeTaskExecutionHook chooseWorkerNode createAndSetupWorker createWorker -dequeueTask destroy destroyWorker -enqueueTask execute findFreeWorkerNodeKey -flushTasksQueue -flushTasksQueueByWorker internalBusy isMain registerWorkerMessageListener -removeWorkerNode sendToWorker setWorkerChoiceStrategy setupHook -tasksQueueLength workerListener
    @@ -132,7 +126,7 @@

    Returns FixedClusterPool<Data, Response>

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

    • Properties

    @@ -142,7 +136,7 @@

    Inherit Doc

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

    • Readonly filePath

    filePath: string
    @@ -150,7 +144,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:68

    • Readonly numberOfWorkers

    numberOfWorkers: number
    @@ -158,7 +152,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:67

    • Readonly opts

    opts: ClusterPoolOptions = {}
    @@ -166,20 +160,20 @@
    +
  • Defined in src/pools/cluster/fixed.ts:53

    • Protected promiseResponseMap

    promiseResponseMap: Map<string, PromiseResponseWrapper<Worker, Response>> = ...
    -

    The promise response map.

    +

    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:43

    • Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -188,7 +182,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:53

    • Readonly workerNodes

    workerNodes: WorkerNode<Worker, Data>[] = []
    @@ -196,7 +190,7 @@

    Inherit Doc

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

    • Accessors

    @@ -209,7 +203,7 @@

    Returns boolean

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

    • full

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

    • Private numberOfQueuedTasks

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

    • Private numberOfRunningTasks

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

    • type

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

    • Methods

    -
    -

    Protected afterPromiseResponseHook

    +
    +

    Protected afterTaskExecutionHook

      - +
    • -

      Hook executed after the worker task promise resolution. +

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

      @@ -276,9 +270,9 @@ Can be overridden.

      The received message.

    Returns void

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

    • Protected afterWorkerSetup

    -
    -

    Protected beforePromiseResponseHook

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

    Protected beforeTaskExecutionHook

    Returns void

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

    • Protected chooseWorkerNode

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

    -
    -

    Protected dequeueTask

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

    • destroy

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

    • destroyWorker

    -
    -

    Protected enqueueTask

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

    • execute

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

    • findFreeWorkerNodeKey

    -
    -

    Protected flushTasksQueue

    -
    -
    -

    Protected flushTasksQueueByWorker

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

    • Protected internalBusy

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

    • Protected isMain

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

    • registerWorkerMessageListener

    -
    -

    Protected removeWorkerNode

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

    • Protected sendToWorker

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

    • setWorkerChoiceStrategy

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

    • Protected setupHook

    -
    -

    Protected tasksQueueLength

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:422
    • @@ -661,28 +565,22 @@ Can be overridden.

  • numberOfQueuedTasks
  • numberOfRunningTasks
  • type
    • -
  • afterPromiseResponseHook
    • +
  • afterTaskExecutionHook
  • afterWorkerSetup
    • -
  • beforePromiseResponseHook
    • +
  • beforeTaskExecutionHook
  • chooseWorkerNode
  • createAndSetupWorker
  • createWorker
    • -
  • dequeueTask
  • destroy
  • destroyWorker
    • -
  • enqueueTask
  • execute
  • findFreeWorkerNodeKey
    • -
  • flushTasksQueue
    • -
  • flushTasksQueueByWorker
  • internalBusy
  • isMain
  • registerWorkerMessageListener
    • -
  • removeWorkerNode
  • sendToWorker
  • setWorkerChoiceStrategy
  • setupHook
    • -
  • tasksQueueLength
  • workerListener

    • Generated using TypeDoc