X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicThreadPool.html;h=d76ec5385a66d793921a74fe6fcdc840dce9b97c;hb=cc35cd9cb7323e39c9f521cdd4fbf51d1d31bbdf;hp=3cedf527b9841924554d7817853abd1fac713386;hpb=1d9f69fa27366fd18f2600beeee89187306df22a;p=poolifier.git diff --git a/docs/classes/DynamicThreadPool.html b/docs/classes/DynamicThreadPool.html index 3cedf527..d76ec538 100644 --- a/docs/classes/DynamicThreadPool.html +++ b/docs/classes/DynamicThreadPool.html @@ -1,4 +1,4 @@ -DynamicThreadPool | poolifier - v2.6.25
+DynamicThreadPool | poolifier - v2.6.40
  • Preparing search index...
  • -
  • The search index is not available
poolifier - v2.6.25
+
  • The search index is not available
  • poolifier - v2.6.40
    @@ -45,7 +45,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    • DynamicThreadPool
    +
  • Defined in src/pools/thread/dynamic.ts:15
  • @@ -59,7 +59,7 @@ When the maximum number of threads is reached and workers are busy, an event is

    Properties

    emitter? filePath -max +max numberOfWorkers opts promiseResponseMap @@ -71,7 +71,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    busy full info -maxSize +maxSize minSize ready type @@ -93,9 +93,12 @@ When the maximum number of threads is reached and workers are busy, an event is execute flushTasksQueue getWorkerInfo +hasWorkerNodeBackPressure internalBusy isMain +listTaskFunctions registerWorkerMessageListener +sendKillMessageToWorker sendStartupMessageToWorker sendToWorker setTasksQueueOptions @@ -126,28 +129,24 @@ When the maximum number of threads is reached and workers are busy, an event is
  • min: number

    Minimum number of threads which are always active.

    -
    -
  • +
  • max: number

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

    -
    -
  • +
  • filePath: string

    Path to an implementation of a ThreadWorker file, which can be relative or absolute.

    -
    -
  • +
  • opts: ThreadPoolOptions = {}

    Options for this dynamic thread pool.

    -
    -
  • +

    Returns DynamicThreadPool<Data, Response>

    +
  • Defined in src/pools/thread/dynamic.ts:27
  • Properties

    @@ -156,17 +155,19 @@ When the maximum number of threads is reached and workers are busy, an event is

    Emitter on which events can be listened to.

    Events that can currently be listened to:

      -
    • 'full': Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.
    • 'ready': Emitted when the number of workers created in the pool has reached the minimum size expected and are ready.
    • -
    • 'busy': Emitted when the number of workers created in the pool has reached the maximum size expected and are executing at least one task.
    • +
    • 'busy': Emitted when the number of workers created in the pool has reached the maximum size expected and are executing concurrently their tasks quota.
    • +
    • 'full': Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.
    • +
    • 'destroy': Emitted when the pool is destroyed.
    • 'error': Emitted when an uncaught error occurs.
    • 'taskError': Emitted when an error occurs while executing a task.
    • +
    • 'backPressure': Emitted when all worker nodes have back pressure (i.e. their tasks queue is full: queue size >= maximum queue size).
    +
  • Defined in src/pools/abstract-pool.ts:66
  • filePath: string
    @@ -175,15 +176,16 @@ When the maximum number of threads is reached and workers are busy, an event is
    -
    +
  • Defined in src/pools/abstract-pool.ts:115
  • +
    max: number

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

    +
  • Defined in src/pools/thread/dynamic.ts:29
  • numberOfWorkers: number
    @@ -192,7 +194,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:114
  • @@ -201,7 +203,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/thread/fixed.ts:49
  • promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
    @@ -215,7 +217,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:76
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -224,16 +226,16 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:82
  • - +
    workerNodes: IWorkerNode<Worker, Data>[] = []

    Pool worker nodes.

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

    @@ -248,7 +250,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/thread/dynamic.ts:43
  • +
  • Defined in src/pools/abstract-pool.ts:687
  • -
    +
  • Defined in src/pools/abstract-pool.ts:348
  • +
    -
    +
  • Defined in src/pools/abstract-pool.ts:560
  • +
  • Defined in src/pools/abstract-pool.ts:553
  • +
  • Defined in src/pools/abstract-pool.ts:505
  • +
  • Defined in src/pools/thread/dynamic.ts:38
  • +
  • Defined in src/pools/abstract-pool.ts:522
  • +
  • Defined in src/pools/thread/fixed.ts:130
  • Methods

    @@ -364,18 +366,16 @@ Can be overridden.

  • workerNodeKey: number

    The worker node key.

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

    The received message.

    -
    -
  • +

    Returns void

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

    Returns void

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

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:856
  • +
  • Defined in src/pools/abstract-pool.ts:185
  • +
  • Defined in src/pools/abstract-pool.ts:1103
  • +
  • Defined in src/pools/abstract-pool.ts:1059
  • +
  • Defined in src/pools/thread/fixed.ts:117
  • +
  • Defined in src/pools/abstract-pool.ts:801
  • +

    Returns Promise<void>

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

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

    Returns Promise<Response>

    Promise that will be fulfilled when the task is completed.

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

    Returns WorkerInfo

    The worker information.

    + +

    Returns undefined | WorkerInfo

    The worker information.

    +
  • Defined in src/pools/abstract-pool.ts:1417
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:703
  • +
  • Defined in src/pools/thread/fixed.ts:55
  • +
    + +
    +
  • Defined in src/pools/thread/fixed.ts:107
  • +
    + +
    +

    Returns void

    +
  • Defined in src/pools/thread/fixed.ts:91
  • +Optional

    Returns void

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

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

    Returns void

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

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:627
  • +
  • Defined in src/pools/abstract-pool.ts:840
  • +
  • Defined in src/pools/abstract-pool.ts:1329
  • -

    Generated using TypeDoc

    +

    Generated using TypeDoc

    \ No newline at end of file