X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=e0ce9367d8156b3d8f65f10367f605703ed569ee;hb=26fb3c18b678a1daab6b18a351a238fb5a3ed5df;hp=5d9c47e5236bc1dd4415ad1ad6d983a6c47191be;hpb=c65efde664ab9e4dcd2ed9e827d8171e7e081359;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index 5d9c47e5..e0ce9367 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -1,4 +1,4 @@ -AbstractPool | poolifier - v2.6.24
+AbstractPool | poolifier - v2.6.35
  • Preparing search index...
  • -
  • The search index is not available
poolifier - v2.6.24
+
  • The search index is not available
  • poolifier - v2.6.35
    @@ -49,7 +49,7 @@
    • IPool<Worker, Data, Response>
    +
  • Defined in src/pools/abstract-pool.ts:58
  • @@ -63,10 +63,12 @@

    Properties

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

    @@ -186,17 +198,19 @@

    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.
    • +
    • '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:67
  • filePath: string
    @@ -204,7 +218,15 @@
    +
  • Defined in src/pools/abstract-pool.ts:116
  • +
    + +
    max?: number
    +

    Dynamic pool maximum size property placeholder.

    +
    +
    numberOfWorkers: number
    @@ -212,7 +234,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:115
  • opts: PoolOptions<Worker>
    @@ -220,7 +242,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:117
  • promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
    @@ -233,7 +255,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:77
  • startTimestamp: number
    @@ -241,7 +263,15 @@
    +
  • Defined in src/pools/abstract-pool.ts:105
  • +
    + +
    started: boolean
    +

    Whether the pool is started or not.

    +
    +
    starting: boolean
    @@ -249,7 +279,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:97
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -257,16 +287,16 @@
    +
  • Defined in src/pools/abstract-pool.ts:83
  • - +
    workerNodes: IWorkerNode<Worker, Data>[] = []

    Pool worker nodes.

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

    @@ -280,7 +310,7 @@

    Returns boolean

    +
  • Defined in src/pools/abstract-pool.ts:703
  • +
  • Defined in src/pools/abstract-pool.ts:694
  • +
  • Defined in src/pools/abstract-pool.ts:355
  • - +
    +
  • Defined in src/pools/abstract-pool.ts:567
  • - +
    +
  • Defined in src/pools/abstract-pool.ts:560
  • +
  • Defined in src/pools/abstract-pool.ts:512
  • +
  • Defined in src/pools/abstract-pool.ts:550
  • +
  • Defined in src/pools/abstract-pool.ts:529
  • +
  • Defined in src/pools/abstract-pool.ts:555
  • Methods

    @@ -396,7 +426,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:1442
  • +
  • Defined in src/pools/abstract-pool.ts:892
  • +
  • Defined in src/pools/abstract-pool.ts:1166
  • +
  • Defined in src/pools/abstract-pool.ts:862
  • Returns TasksQueueOptions

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

    Returns void

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

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

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

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

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

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

    +
  • Defined in src/pools/abstract-pool.ts:250
  • +
  • Defined in src/pools/abstract-pool.ts:1019
  • +
  • Defined in src/pools/abstract-pool.ts:1109
  • +
  • Defined in src/pools/abstract-pool.ts:1065
  • +
  • Defined in src/pools/abstract-pool.ts:1058
  • Returns undefined | Task<Data>

    +
  • Defined in src/pools/abstract-pool.ts:1508
  • +
  • Defined in src/pools/abstract-pool.ts:807
  • +
  • Defined in src/pools/abstract-pool.ts:838
  • +
  • Defined in src/pools/abstract-pool.ts:648
  • Returns number

    +
  • Defined in src/pools/abstract-pool.ts:1502
  • +
  • Defined in src/pools/abstract-pool.ts:744
  • +
  • Defined in src/pools/abstract-pool.ts:1496
  • Returns void

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

    Returns WorkerInfo

    The worker information.

    +

    Returns undefined | WorkerInfo

    The worker information.

    +
  • Defined in src/pools/abstract-pool.ts:1431
  • +
  • Defined in src/pools/abstract-pool.ts:596
  • +
  • Defined in src/pools/abstract-pool.ts:608
  • Returns void

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

    +
  • Defined in src/pools/abstract-pool.ts:1363
  • +
    + +
    +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:710
  • +
  • Defined in src/pools/abstract-pool.ts:853
  • +
    + +

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1206
  • +
  • Defined in src/pools/abstract-pool.ts:1153
  • +
  • Defined in src/pools/abstract-pool.ts:1465
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:1186
  • +
    + +
    -
    - +
  • Defined in src/pools/abstract-pool.ts:1047
  • +
    + +

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:671
  • +
  • Defined in src/pools/abstract-pool.ts:660
  • +
  • Defined in src/pools/abstract-pool.ts:615
  • +
  • Defined in src/pools/abstract-pool.ts:634
  • +
  • Defined in src/pools/abstract-pool.ts:846
  • +
  • Defined in src/pools/abstract-pool.ts:1036
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:342
  • +
    + +

    Returns number

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

    Returns void

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

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

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

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