X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=27ed4997fc97f37ad8390ae2455176a5feb5dc99;hb=6b83e544b1827a8a04898c3032dab73fe19687e6;hp=9de28f0cfe4a3cb12fe5a6a8e64bc4609040dd88;hpb=52f4e8137eab5d72c663eb9ae9289c08d804e559;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index 9de28f0c..27ed4997 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -1,4 +1,4 @@ -AbstractPool | poolifier - v2.6.12
+AbstractPool | poolifier - v2.6.23
  • Preparing search index...
  • -
  • The search index is not available
poolifier - v2.6.12
+
  • The search index is not available
  • poolifier - v2.6.23
    @@ -78,15 +79,15 @@ maxSize minSize ready -starting type utilization worker

    Methods

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

    @@ -194,7 +196,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:64
  • filePath: string
    @@ -202,7 +204,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:104
  • numberOfWorkers: number
    @@ -210,7 +212,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:103
  • opts: PoolOptions<Worker>
    @@ -218,11 +220,11 @@
    +
  • Defined in src/pools/abstract-pool.ts:105
  • -
    promiseResponseMap: Map<string, PromiseResponseWrapper<Worker, Response>> = ...
    -

    The execution response promise map.

    +
    promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
    +

    The task execution response promise map.

    • key: The message id of each submitted task.
    • value: An object that contains the worker, the execution response promise resolve and reject callbacks.
    • @@ -231,7 +233,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:74
  • startTimestamp: number
    @@ -239,7 +241,15 @@
    +
  • Defined in src/pools/abstract-pool.ts:93
  • +
    + +
    starting: boolean
    +

    Whether the pool is starting or not.

    +
    +
    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -247,7 +257,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:80
  • workerNodes: IWorkerNode<Worker, Data>[] = []
    @@ -256,7 +266,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:61
  • Accessors

    @@ -270,7 +280,7 @@

    Returns boolean

    +
  • Defined in src/pools/abstract-pool.ts:615
  • +
  • Defined in src/pools/abstract-pool.ts:606
  • +
  • Defined in src/pools/abstract-pool.ts:301
  • +
  • Defined in src/pools/abstract-pool.ts:497
  • +
  • Defined in src/pools/abstract-pool.ts:492
  • -
    - -
    +
  • Defined in src/pools/abstract-pool.ts:444
  • +
  • Defined in src/pools/abstract-pool.ts:482
  • +
  • Defined in src/pools/abstract-pool.ts:461
  • +
  • Defined in src/pools/abstract-pool.ts:487
  • Methods

    +
    + +
      - +
    • Hook executed after the worker task execution. Can be overridden.

      @@ -382,8 +409,8 @@ Can be overridden.

      Parameters

      • -
        worker: Worker
        -

        The worker.

        +
        workerNodeKey: number
        +

        The worker node key.

      • @@ -394,27 +421,27 @@ Can be overridden.

        Returns void

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

      Function that can be hooked up when a worker has been newly created and moved to the pool worker nodes. +

      Method hooked up after a worker node has been newly created. Can be overridden.

      Parameters

      • -
        worker: Worker
        -

        The newly created worker.

        +
        workerNodeKey: number
        +

        The newly created worker node key.

      Returns void

    +
  • Defined in src/pools/abstract-pool.ts:962
  • +
  • Defined in src/pools/abstract-pool.ts:712
  • Returns TasksQueueOptions

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

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

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

    Returns void

    +
    +

    Throws

    https://nodejs.org/api/errors.html#class-error If the worker id is invalid.

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

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

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

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

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

    +
  • Defined in src/pools/abstract-pool.ts:236
  • -
    - +
  • Defined in src/pools/abstract-pool.ts:827
  • +
    +
    -
    - +
  • Defined in src/pools/abstract-pool.ts:911
  • +
    +
    +
  • Defined in src/pools/abstract-pool.ts:871
  • +
  • Defined in src/pools/abstract-pool.ts:864
  • Returns undefined | Task<Data>

    +
  • Defined in src/pools/abstract-pool.ts:1166
  • -
    - +
  • Defined in src/pools/abstract-pool.ts:675
  • +
    +
    +
  • Defined in src/pools/abstract-pool.ts:688
  • +
  • Defined in src/pools/abstract-pool.ts:571
  • Returns number

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

    Returns void

    +
    -
    - -
    +
    + +

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1174
  • -
    - -
    +
    + +
    -
    - +
  • Defined in src/pools/abstract-pool.ts:1113
  • +
    +
    -
    - +
  • Defined in src/pools/abstract-pool.ts:522
  • +
    +
    +
  • Defined in src/pools/abstract-pool.ts:534
  • Returns void

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

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1058
  • +
  • Defined in src/pools/abstract-pool.ts:622
  • -
    - -
    +
  • Defined in src/pools/abstract-pool.ts:703
  • Returns void

    -
    - -
    +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:1143
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:854
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:583
  • +
  • Defined in src/pools/abstract-pool.ts:541
  • -
    - -
    +
  • Defined in src/pools/abstract-pool.ts:560
  • +
  • Defined in src/pools/abstract-pool.ts:696
  • +
  • Defined in src/pools/abstract-pool.ts:844
  • +
    + +

    Returns number

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

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

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

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

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