X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedThreadPool.html;h=6179daf6735a2a7ef010e26a3b3eae7b3811e41c;hb=29527e83440c324c4a78154ceba4c1076908f5d7;hp=0c52886e04db9b8851f1c9de9bb4282b0de0adee;hpb=e816f0c4b8ce1ef889db0c7c0c260dd85a55ac91;p=poolifier.git diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index 0c52886e..6179daf6 100644 --- a/docs/classes/FixedThreadPool.html +++ b/docs/classes/FixedThreadPool.html @@ -1,4 +1,4 @@ -FixedThreadPool | poolifier - v2.6.45
+FixedThreadPool | poolifier - v2.7.2
  • Preparing search index...
    • -
  • The search index is not available
poolifier - v2.6.45
+
  • The search index is not available
    • poolifier - v2.7.2
    @@ -45,7 +45,7 @@ +
  • Defined in src/pools/thread/fixed.ts:35
    • @@ -80,27 +80,32 @@

    Methods

    -
    afterTaskExecutionHook +
    addTaskFunction +afterTaskExecutionHook afterWorkerNodeSetup beforeTaskExecutionHook -checkDynamicPoolSize createAndSetupDynamicWorkerNode createAndSetupWorkerNode createWorker +deregisterWorkerMessageListener destroy destroyWorkerNode enableTasksQueue execute flushTasksQueue getWorkerInfo +hasTaskFunction hasWorkerNodeBackPressure internalBusy isMain -listTaskFunctions +listTaskFunctionNames +registerOnceWorkerMessageListener registerWorkerMessageListener +removeTaskFunction sendKillMessageToWorker sendStartupMessageToWorker sendToWorker +setDefaultTaskFunction setTasksQueueOptions setWorkerChoiceStrategy setWorkerChoiceStrategyOptions @@ -146,7 +151,7 @@
    +
  • Defined in src/pools/thread/fixed.ts:46

    • Properties

    @@ -167,7 +172,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:73

    • Protected Readonly filePath

    filePath: string
    @@ -176,7 +181,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:128

    • Protected Optional Readonly max

    max?: number
    @@ -185,7 +190,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:97

    • Protected Readonly numberOfWorkers

    numberOfWorkers: number
    @@ -194,7 +199,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:127

    • Protected Readonly opts

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

    • Protected promiseResponseMap

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

    • Protected workerChoiceStrategyContext

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

    • Readonly Internal workerNodes

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

    • Accessors

    @@ -250,7 +255,7 @@
    +
  • Defined in src/pools/thread/fixed.ts:154

    • Protected full

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

    • info

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

    • Protected maxSize

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

    • Protected minSize

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

    • Private ready

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

    • Protected type

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

    • Private utilization

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

    • Protected worker

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

    • Methods

    +
    +

    addTaskFunction

    +

    Protected afterTaskExecutionHook

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

    • Protected afterWorkerNodeSetup

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

    • Protected beforeTaskExecutionHook

    -
    -

    Protected checkDynamicPoolSize

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

    • Protected createAndSetupDynamicWorkerNode

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

    • Protected createAndSetupWorkerNode

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

    • Protected createWorker

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

    Protected deregisterWorkerMessageListener

    +
      + +
    • +

      Deregisters a listener callback on the worker given its worker node key.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        Message

      +
      +

      Parameters

      +
        +
      • +
        workerNodeKey: number
        +

        The worker node key.

        +
        +
        • +
      • +
        listener: ((message) => void)
        +

        The message listener callback.

        +
        +
        +
          +
        • +
            +
          • (message): void
            • +
          • +
            +

            Parameters

            +
            +

            Returns void

      +

      Returns void

      +

    destroy

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

    • Protected destroyWorkerNode

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

    • enableTasksQueue

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

    • execute

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

    • Protected flushTasksQueue

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

    • Protected getWorkerInfo

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

    hasTaskFunction

    +
      + +
    • +

      Whether the specified task function exists in this pool.

      +
      +
      +

      Parameters

      +
        +
      • +
        name: string
        +

        The name of the task function.

        +
        +
      +

      Returns boolean

      true if the task function exists, false otherwise.

      + +

    hasWorkerNodeBackPressure

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

    • Protected internalBusy

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

    • Protected isMain

    -
    -

    listTaskFunctions

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

    listTaskFunctionNames

    +
    +

    Protected registerOnceWorkerMessageListener

    +
      + +
    • +

      Registers once a listener callback on the worker given its worker node key.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        Message

      +
      +

      Parameters

      +
        +
      • +
        workerNodeKey: number
        +

        The worker node key.

        +
        +
        • +
      • +
        listener: ((message) => void)
        +

        The message listener callback.

        +
        +
        +
          +
        • +
            +
          • (message): void
            • +
          • +
            +

            Parameters

            +
            +

            Returns void

      +

      Returns void

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

    • Protected registerWorkerMessageListener

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

    removeTaskFunction

    +
      + +
    • +

      Removes a task function from this pool.

      +
      +
      +

      Parameters

      +
        +
      • +
        name: string
        +

        The name of the task function.

        +
        +
      +

      Returns Promise<boolean>

      true if the task function was removed, false otherwise.

      + +

    Protected sendKillMessageToWorker

      - +

    • Parameters

      • -
        workerNodeKey: number
        • -
      • -
        workerId: number
      +
      workerNodeKey: number

    Returns Promise<void>

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

    • Protected sendStartupMessageToWorker

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

    • Protected sendToWorker

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

    setDefaultTaskFunction

    +

    setTasksQueueOptions

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Protected setupHook

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

    • start

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:1488
    • @@ -924,27 +1087,32 @@ Can be overridden.

  • type
  • utilization
  • worker
    • +
  • addTaskFunction
  • afterTaskExecutionHook
  • afterWorkerNodeSetup
  • beforeTaskExecutionHook
    • -
  • checkDynamicPoolSize
  • createAndSetupDynamicWorkerNode
  • createAndSetupWorkerNode
  • createWorker
    • +
  • deregisterWorkerMessageListener
  • destroy
  • destroyWorkerNode
  • enableTasksQueue
  • execute
  • flushTasksQueue
  • getWorkerInfo
    • +
  • hasTaskFunction
  • hasWorkerNodeBackPressure
  • internalBusy
  • isMain
    • -
  • listTaskFunctions
    • +
  • listTaskFunctionNames
    • +
  • registerOnceWorkerMessageListener
  • registerWorkerMessageListener
    • +
  • removeTaskFunction
  • sendKillMessageToWorker
  • sendStartupMessageToWorker
  • sendToWorker
    • +
  • setDefaultTaskFunction
  • setTasksQueueOptions
  • setWorkerChoiceStrategy
  • setWorkerChoiceStrategyOptions
    • @@ -952,7 +1120,7 @@ Can be overridden.

  • start
  • workerListener
    • -