X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=800d4a3cda8c167931058f5b209aa9f93238ebb6;hb=2826fc7a3ba7197b08fe5c352d8965b234f3abc5;hp=c6bf43baf88ac70a2be1d8227bf86ad1f2d9a5f8;hpb=d33d2d2fed43d102479c38cc28b496872665a90d;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index c6bf43ba..800d4a3c 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -1,4 +1,4 @@ -AbstractPool | poolifier
+AbstractPool | poolifier - v2.6.17
  • Preparing search index...
  • -
  • The search index is not available
poolifier
+
  • The search index is not available
  • poolifier - v2.6.17
    @@ -76,17 +78,22 @@ info maxSize minSize +ready type +utilization worker

    Methods

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

    @@ -176,8 +186,9 @@

    Emitter on which events can be listened to.

    Events that can currently be listened to:

      -
    • 'full': Emitted when the pool is dynamic and full.
    • -
    • 'busy': Emitted when the pool is busy.
    • +
    • '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.
    • 'error': Emitted when an uncaught error occurs.
    • 'taskError': Emitted when an error occurs while executing a task.
    @@ -185,7 +196,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:63
  • filePath: string
    @@ -193,7 +204,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:105
  • numberOfWorkers: number
    @@ -201,7 +212,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:104
  • opts: PoolOptions<Worker>
    @@ -209,7 +220,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:106
  • promiseResponseMap: Map<string, PromiseResponseWrapper<Worker, Response>> = ...
    @@ -222,7 +233,23 @@
    +
  • Defined in src/pools/abstract-pool.ts:73
  • +
    + +
    startTimestamp: number
    +

    The start timestamp of the pool.

    +
    +
    +
    + +
    starting: boolean
    +

    Whether the pool is starting or not.

    +
    +
    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -230,16 +257,16 @@
    +
  • Defined in src/pools/abstract-pool.ts:81
  • -
    workerNodes: WorkerNode<Worker, Data>[] = []
    +
    workerNodes: IWorkerNode<Worker, Data>[] = []

    Pool worker nodes.

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

    @@ -253,7 +280,7 @@

    Returns boolean

    +
  • Defined in src/pools/abstract-pool.ts:599
  • +
  • Defined in src/pools/abstract-pool.ts:590
  • +
  • Defined in src/pools/abstract-pool.ts:293
  • +
  • Defined in src/pools/abstract-pool.ts:482
  • +
  • Defined in src/pools/abstract-pool.ts:477
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:467
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:472
  • Methods

    +
    + +
      + +
    • +

      Adds the given worker in the pool worker nodes.

      +
      +
      +

      Parameters

      +
        +
      • +
        worker: Worker
        +

        The worker.

        +
        +
      +

      Returns number

      The worker nodes length.

      + +
    +
  • Defined in src/pools/abstract-pool.ts:716
  • +
  • Defined in src/pools/abstract-pool.ts:1024
  • +
  • Defined in src/pools/abstract-pool.ts:695
  • Returns TasksQueueOptions

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

    Returns void

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

    Returns void

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

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

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

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

    +
  • Defined in src/pools/abstract-pool.ts:228
  • +
  • Defined in src/pools/abstract-pool.ts:893
  • +
  • Defined in src/pools/abstract-pool.ts:976
  • +
  • Defined in src/pools/abstract-pool.ts:937
  • +
  • Defined in src/pools/abstract-pool.ts:930
  • Returns undefined | Task<Data>

    +
  • Defined in src/pools/abstract-pool.ts:1185
  • +
  • Defined in src/pools/abstract-pool.ts:650
  • +
  • Defined in src/pools/abstract-pool.ts:671
  • +
  • Defined in src/pools/abstract-pool.ts:555
  • Returns number

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

    Returns void

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

    +
  • Defined in src/pools/abstract-pool.ts:1193
  • +
  • Defined in src/pools/abstract-pool.ts:1203
  • +
    + +
    +
    + +
    -
    - +
  • Defined in src/pools/abstract-pool.ts:518
  • +
    + +

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1097
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:606
  • -
    - +
  • Defined in src/pools/abstract-pool.ts:686
  • +
    + +

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1040
  • +
  • Defined in src/pools/abstract-pool.ts:1011
  • +
  • Defined in src/pools/abstract-pool.ts:1162
  • +
  • Defined in src/pools/abstract-pool.ts:920
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:567
  • +
  • Defined in src/pools/abstract-pool.ts:525
  • -
    - -
    +
  • Defined in src/pools/abstract-pool.ts:544
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1209
  • +
  • Defined in src/pools/abstract-pool.ts:679
  • -
    - +
  • Defined in src/pools/abstract-pool.ts:910
  • +
    +
    +
  • Defined in src/pools/abstract-pool.ts:280
  • Returns number

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

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

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

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

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