X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=57019215eab51531af8a99c7d0f472ca09bc6c9b;hb=25926072f5397949802f6af5a2f7d49d6f15cacc;hp=e382e9e16e85fa1b4736e8df9cfd0842e9c02057;hpb=3eed67feea0f527e3ee31a6ebb1063883eec3855;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index e382e9e1..57019215 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -1,4 +1,4 @@ -AbstractPool | poolifier - v2.6.45
+AbstractPool | poolifier - v2.7.4
  • Preparing search index...
  • -
  • The search index is not available
poolifier - v2.6.45
+
  • The search index is not available
  • poolifier - v2.7.4
    @@ -87,7 +88,8 @@

    Methods

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

    - -
    emitter?: PoolEmitter
    -

    Emitter on which events can be listened to.

    + +
    emitter?: __module | 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.
    • @@ -216,7 +224,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:73
  • filePath: string
    @@ -224,7 +232,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:128
  • max?: number
    @@ -232,7 +240,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:97
  • numberOfWorkers: number
    @@ -240,7 +248,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:127
  • opts: PoolOptions<Worker>
    @@ -248,7 +256,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:129
  • promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
    @@ -261,7 +269,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:82
  • startTimestamp: number
    @@ -269,7 +277,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:117
  • started: boolean
    @@ -277,7 +285,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:109
  • starting: boolean
    @@ -285,7 +293,19 @@
    +
  • Defined in src/pools/abstract-pool.ts:113
  • +
    + +
    taskFunctions: Map<string, TaskFunction<Data, Response>>
    +

    The task functions added at runtime map:

    +
      +
    • key: The task function name.
    • +
    • value: The task function itself.
    • +
    +
    +
    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -293,7 +313,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:88
  • workerNodes: IWorkerNode<Worker, Data>[] = []
    @@ -302,7 +322,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:70
  • Accessors

    @@ -316,7 +336,7 @@

    Returns boolean

    +
  • Defined in src/pools/abstract-pool.ts:660
  • +
  • Defined in src/pools/abstract-pool.ts:651
  • +
  • Defined in src/pools/abstract-pool.ts:271
  • +
  • Defined in src/pools/abstract-pool.ts:484
  • +
  • Defined in src/pools/abstract-pool.ts:477
  • +
  • Defined in src/pools/abstract-pool.ts:429
  • +
  • Defined in src/pools/abstract-pool.ts:467
  • +
  • Defined in src/pools/abstract-pool.ts:446
  • +
  • Defined in src/pools/abstract-pool.ts:472
  • Methods

    +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:1596
  • +
  • Defined in src/pools/abstract-pool.ts:1035
  • +
  • Defined in src/pools/abstract-pool.ts:1346
  • +
  • Defined in src/pools/abstract-pool.ts:1005
  • Returns TasksQueueOptions

    +
  • Defined in src/pools/abstract-pool.ts:600
  • +
  • Defined in src/pools/abstract-pool.ts:1571
  • +
  • Defined in src/pools/abstract-pool.ts:1559
  • -
    - -
    -
    - -
    +
  • Defined in src/pools/abstract-pool.ts:1565
  • +
  • Defined in src/pools/abstract-pool.ts:494
  • Returns void

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

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

    +
  • Defined in src/pools/abstract-pool.ts:217
  • +
  • Defined in src/pools/abstract-pool.ts:1162
  • +
  • Defined in src/pools/abstract-pool.ts:1252
  • +
  • Defined in src/pools/abstract-pool.ts:1208
  • +
  • Defined in src/pools/abstract-pool.ts:1201
  • +
    + +

    Returns undefined | Task<Data>

    +
  • Defined in src/pools/abstract-pool.ts:1661
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:940
  • +
  • Defined in src/pools/abstract-pool.ts:981
  • +
  • Defined in src/pools/abstract-pool.ts:565
  • Returns number

    +
  • Defined in src/pools/abstract-pool.ts:1655
  • +
  • Defined in src/pools/abstract-pool.ts:870
  • +
  • Defined in src/pools/abstract-pool.ts:1649
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1669
  • +
  • Defined in src/pools/abstract-pool.ts:1679
  • +
  • Defined in src/pools/abstract-pool.ts:1585
  • +
  • Defined in src/pools/abstract-pool.ts:513
  • +
  • Defined in src/pools/abstract-pool.ts:525
  • Returns void

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

    +
  • Defined in src/pools/abstract-pool.ts:1515
  • +
  • Defined in src/pools/abstract-pool.ts:1634
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:1627
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:667
  • -
    - +
  • Defined in src/pools/abstract-pool.ts:996
  • +
    +
    +
  • Defined in src/pools/abstract-pool.ts:835
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1389
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:1307
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:1618
  • Returns Promise<void>

    +
  • Defined in src/pools/abstract-pool.ts:953
  • +
  • Defined in src/pools/abstract-pool.ts:1370
  • +
  • Defined in src/pools/abstract-pool.ts:1377
  • +
    + +
    +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:1190
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:620
  • +
  • Defined in src/pools/abstract-pool.ts:579
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:614
  • +
  • Defined in src/pools/abstract-pool.ts:633
  • +
  • Defined in src/pools/abstract-pool.ts:532
  • +
  • Defined in src/pools/abstract-pool.ts:551
  • +
  • Defined in src/pools/abstract-pool.ts:989
  • +
  • Defined in src/pools/abstract-pool.ts:1179
  • Returns boolean

    +
  • Defined in src/pools/abstract-pool.ts:861
  • +
  • Defined in src/pools/abstract-pool.ts:1068
  • +
  • Defined in src/pools/abstract-pool.ts:924
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1429
  • Returns number

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

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

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

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

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

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

    +
  • Defined in src/pools/abstract-pool.ts:1109
  • +
  • Defined in src/pools/abstract-pool.ts:1497
  • Generated using TypeDoc