X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedThreadPool.html;h=e0337f6da7d7ce5d90ae9a370f853298812aa781;hb=812ad701baefad24cad2df8f9a60bf4d581d8697;hp=bdaa69dea6dba275b12ef200989632f54459b47b;hpb=ba92b02f642f229cb927ab526148f10107831471;p=poolifier.git diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index bdaa69de..e0337f6d 100644 --- a/docs/classes/FixedThreadPool.html +++ b/docs/classes/FixedThreadPool.html @@ -1,4 +1,4 @@ -FixedThreadPool | poolifier
+FixedThreadPool | poolifier
-
+
@@ -62,31 +62,31 @@ 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 @@ -97,7 +97,7 @@
-

Returns FixedThreadPool<Data, Response>

+
  • Defined in src/pools/thread/fixed.ts:40
  • Properties

    emitter?: PoolEmitter
    -

    {@inheritDoc}

    -
    +
  • Defined in src/pools/abstract-pool.ts:37
  • filePath: string
    @@ -144,7 +144,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:72
  • numberOfWorkers: number
    @@ -152,7 +152,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:71
  • @@ -160,37 +160,37 @@
    +
  • Defined in src/pools/abstract-pool.ts:73
  • -
    promiseResponseMap: Map<string, PromiseResponseWrapper<ThreadWorkerWithMessageChannel, Response>> = ...
    -

    The promise response map.

    +
    promiseResponseMap: Map<string, PromiseResponseWrapper<ThreadWorkerWithMessageChannel, 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:47
  • -
    workerChoiceStrategyContext: WorkerChoiceStrategyContext<ThreadWorkerWithMessageChannel, Data, Response>
    -

    Worker choice strategy instance implementing the worker choice algorithm.

    -

    Default to a strategy implementing a round robin algorithm.

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

    Worker choice strategy context referencing a worker choice algorithm implementation.

    +

    Default to a round robin algorithm.

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

    {@inheritDoc}

    -
    +
    + +
    workerNodes: WorkerNode<ThreadWorkerWithMessageChannel, Data>[] = []
    +
    +

    Inherit Doc

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

    @@ -198,53 +198,64 @@
    +
  • Defined in src/pools/thread/fixed.ts:105
  • +
  • Defined in src/pools/thread/fixed.ts:100
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:172
  • +
  • Defined in src/pools/thread/fixed.ts:95
  • Methods

    -
    - +
    +
      - +
    • -

      Hook executed after the worker task promise resolution. +

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

      @@ -255,20 +266,20 @@ 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:323
  • -
    - +
  • Defined in src/pools/thread/fixed.ts:85
  • +
    +
      - +
    • -

      Hook executed before the worker task promise resolution. +

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

      Parameters

      • -
        workerKey: number
        -

        The worker key.

        +
        workerNodeKey: number
        +

        The worker node key.

      Returns void

    -
    - +
  • Defined in src/pools/abstract-pool.ts:312
  • +
    +
    +
  • Defined in src/pools/abstract-pool.ts:356
  • +
  • Defined in src/pools/abstract-pool.ts:418
  • +
  • Defined in src/pools/thread/fixed.ts:78
  • +
  • Defined in src/pools/abstract-pool.ts:275
  • +
  • Defined in src/pools/thread/fixed.ts:54
  • +

    Returns Promise<Response>

    -
    - +
  • Defined in src/pools/abstract-pool.ts:244
  • +
    +
    +
  • Defined in src/pools/abstract-pool.ts:237
  • +
  • Defined in src/pools/abstract-pool.ts:232
  • +
  • Defined in src/pools/thread/fixed.ts:49
  • Returns void

    -
    - -
    +
  • Defined in src/pools/thread/fixed.ts:70
  • Returns void

    +
  • Defined in src/pools/thread/fixed.ts:62
  • +
  • Defined in src/pools/abstract-pool.ts:205
  • +
  • Defined in src/pools/abstract-pool.ts:297
  • - +
    +
    -
    +
  • constructor
  • +
  • emitter
  • +
  • filePath
  • +
  • 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