X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicThreadPool.html;h=f6495e279a204f5ba19c7dc378617f980e5bffea;hb=812ad701baefad24cad2df8f9a60bf4d581d8697;hp=ed6d4a8f3c416b5b31409288811c6536a70e6683;hpb=b10bb04924a5918496ff64a62ae71b9f99239b28;p=poolifier.git diff --git a/docs/classes/DynamicThreadPool.html b/docs/classes/DynamicThreadPool.html index ed6d4a8f..f6495e27 100644 --- a/docs/classes/DynamicThreadPool.html +++ b/docs/classes/DynamicThreadPool.html @@ -1,4 +1,4 @@ -DynamicThreadPool | poolifier
+DynamicThreadPool | poolifier
-
+
@@ -73,28 +73,22 @@ When the maximum number of threads is reached and workers are busy, an event is

Methods

-
@@ -102,7 +96,7 @@ When the maximum number of threads is reached and workers are busy, an event is
-

Returns DynamicThreadPool<Data, Response>

Properties

@@ -145,7 +139,7 @@ When the maximum number of threads is reached and workers are busy, an event is

Inherit Doc

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

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

    +
  • Defined in src/pools/thread/dynamic.ts:31
  • numberOfWorkers: number
    @@ -168,7 +162,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:71
  • @@ -176,37 +170,37 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • 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>
    +
    workerChoiceStrategyContext: WorkerChoiceStrategyContext<ThreadWorkerWithMessageChannel, 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:57
  • -
    workerNodes: WorkerNode<ThreadWorkerWithMessageChannel, Data>[] = []
    +
    workerNodes: WorkerNode<ThreadWorkerWithMessageChannel, Data>[] = []

    Inherit Doc

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

    @@ -219,7 +213,7 @@ When the maximum number of threads is reached and workers are busy, an event is

    Returns boolean

    +
  • Defined in src/pools/thread/dynamic.ts:49
  • +
  • Defined in src/pools/thread/dynamic.ts:44
  • +
  • Defined in src/pools/abstract-pool.ts:182
  • +
  • Defined in src/pools/abstract-pool.ts:172
  • +
  • Defined in src/pools/thread/dynamic.ts:39
  • Methods

    -
    - +
    +
      - +
    • -

      Hook executed after the worker task promise resolution. +

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

      @@ -282,13 +276,13 @@ 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.

      @@ -321,23 +315,23 @@ Can be overridden.

      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
  • +
    message: MessageValue<Data, unknown>

    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
  • +
  • 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