X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=614932c4077a7ef3a0b701b8ab427fe9e38fa650;hb=597775b270c345a9c4f31fe1903d00507902d36c;hp=2ce0d07325a0a5f99ba1c8f1ba85367e44201b45;hpb=2771e5dcac6411a9731c66730072fcc578ff701c;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index 2ce0d073..614932c4 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -1,4 +1,4 @@ -AbstractPool | poolifier - v2.7.2
+AbstractPool | poolifier - v3.0.3
  • Preparing search index...
  • -
  • The search index is not available
poolifier - v2.7.2
+
  • The search index is not available
  • poolifier - v3.0.3

    Constructors

    @@ -201,13 +203,14 @@

    Returns AbstractPool<Worker, Data, Response>

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

    - -
    emitter?: PoolEmitter
    -

    Emitter on which events can be listened to.

    + +
    emitter?: EventEmitterAsyncResource
    +

    Event emitter integrated with async resource on which events can be listened to. +The async tracking tooling identifier is poolifier:<PoolType>-<WorkerType>-pool.

    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.
    • @@ -222,7 +225,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:74
  • filePath: string
    @@ -230,7 +233,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:129
  • max?: number
    @@ -238,7 +241,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:79
  • numberOfWorkers: number
    @@ -246,7 +249,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:128
  • opts: PoolOptions<Worker>
    @@ -254,7 +257,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:130
  • promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
    @@ -267,7 +270,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:88
  • startTimestamp: number
    @@ -275,7 +278,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:118
  • started: boolean
    @@ -283,7 +286,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:110
  • starting: boolean
    @@ -291,7 +294,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:114
  • taskFunctions: Map<string, TaskFunction<Data, Response>>
    @@ -303,7 +306,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:105
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -311,7 +314,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:94
  • workerNodes: IWorkerNode<Worker, Data>[] = []
    @@ -320,7 +323,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:71
  • Accessors

    @@ -334,7 +337,7 @@

    Returns boolean

    +
  • Defined in src/pools/abstract-pool.ts:668
  • +
  • Defined in src/pools/abstract-pool.ts:659
  • +
  • Defined in src/pools/abstract-pool.ts:272
  • +
  • Defined in src/pools/abstract-pool.ts:485
  • +
  • Defined in src/pools/abstract-pool.ts:478
  • +
  • Defined in src/pools/abstract-pool.ts:430
  • +
  • Defined in src/pools/abstract-pool.ts:468
  • +
  • Defined in src/pools/abstract-pool.ts:447
  • +
  • Defined in src/pools/abstract-pool.ts:473
  • Methods

    @@ -459,7 +462,7 @@ If a task function with the same name already exists, it will be overwritten.

    +
  • Defined in src/pools/abstract-pool.ts:804
  • +
  • Defined in src/pools/abstract-pool.ts:1613
  • +
  • Defined in src/pools/abstract-pool.ts:1041
  • +
  • Defined in src/pools/abstract-pool.ts:1354
  • +
  • Defined in src/pools/abstract-pool.ts:1011
  • Returns TasksQueueOptions

    +
  • Defined in src/pools/abstract-pool.ts:598
  • +
  • Defined in src/pools/abstract-pool.ts:1588
  • +
  • Defined in src/pools/abstract-pool.ts:1576
  • +
  • Defined in src/pools/abstract-pool.ts:1582
  • +
  • Defined in src/pools/abstract-pool.ts:495
  • Returns void

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

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

    +
  • Defined in src/pools/abstract-pool.ts:218
  • +
  • Defined in src/pools/abstract-pool.ts:1168
  • +
  • Defined in src/pools/abstract-pool.ts:1258
  • +
  • Defined in src/pools/abstract-pool.ts:1214
  • +
  • Defined in src/pools/abstract-pool.ts:1207
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:863
  • Returns undefined | Task<Data>

    +
  • Defined in src/pools/abstract-pool.ts:1682
  • +
  • Defined in src/pools/abstract-pool.ts:1341
  • +
  • Defined in src/pools/abstract-pool.ts:948
  • +
  • Defined in src/pools/abstract-pool.ts:987
  • +
  • Defined in src/pools/abstract-pool.ts:563
  • Returns number

    +
  • Defined in src/pools/abstract-pool.ts:1676
  • +
  • Defined in src/pools/abstract-pool.ts:878
  • +
  • Defined in src/pools/abstract-pool.ts:1670
  • +
    + +

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1690
  • +
  • Defined in src/pools/abstract-pool.ts:1700
  • +
  • Defined in src/pools/abstract-pool.ts:1602
  • +
  • Defined in src/pools/abstract-pool.ts:511
  • +
  • Defined in src/pools/abstract-pool.ts:523
  • +
    + +
    +
    + +

    Returns void

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

    +
  • Defined in src/pools/abstract-pool.ts:1532
  • +
  • Defined in src/pools/abstract-pool.ts:1655
  • +
  • Defined in src/pools/abstract-pool.ts:791
  • +
  • Defined in src/pools/abstract-pool.ts:1648
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:675
  • +
  • Defined in src/pools/abstract-pool.ts:1002
  • +
  • Defined in src/pools/abstract-pool.ts:843
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1404
  • +
  • Defined in src/pools/abstract-pool.ts:1328
  • +
  • Defined in src/pools/abstract-pool.ts:1315
  • +
  • Defined in src/pools/abstract-pool.ts:827
  • +
  • Defined in src/pools/abstract-pool.ts:1635
  • Returns Promise<void>

    +
  • Defined in src/pools/abstract-pool.ts:959
  • +
  • Defined in src/pools/abstract-pool.ts:1385
  • +
  • Defined in src/pools/abstract-pool.ts:1392
  • Returns Promise<boolean>

    +
  • Defined in src/pools/abstract-pool.ts:694
  • Returns Promise<boolean>

    +
  • Defined in src/pools/abstract-pool.ts:735
  • +
  • Defined in src/pools/abstract-pool.ts:1196
  • +
  • Defined in src/pools/abstract-pool.ts:856
  • +
  • Defined in src/pools/abstract-pool.ts:618
  • +
  • Defined in src/pools/abstract-pool.ts:577
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:612
  • +
  • Defined in src/pools/abstract-pool.ts:636
  • +
  • Defined in src/pools/abstract-pool.ts:530
  • +
  • Defined in src/pools/abstract-pool.ts:549
  • +
  • Defined in src/pools/abstract-pool.ts:995
  • +
  • Defined in src/pools/abstract-pool.ts:1185
  • Returns boolean

    +
  • Defined in src/pools/abstract-pool.ts:869
  • +
  • Defined in src/pools/abstract-pool.ts:1074
  • -
    - -
    +
  • Defined in src/pools/abstract-pool.ts:932
  • Returns number

    -
    - -
    +
  • Defined in src/pools/abstract-pool.ts:1686
  • +
  • Defined in src/pools/abstract-pool.ts:627
  • +
  • Defined in src/pools/abstract-pool.ts:645
  • Returns void

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

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

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

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

    -
    - +
  • Defined in src/pools/abstract-pool.ts:1115
  • +
    +
    +
  • Defined in src/pools/abstract-pool.ts:1516
  • @@ -1732,16 +1745,20 @@ Can be overridden.

  • enqueueTask
  • execute
  • executeTask
  • +
  • flagWorkerNodeAsNotReady
  • flushTasksQueue
  • flushTasksQueues
  • getWorkerInfo
  • getWorkerNodeKeyByWorker
  • getWorkerNodeKeyByWorkerId
  • +
  • handleBackPressureEvent
  • +
  • handleEmptyQueueEvent
  • handleTaskExecutionResponse
  • handleWorkerReadyResponse
  • hasBackPressure
  • hasTaskFunction
  • hasWorkerNodeBackPressure
  • +
  • initializeEventEmitter
  • internalBusy
  • isMain
  • listTaskFunctionNames
  • @@ -1768,9 +1785,7 @@ Can be overridden.

  • shallExecuteTask
  • shallUpdateTaskFunctionWorkerUsage
  • start
  • -
  • taskStealingOnEmptyQueue
  • tasksQueueSize
  • -
  • tasksStealingOnBackPressure
  • unsetTaskStealing
  • unsetTasksStealingOnBackPressure
  • updateEluWorkerUsage
  • @@ -1778,9 +1793,9 @@ Can be overridden.

  • updateTaskStatisticsWorkerUsage
  • updateTaskStolenStatisticsWorkerUsage
  • updateWaitTimeWorkerUsage
  • -
  • workerListener
  • +
  • workerMessageListener
  • Generated using TypeDoc

    -
    \ No newline at end of file +
    \ No newline at end of file