X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedThreadPool.html;h=5384f9a72a45fa9b228a6e29c183d67ff45b1d3b;hb=5441aea6894a5031667db6447634fa5d97f69e36;hp=5f3005ffccbc63730c4117fd06db226d3a0ec71f;hpb=a47027a0bf90ce21b528708dadd0eb23b5537b43;p=poolifier.git diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index 5f3005ff..5384f9a7 100644 --- a/docs/classes/FixedThreadPool.html +++ b/docs/classes/FixedThreadPool.html @@ -1,4 +1,4 @@ -FixedThreadPool | poolifier - v2.6.21
+FixedThreadPool | poolifier - v2.6.28
  • Preparing search index...
    • -
  • The search index is not available
poolifier - v2.6.21
+
  • The search index is not available
    • poolifier - v2.6.28
    @@ -45,7 +45,7 @@ +
  • Defined in src/pools/thread/fixed.ts:35
    • @@ -94,7 +94,9 @@ getWorkerInfo internalBusy isMain +listTaskFunctions registerWorkerMessageListener +sendKillMessageToWorker sendStartupMessageToWorker sendToWorker setTasksQueueOptions @@ -141,7 +143,7 @@
    +
  • Defined in src/pools/thread/fixed.ts:46

    • Properties

    @@ -150,9 +152,10 @@

    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.
    @@ -160,7 +163,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:65

    • Protected Readonly filePath

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

    • Protected Readonly numberOfWorkers

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

    • Protected Readonly opts

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

    • Protected promiseResponseMap

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

    • Protected workerChoiceStrategyContext

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

    • Readonly workerNodes

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

    • Accessors

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

    • Protected full

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

    • info

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

    • 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:451

    • Protected type

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

    • Private utilization

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

    • Protected worker

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

    • Methods

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

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

    • Protected afterWorkerNodeSetup

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

    • Protected beforeTaskExecutionHook

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

    • Protected checkDynamicPoolSize

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

    • Protected createAndSetupDynamicWorkerNode

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

    • Protected createAndSetupWorkerNode

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

    • Protected createWorker

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

    • destroy

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

    • Protected destroyWorkerNode

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

    • enableTasksQueue

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

    • execute

      - +

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

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

      • Optional data: Data
        -

        The task input data for the specified task 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 task function to execute. If not specified, the default task 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 +554,7 @@ Can be overridden.

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

    • Protected flushTasksQueue

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

    • Protected getWorkerInfo

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

    • 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:631

    • Protected isMain

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

    listTaskFunctions

    +

    Protected registerWorkerMessageListener

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

    Protected sendKillMessageToWorker

    +

    Protected sendStartupMessageToWorker

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

    • Protected sendToWorker

      - +

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

      @@ -687,12 +724,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:592

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Protected setupHook

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:1111
    • @@ -850,7 +892,9 @@ Can be overridden.

  • getWorkerInfo
  • internalBusy
  • isMain
    • +
  • listTaskFunctions
  • registerWorkerMessageListener
    • +
  • sendKillMessageToWorker
  • sendStartupMessageToWorker
  • sendToWorker
  • setTasksQueueOptions
    • @@ -859,7 +903,7 @@ Can be overridden.

  • setupHook
  • workerListener
    • -