X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=dec90f6fe56e23902d9003daa955bd2a224459db;hb=b6fea09e6a8174e664770741943cf08445066e2b;hp=2fe2f7cd195f2bbd6499945eb63d4dad225ffc0c;hpb=c38a523624d95c0329fac3d0748883c361db9d93;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index 2fe2f7cd..dec90f6f 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -1,13 +1,13 @@ -AbstractPool | poolifier - v2.6.30
+AbstractPool | poolifier - v2.6.42
-
+
  • The search index is not available
  • poolifier - v2.6.42 +
    @@ -49,32 +49,33 @@
    • IPool<Worker, Data, Response>
    +
  • Defined in src/pools/abstract-pool.ts:59
  • - +

    Constructors

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

    @@ -195,18 +201,18 @@

    Events that can currently be listened to:

    • '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.
    • +
    • '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 >= pool maximum size^2).
    • +
    • '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:68
  • filePath: string
    @@ -214,7 +220,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:117
  • max?: number
    @@ -222,7 +228,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:93
  • numberOfWorkers: number
    @@ -230,7 +236,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:116
  • opts: PoolOptions<Worker>
    @@ -238,7 +244,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:118
  • promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
    @@ -251,7 +257,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:78
  • startTimestamp: number
    @@ -259,7 +265,15 @@
    +
  • Defined in src/pools/abstract-pool.ts:106
  • +
    + +
    started: boolean
    +

    Whether the pool is started or not.

    +
    +
    starting: boolean
    @@ -267,7 +281,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:98
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -275,7 +289,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:84
  • workerNodes: IWorkerNode<Worker, Data>[] = []
    @@ -284,7 +298,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:65
  • Accessors

    @@ -298,7 +312,7 @@

    Returns boolean

    +
  • Defined in src/pools/abstract-pool.ts:698
  • +
  • Defined in src/pools/abstract-pool.ts:689
  • +
  • Defined in src/pools/abstract-pool.ts:350
  • +
  • Defined in src/pools/abstract-pool.ts:562
  • +
  • Defined in src/pools/abstract-pool.ts:555
  • +
  • Defined in src/pools/abstract-pool.ts:507
  • +
  • Defined in src/pools/abstract-pool.ts:545
  • +
  • Defined in src/pools/abstract-pool.ts:524
  • +
  • Defined in src/pools/abstract-pool.ts:550
  • Methods

    @@ -414,7 +428,7 @@

    Throws

    https://nodejs.org/api/errors.html#class-error If the added worker node is not found.

    +
  • Defined in src/pools/abstract-pool.ts:1418
  • +
  • Defined in src/pools/abstract-pool.ts:888
  • +
  • Defined in src/pools/abstract-pool.ts:1162
  • +
  • Defined in src/pools/abstract-pool.ts:858
  • Returns TasksQueueOptions

    +
  • Defined in src/pools/abstract-pool.ts:672
  • +
  • Defined in src/pools/abstract-pool.ts:1393
  • +
  • Defined in src/pools/abstract-pool.ts:1381
  • +
  • Defined in src/pools/abstract-pool.ts:1387
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:187
  • Returns void

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

    +
  • Defined in src/pools/abstract-pool.ts:169
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:213
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:295
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:241
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:251
  • +
  • Defined in src/pools/abstract-pool.ts:1015
  • +
  • Defined in src/pools/abstract-pool.ts:1105
  • +
  • Defined in src/pools/abstract-pool.ts:1061
  • +
  • Defined in src/pools/abstract-pool.ts:1054
  • Returns undefined | Task<Data>

    +
  • Defined in src/pools/abstract-pool.ts:1483
  • +
  • Defined in src/pools/abstract-pool.ts:803
  • +
  • Defined in src/pools/abstract-pool.ts:834
  • +
  • Defined in src/pools/abstract-pool.ts:643
  • Returns number

    +
  • Defined in src/pools/abstract-pool.ts:1477
  • +
  • Defined in src/pools/abstract-pool.ts:747
  • +
  • Defined in src/pools/abstract-pool.ts:1471
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1491
  • +
  • Defined in src/pools/abstract-pool.ts:1501
  • +
  • Defined in src/pools/abstract-pool.ts:1407
  • +
  • Defined in src/pools/abstract-pool.ts:591
  • +
  • Defined in src/pools/abstract-pool.ts:603
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1353
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1339
  • +
  • Defined in src/pools/abstract-pool.ts:1456
  • +
  • Defined in src/pools/abstract-pool.ts:1449
  • +
  • Defined in src/pools/abstract-pool.ts:705
  • +
  • Defined in src/pools/abstract-pool.ts:849
  • +
  • Defined in src/pools/abstract-pool.ts:726
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1202
  • +
  • Defined in src/pools/abstract-pool.ts:1149
  • +
  • Defined in src/pools/abstract-pool.ts:1440
  • Returns Promise<void>

    +
  • Defined in src/pools/abstract-pool.ts:813
  • +
  • Defined in src/pools/abstract-pool.ts:1182
  • +
  • Defined in src/pools/abstract-pool.ts:1189
  • +
  • Defined in src/pools/abstract-pool.ts:1043
  • +
  • Defined in src/pools/abstract-pool.ts:655
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:610
  • +
  • Defined in src/pools/abstract-pool.ts:629
  • +
  • Defined in src/pools/abstract-pool.ts:842
  • +
  • Defined in src/pools/abstract-pool.ts:1032
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:921
  • +
  • Defined in src/pools/abstract-pool.ts:337
  • +
    + +

    Returns number

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

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:975
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:948
  • Returns void

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

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:962
  • +
  • Defined in src/pools/abstract-pool.ts:1321
  • @@ -1394,6 +1475,7 @@ Can be overridden.

  • opts
  • promiseResponseMap
  • startTimestamp
  • +
  • started
  • starting
  • workerChoiceStrategyContext
  • workerNodes
  • @@ -1453,81 +1535,48 @@ Can be overridden.

  • sendStatisticsMessageToWorker
  • sendToWorker
  • setTasksQueueOptions
  • +
  • setTasksQueueSize
  • setWorkerChoiceStrategy
  • setWorkerChoiceStrategyOptions
  • setupHook
  • shallCreateDynamicWorker
  • +
  • shallExecuteTask
  • shallUpdateTaskFunctionWorkerUsage
  • startPool
  • +
  • taskStealingOnEmptyQueue
  • tasksQueueSize
  • +
  • tasksStealingOnBackPressure
  • updateEluWorkerUsage
  • updateRunTimeWorkerUsage
  • updateTaskStatisticsWorkerUsage
  • +
  • updateTaskStolenStatisticsWorkerUsage
  • updateWaitTimeWorkerUsage
  • workerListener
  • +
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    +
    \ No newline at end of file