X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedClusterPool.html;h=03d19a9dd2acdc222457bf34298b95ed01996a6b;hb=31542ddfe8297d3bd0f9cf97a3de06a03dafc15d;hp=e73242a662a510823b93b9a8b0e269474d70960e;hpb=c62a9bbc12416e26acbb3b86b5090d6186b14b60;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index e73242a6..03d19a9d 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -1,4 +1,4 @@ -FixedClusterPool | poolifier - v2.6.20
+FixedClusterPool | poolifier - v2.6.32
  • Preparing search index...
  • -
  • The search index is not available
poolifier - v2.6.20
+
  • The search index is not available
  • poolifier - v2.6.32
    @@ -45,7 +45,7 @@ +
  • Defined in src/pools/cluster/fixed.ts:33
  • @@ -59,6 +59,7 @@

    Properties

    +
  • Defined in src/pools/cluster/fixed.ts:44
  • Properties

    @@ -150,17 +154,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:65
  • filePath: string
    @@ -169,7 +175,16 @@
    +
  • Defined in src/pools/abstract-pool.ts:114
  • +
    + +
    max?: number
    +

    Dynamic pool maximum size property placeholder.

    +
    +
    numberOfWorkers: number
    @@ -178,7 +193,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:113
  • @@ -187,7 +202,7 @@
    +
  • Defined in src/pools/cluster/fixed.ts:47
  • promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
    @@ -201,7 +216,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:75
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -210,16 +225,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

    @@ -234,7 +249,7 @@
    +
  • Defined in src/pools/cluster/fixed.ts:120
  • +
  • Defined in src/pools/abstract-pool.ts:675
  • -
    +
  • Defined in src/pools/abstract-pool.ts:345
  • +
    -
      +
      • get maxSize(): number
      • The pool maximum size.

        Returns number

    -
    +
  • Defined in src/pools/abstract-pool.ts:546
  • +
    -
      +
      • get minSize(): number
      • The pool minimum size.

        Returns number

    +
  • Defined in src/pools/abstract-pool.ts:539
  • +
  • Defined in src/pools/abstract-pool.ts:491
  • +
  • Defined in src/pools/cluster/fixed.ts:110
  • +
  • Defined in src/pools/abstract-pool.ts:508
    • -
    • get worker(): "cluster" | "thread"
    • +
    • get worker(): "thread" | "cluster"
    • The worker type.

      -

      Returns "cluster" | "thread"

      +

      Returns "thread" | "cluster"

    +
  • Defined in src/pools/cluster/fixed.ts:115
  • Methods

    @@ -361,7 +376,7 @@ Can be overridden.

    +
  • Defined in src/pools/abstract-pool.ts:872
  • +
  • Defined in src/pools/abstract-pool.ts:1144
  • +
  • Defined in src/pools/abstract-pool.ts:842
  • +
  • Defined in src/pools/abstract-pool.ts:184
  • +
  • Defined in src/pools/abstract-pool.ts:1087
  • +
  • Defined in src/pools/abstract-pool.ts:1043
  • +
  • Defined in src/pools/cluster/fixed.ts:105
  • +
  • Defined in src/pools/abstract-pool.ts:787
  • +
  • Defined in src/pools/cluster/fixed.ts:63
    • -

      Enables/disables the worker tasks queue in this pool.

      +

      Enables/disables the worker node tasks queue in this pool.

      Parameters

      • enable: boolean
        -

        Whether to enable or disable the worker tasks queue.

        +

        Whether to enable or disable the worker node tasks queue.

      • Optional tasksQueueOptions: TasksQueueOptions
        -

        The worker tasks queue options.

        +

        The worker node tasks queue options.

      Returns void

    +
  • Defined in src/pools/abstract-pool.ts:627
    • - +
    • Executes the specified function in the worker constructor with the task data input parameter.

      @@ -533,12 +548,17 @@ Can be overridden.

      • Optional data: Data
        -

        The task input data for the specified worker function. This can only be structured-cloneable data.

        +

        The optional task input data for the specified task function. This can only be structured-cloneable data.

      • Optional name: string
        -

        The name of the worker function to execute. If not specified, the default worker function will be executed.

        +

        The optional name of the task function to execute. If not specified, the default task function will be executed.

        +
        +
      • +
      • +
        Optional transferList: TransferListItem[]
        +

        An optional array of transferable objects to transfer ownership of. Ownership of the transferred objects is given to the pool's worker_threads worker and they should not be used in the main thread afterwards.

    Returns Promise<Response>

    Promise that will be fulfilled when the task is completed.

    @@ -546,7 +566,7 @@ Can be overridden.

    +
  • Defined in src/pools/abstract-pool.ts:725
  • +
  • Defined in src/pools/abstract-pool.ts:1434
    • - +
    • Gets the worker information given its worker node key.

      @@ -576,25 +596,46 @@ Can be overridden.

      The worker node key.

    -

    Returns WorkerInfo

    The worker information.

    +

    Returns undefined | WorkerInfo

    The worker information.

    +
  • Defined in src/pools/abstract-pool.ts:1349
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:691
  • +
  • Defined in src/pools/cluster/fixed.ts:58
  • +
    + +
    +
  • Defined in src/pools/cluster/fixed.ts:97
  • +
    + +
    +
  • Defined in src/pools/cluster/fixed.ts:89
  • +
  • Defined in src/pools/cluster/fixed.ts:81
  • +
  • Defined in src/pools/abstract-pool.ts:639
  • +
  • Defined in src/pools/abstract-pool.ts:594
  • +
  • Defined in src/pools/abstract-pool.ts:613
  • +
  • Defined in src/pools/cluster/fixed.ts:53
  • +
  • Defined in src/pools/abstract-pool.ts:1261