X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=be753f26c66d6837b8e47043f8cb866625b74dfd;hb=4445abb25ec4c9d80985ca93c65762a6c892a852;hp=5d9c47e5236bc1dd4415ad1ad6d983a6c47191be;hpb=2447ee8ce5d3db1253c7286482e5a54e84618ecf;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index 5d9c47e5..be753f26 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -1,4 +1,4 @@ -AbstractPool | poolifier - v2.6.24
+AbstractPool | poolifier - v2.6.31
  • Preparing search index...
  • -
  • The search index is not available
poolifier - v2.6.24
+
  • The search index is not available
  • poolifier - v2.6.31
    @@ -49,7 +49,7 @@
    • IPool<Worker, Data, Response>
    +
  • Defined in src/pools/abstract-pool.ts:56
  • @@ -63,6 +63,7 @@

    Properties

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

    @@ -186,17 +194,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 >= pool maximum size^2).
    +
  • Defined in src/pools/abstract-pool.ts:65
  • filePath: string
    @@ -204,7 +214,15 @@
    +
  • Defined in src/pools/abstract-pool.ts:110
  • +
    + +
    max?: number
    +

    Dynamic pool maximum size property placeholder.

    +
    +
    numberOfWorkers: number
    @@ -212,7 +230,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:109
  • opts: PoolOptions<Worker>
    @@ -220,7 +238,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:111
  • promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
    @@ -233,7 +251,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:75
  • startTimestamp: number
    @@ -241,7 +259,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:99
  • starting: boolean
    @@ -249,7 +267,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:95
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -257,16 +275,16 @@
    +
  • Defined in src/pools/abstract-pool.ts:81
  • - +
    workerNodes: IWorkerNode<Worker, Data>[] = []

    Pool worker nodes.

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

    @@ -280,7 +298,7 @@

    Returns boolean

    +
  • Defined in src/pools/abstract-pool.ts:650
  • +
  • Defined in src/pools/abstract-pool.ts:641
  • +
  • Defined in src/pools/abstract-pool.ts:324
  • - +
    +
  • Defined in src/pools/abstract-pool.ts:525
  • - +
    +
  • Defined in src/pools/abstract-pool.ts:518
  • +
  • Defined in src/pools/abstract-pool.ts:470
  • +
  • Defined in src/pools/abstract-pool.ts:508
  • +
  • Defined in src/pools/abstract-pool.ts:487
  • +
  • Defined in src/pools/abstract-pool.ts:513
  • Methods

    @@ -396,7 +414,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:1291
  • +
  • Defined in src/pools/abstract-pool.ts:834
  • +
  • Defined in src/pools/abstract-pool.ts:1109
  • +
  • Defined in src/pools/abstract-pool.ts:804
  • Returns TasksQueueOptions

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

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

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

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

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

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

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

    +
  • Defined in src/pools/abstract-pool.ts:243
  • +
  • Defined in src/pools/abstract-pool.ts:966
  • +
  • Defined in src/pools/abstract-pool.ts:1052
  • +
  • Defined in src/pools/abstract-pool.ts:1012
  • +
  • Defined in src/pools/abstract-pool.ts:1005
  • Returns undefined | Task<Data>

    +
  • Defined in src/pools/abstract-pool.ts:1357
  • +
  • Defined in src/pools/abstract-pool.ts:750
  • +
  • Defined in src/pools/abstract-pool.ts:780
  • +
  • Defined in src/pools/abstract-pool.ts:606
  • Returns number

    +
  • Defined in src/pools/abstract-pool.ts:1351
  • +
  • Defined in src/pools/abstract-pool.ts:691
  • +
  • Defined in src/pools/abstract-pool.ts:1345
  • Returns void

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

    Returns WorkerInfo

    The worker information.

    +

    Returns undefined | WorkerInfo

    The worker information.

    +
  • Defined in src/pools/abstract-pool.ts:1280
  • +
  • Defined in src/pools/abstract-pool.ts:554
  • +
  • Defined in src/pools/abstract-pool.ts:566
  • Returns void

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

    +
  • Defined in src/pools/abstract-pool.ts:1212
  • +
    + +
    +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:657
  • +
  • Defined in src/pools/abstract-pool.ts:795
  • +
    + +

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1143
  • +
  • Defined in src/pools/abstract-pool.ts:1096
  • +
  • Defined in src/pools/abstract-pool.ts:1314
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:1123
  • +
    + +
    -
    - -
    +
  • Defined in src/pools/abstract-pool.ts:994
  • +
  • Defined in src/pools/abstract-pool.ts:618
  • +
  • Defined in src/pools/abstract-pool.ts:573
  • +
  • Defined in src/pools/abstract-pool.ts:592
  • +
  • Defined in src/pools/abstract-pool.ts:788
  • +
  • Defined in src/pools/abstract-pool.ts:983
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:311
  • Returns number

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

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

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

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

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