X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=d7c1a3d61996c22fecaacad3ea76b8e772c1402f;hb=36df5bd40369d98d6ccb60400e66dce1aa980d54;hp=d100e14889ec71c12977e9f0c175905c3351b81a;hpb=6d59ea2c71b8a88d41498c6fb54dfad95fd3a3ac;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index d100e148..d7c1a3d6 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -1,4 +1,4 @@ -AbstractPool | poolifier
+AbstractPool | poolifier - v2.6.15
  • Preparing search index...
  • -
  • The search index is not available
poolifier
+
  • The search index is not available
  • poolifier - v2.6.15
    @@ -29,12 +29,12 @@
  • Data = unknown

    -

    Type of data sent to the worker. This can only be serializable data.

    +

    Type of data sent to the worker. This can only be structured-cloneable data.

  • Response = unknown

    -

    Type of execution response. This can only be serializable data.

    +

    Type of execution response. This can only be structured-cloneable data.

  • @@ -49,7 +49,7 @@
    • IPool<Worker, Data, Response>
    +
  • Defined in src/pools/abstract-pool.ts:54
  • @@ -66,6 +66,8 @@ numberOfWorkers opts promiseResponseMap +startTimestamp +starting workerChoiceStrategyContext workerNodes
    @@ -76,17 +78,22 @@ info maxSize minSize +ready type +utilization worker

    Methods

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

    @@ -176,8 +185,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 +195,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:63
  • filePath: string
    @@ -193,7 +203,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:105
  • numberOfWorkers: number
    @@ -201,7 +211,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:104
  • opts: PoolOptions<Worker>
    @@ -209,7 +219,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:106
  • promiseResponseMap: Map<string, PromiseResponseWrapper<Worker, Response>> = ...
    @@ -222,7 +232,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 +256,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 +279,7 @@

    Returns boolean

    +
  • Defined in src/pools/abstract-pool.ts:595
  • +
  • Defined in src/pools/abstract-pool.ts:586
  • +
  • Defined in src/pools/abstract-pool.ts:289
  • +
  • Defined in src/pools/abstract-pool.ts:478
  • +
  • Defined in src/pools/abstract-pool.ts:473
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:463
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:468
  • Methods

    +
    + +
      + +
    • +

      Adds the given worker in the pool worker nodes.

      +
      +
      +

      Parameters

      +
        +
      • +
        worker: Worker
        +

        The worker.

        +
        +
      +

      Returns number

      The worker nodes length.

      + +
      @@ -342,21 +408,21 @@ Can be overridden.

    • -
      message: MessageValue<Response, unknown, Worker | MessagePort>
      +
      message: MessageValue<Response, unknown>

      The received message.

    Returns void

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

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

    Returns void

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

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:163
  • 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:889
  • +
  • Defined in src/pools/abstract-pool.ts:972
  • +
  • Defined in src/pools/abstract-pool.ts:933
  • +
  • Defined in src/pools/abstract-pool.ts:926
  • Returns undefined | Task<Data>

    +
  • Defined in src/pools/abstract-pool.ts:1181
  • +
  • Defined in src/pools/abstract-pool.ts:646
  • +
  • Defined in src/pools/abstract-pool.ts:667
  • +
  • Defined in src/pools/abstract-pool.ts:551
  • Returns number

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

    Returns void

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

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

    Returns undefined | Worker

    The worker if found in the pool worker nodes, undefined otherwise.

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

    Returns number

    The worker node key if the worker is found in the pool worker nodes, -1 otherwise.

    +

    Returns number

    The worker node key if found in the pool worker nodes, -1 otherwise.

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

    Returns void

    +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:1084
  • +
  • Defined in src/pools/abstract-pool.ts:602
  • -
    - +
  • Defined in src/pools/abstract-pool.ts:682
  • +
    + +

    Returns void

    -
    - -
    +
    + +

    Returns void

    Returns void

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

    +
  • Defined in src/pools/abstract-pool.ts:916
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:563
  • +
  • Defined in src/pools/abstract-pool.ts:521
  • -
    - -
    +
  • Defined in src/pools/abstract-pool.ts:540
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1205
  • +
  • Defined in src/pools/abstract-pool.ts:675
  • +
  • Defined in src/pools/abstract-pool.ts:906
  • Returns number

    +
  • Defined in src/pools/abstract-pool.ts:1185
  • +
    message: MessageValue<Response, unknown>

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:818
  • +
    message: MessageValue<Response, unknown>

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:742
  • +
    message: MessageValue<Response, unknown>

    Returns void

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

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

    The listener function to execute when a message is received from a worker.

    +
  • Defined in src/pools/abstract-pool.ts:1071
  • +
  • WorkerTypes
  • +
  • availableParallelism
  • Generated using TypeDoc

    \ No newline at end of file