X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=072c9da05dae4cb0411cc9c601675033feef32ac;hb=dd7f9381792ec728f9cd87ef7a0df6b2893db77e;hp=905e085b6ed963eb2e2a81ee9ea6fc6774756b6f;hpb=51e49c70379025e6709ae33e5cb4bf91b22ccc41;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index 905e085b..072c9da0 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -1,4 +1,4 @@ -AbstractPool | poolifier - v2.7.1
+AbstractPool | poolifier - v3.0.1
  • Preparing search index...
  • -
  • The search index is not available
poolifier - v2.7.1
+
  • The search index is not available
  • poolifier - v3.0.1

    Constructors

    @@ -201,13 +202,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 +224,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:74
  • filePath: string
    @@ -230,7 +232,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:129
  • max?: number
    @@ -238,7 +240,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:79
  • numberOfWorkers: number
    @@ -246,7 +248,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:128
  • opts: PoolOptions<Worker>
    @@ -254,7 +256,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:130
  • promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
    @@ -267,7 +269,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:88
  • startTimestamp: number
    @@ -275,7 +277,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:118
  • started: boolean
    @@ -283,7 +285,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:110
  • starting: boolean
    @@ -291,7 +293,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:114
  • taskFunctions: Map<string, TaskFunction<Data, Response>>
    @@ -303,7 +305,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:105
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -311,7 +313,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:94
  • workerNodes: IWorkerNode<Worker, Data>[] = []
    @@ -320,7 +322,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:71
  • Accessors

    @@ -334,7 +336,7 @@

    Returns boolean

    +
  • Defined in src/pools/abstract-pool.ts:671
  • +
  • Defined in src/pools/abstract-pool.ts:662
  • +
  • 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 +461,7 @@ If a task function with the same name already exists, it will be overwritten.

    +
  • Defined in src/pools/abstract-pool.ts:807
  • +
  • Defined in src/pools/abstract-pool.ts:1614
  • +
  • Defined in src/pools/abstract-pool.ts:1044
  • +
  • Defined in src/pools/abstract-pool.ts:1355
  • +
  • Defined in src/pools/abstract-pool.ts:1014
  • Returns TasksQueueOptions

    +
  • Defined in src/pools/abstract-pool.ts:601
  • +
  • Defined in src/pools/abstract-pool.ts:1589
  • +
  • Defined in src/pools/abstract-pool.ts:1577
  • +
  • Defined in src/pools/abstract-pool.ts:1583
  • +
  • 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:1171
  • +
  • Defined in src/pools/abstract-pool.ts:1261
  • +
  • Defined in src/pools/abstract-pool.ts:1217
  • +
  • Defined in src/pools/abstract-pool.ts:1210
  • Returns void

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

    +
  • Defined in src/pools/abstract-pool.ts:1679
  • +
  • Defined in src/pools/abstract-pool.ts:1342
  • +
  • Defined in src/pools/abstract-pool.ts:951
  • +
  • Defined in src/pools/abstract-pool.ts:990
  • +
  • Defined in src/pools/abstract-pool.ts:566
  • Returns number

    +
  • Defined in src/pools/abstract-pool.ts:1673
  • +
  • Defined in src/pools/abstract-pool.ts:881
  • +
  • Defined in src/pools/abstract-pool.ts:1667
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1687
  • +
  • Defined in src/pools/abstract-pool.ts:1697
  • +
  • Defined in src/pools/abstract-pool.ts:1603
  • +
  • Defined in src/pools/abstract-pool.ts:514
  • +
  • Defined in src/pools/abstract-pool.ts:526
  • +
    + +
    +
    + +

    Returns void

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

    +
  • Defined in src/pools/abstract-pool.ts:1533
  • +
  • Defined in src/pools/abstract-pool.ts:1652
  • +
  • Defined in src/pools/abstract-pool.ts:794
  • +
  • Defined in src/pools/abstract-pool.ts:1645
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:678
  • +
  • Defined in src/pools/abstract-pool.ts:1005
  • +
  • Defined in src/pools/abstract-pool.ts:846
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1405
  • +
  • Defined in src/pools/abstract-pool.ts:1329
  • +
  • Defined in src/pools/abstract-pool.ts:1316
  • +
  • Defined in src/pools/abstract-pool.ts:830
  • +
  • Defined in src/pools/abstract-pool.ts:1636
  • Returns Promise<void>

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

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

    +
  • Defined in src/pools/abstract-pool.ts:738
  • +
  • Defined in src/pools/abstract-pool.ts:1199
  • +
  • Defined in src/pools/abstract-pool.ts:859
  • +
  • Defined in src/pools/abstract-pool.ts:621
  • +
  • Defined in src/pools/abstract-pool.ts:580
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:615
  • +
  • Defined in src/pools/abstract-pool.ts:639
  • +
  • Defined in src/pools/abstract-pool.ts:533
  • +
  • Defined in src/pools/abstract-pool.ts:552
  • +
  • Defined in src/pools/abstract-pool.ts:998
  • +
  • Defined in src/pools/abstract-pool.ts:1188
  • Returns boolean

    +
  • Defined in src/pools/abstract-pool.ts:872
  • +
  • Defined in src/pools/abstract-pool.ts:1077
  • -
    - -
    +
  • Defined in src/pools/abstract-pool.ts:935
  • Returns number

    -
    - -
    +
  • Defined in src/pools/abstract-pool.ts:1683
  • +
  • Defined in src/pools/abstract-pool.ts:630
  • +
  • Defined in src/pools/abstract-pool.ts:648
  • Returns void

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

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

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

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

    -
    - +
  • Defined in src/pools/abstract-pool.ts:1118
  • +
    +
    +
  • Defined in src/pools/abstract-pool.ts:1517
  • @@ -1737,11 +1736,14 @@ Can be overridden.

  • getWorkerInfo
  • getWorkerNodeKeyByWorker
  • getWorkerNodeKeyByWorkerId
  • +
  • handleBackPressureEvent
  • +
  • handleEmptyQueueEvent
  • handleTaskExecutionResponse
  • handleWorkerReadyResponse
  • hasBackPressure
  • hasTaskFunction
  • hasWorkerNodeBackPressure
  • +
  • initializeEventEmitter
  • internalBusy
  • isMain
  • listTaskFunctionNames
  • @@ -1768,9 +1770,7 @@ Can be overridden.

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

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

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