X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedThreadPool.html;h=f2bd8f7c02c44eeb3d3b2001c782a4b32c53e750;hb=c90257c0b2d2c8ebdc6abbee02361cc2ddae36b9;hp=cad736ea1cc2a5d56e3b58b17662dcba8b2e54f9;hpb=c62a9bbc12416e26acbb3b86b5090d6186b14b60;p=poolifier.git diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index cad736ea..f2bd8f7c 100644 --- a/docs/classes/FixedThreadPool.html +++ b/docs/classes/FixedThreadPool.html @@ -1,4 +1,4 @@ -FixedThreadPool | poolifier - v2.6.20
+FixedThreadPool | poolifier - v2.6.30
  • Preparing search index...
  • -
  • The search index is not available
poolifier - v2.6.20
+
  • The search index is not available
  • poolifier - v2.6.30
    @@ -45,7 +45,7 @@ +
  • Defined in src/pools/thread/fixed.ts:35
  • @@ -59,6 +59,7 @@

    Properties

    +
  • Defined in src/pools/thread/fixed.ts:46
  • 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 >= pool maximum size^2).
    +
  • Defined in src/pools/abstract-pool.ts:65
  • filePath: string
    @@ -169,7 +175,16 @@
    +
  • Defined in src/pools/abstract-pool.ts:110
  • +
    + +
    max?: number
    +

    Dynamic pool maximum size property placeholder.

    +
    +
    numberOfWorkers: number
    @@ -178,7 +193,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:109
  • @@ -187,7 +202,7 @@
    +
  • Defined in src/pools/thread/fixed.ts:49
  • 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/thread/fixed.ts:132
  • +
  • Defined in src/pools/abstract-pool.ts:641
  • -
    +
  • Defined in src/pools/abstract-pool.ts:324
  • +
    -
      +
      • get maxSize(): number
      • The pool maximum size.

        Returns number

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

        Returns number

    +
  • Defined in src/pools/abstract-pool.ts:518
  • +
  • Defined in src/pools/abstract-pool.ts:470
  • +
  • Defined in src/pools/thread/fixed.ts:122
  • +
  • Defined in src/pools/abstract-pool.ts:487
    • -
    • get worker(): "cluster" | "thread"
    • +
    • get worker(): "thread" | "cluster"
    • The worker type.

      -

      Returns "cluster" | "thread"

      +

      Returns "thread" | "cluster"

    +
  • Defined in src/pools/thread/fixed.ts:127
  • Methods

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

    +
  • Defined in src/pools/abstract-pool.ts:827
  • +
  • Defined in src/pools/abstract-pool.ts:1091
  • +
  • Defined in src/pools/abstract-pool.ts:804
  • +
  • Defined in src/pools/abstract-pool.ts:179
  • +
  • Defined in src/pools/abstract-pool.ts:1037
  • +
  • Defined in src/pools/abstract-pool.ts:997
  • +
  • Defined in src/pools/thread/fixed.ts:114
  • +
  • Defined in src/pools/abstract-pool.ts:750
  • +
  • Defined in src/pools/thread/fixed.ts:60
  • +
  • Defined in src/pools/abstract-pool.ts:606
    • - +
    • 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:691
  • +
  • Defined in src/pools/abstract-pool.ts:1345
  • +
  • Defined in src/pools/abstract-pool.ts:1260
  • +
    + +
      + +
    • Internal +

      Whether the worker node has back pressure (i.e. its tasks queue is full).

      +
      +
      +

      Parameters

      +
        +
      • +
        workerNodeKey: number
        +

        The worker node key.

        +
        +
      +

      Returns boolean

      true if the worker node has back pressure, false otherwise.

      + +
    • -

      Whether worker nodes are executing at least one task.

      +

      Whether worker nodes are executing concurrently their tasks quota or not.

      Returns boolean

      Worker nodes busyness boolean status.

    +
  • Defined in src/pools/abstract-pool.ts:657
  • +
  • Defined in src/pools/thread/fixed.ts:55
  • +
    + +
    +
  • Defined in src/pools/thread/fixed.ts:104
  • +
    + +
    +
  • Defined in src/pools/thread/fixed.ts:88
    • - +
    • Sends a message to worker given its worker node key.

      @@ -687,12 +757,17 @@ Can be overridden.

      message: MessageValue<Data, unknown>

      The message.

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

      The optional array of transferable objects.

      +

    Returns void

    +
  • Defined in src/pools/thread/fixed.ts:77
  • +
  • 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:1174