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

    • Properties

    @@ -160,7 +160,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:65

    • Protected Readonly filePath

    filePath: string
    @@ -169,7 +169,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:105

    • Protected Readonly numberOfWorkers

    numberOfWorkers: number
    @@ -178,7 +178,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:104

    • Protected Readonly opts

    opts: ThreadPoolOptions = {}
    @@ -187,7 +187,7 @@
    +
  • Defined in src/pools/thread/fixed.ts:49

    • Protected promiseResponseMap

    promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
    @@ -201,7 +201,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:75

    • Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -210,7 +210,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:81

    • Readonly workerNodes

    workerNodes: IWorkerNode<Worker, Data>[] = []
    @@ -219,7 +219,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:62

    • Accessors

    @@ -234,7 +234,7 @@
    +
  • Defined in src/pools/thread/fixed.ts:142

    • Protected full

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

    • info

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

    • Protected maxSize

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

    • Protected minSize

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

    • Private ready

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

    • Protected type

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

    • Private utilization

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

    • Protected worker

      -
    • 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 +361,7 @@ Can be overridden.

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

    • Protected afterWorkerNodeSetup

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

    • Protected beforeTaskExecutionHook

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

    • Protected checkDynamicPoolSize

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

    • Protected createAndSetupDynamicWorkerNode

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

    • Protected createAndSetupWorkerNode

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

    • Protected createWorker

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

    • destroy

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

    • Protected destroyWorkerNode

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

    • enableTasksQueue

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

    • execute

      - +

    • Executes the specified function in the worker constructor with the task data input parameter.

      @@ -533,12 +533,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 +551,7 @@ Can be overridden.

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

    • Protected flushTasksQueue

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

    • Protected getWorkerInfo

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

    • Protected internalBusy

    • -

      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:623

    • Protected isMain

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

    • Protected registerWorkerMessageListener

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

    • Protected sendStartupMessageToWorker

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

    • Protected sendToWorker

      - +

    • Sends a message to worker given its worker node key.

      @@ -687,12 +692,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

    • setTasksQueueOptions

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Protected setupHook

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:1059
    • @@ -859,7 +869,7 @@ Can be overridden.

  • setupHook
  • workerListener
    • -