X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FFixedThreadPool.html;h=d445cf31251afe513d01b71c9107de6296c55238;hb=b667be1103b9362ae29d094de05f812468464d4f;hp=2504bffc197d9db600773760a373537c3baec970;hpb=5e5a659e2b415c7d533dad095eda082989983f8e;p=poolifier.git diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index 2504bffc..d445cf31 100644 --- a/docs/classes/FixedThreadPool.html +++ b/docs/classes/FixedThreadPool.html @@ -1,4 +1,4 @@ -FixedThreadPool | poolifier
+FixedThreadPool | poolifier - v2.6.8
  • Preparing search index...
    • -
  • The search index is not available
poolifier
+
  • The search index is not available
    • poolifier - v2.6.8
    @@ -17,7 +17,6 @@

    Class FixedThreadPool<Data, Response>

    A thread pool with a fixed number of threads.

    -

    It is possible to perform tasks in sync or asynchronous mode as you prefer.

    Author

    Alessandro Pio Ardizio

    @@ -29,24 +28,24 @@

    • Data = unknown

      -

      Type of data sent to the worker. This can only be serializable data.

      +

      Type of data sent to the worker. This can only be structured-cloneable data.

    • Response = unknown

      -

      Type of execution response. This can only be serializable data.

      +

      Type of execution response. This can only be structured-cloneable data.

    Hierarchy

    +
  • Defined in src/pools/thread/fixed.ts:37
    • @@ -74,14 +73,15 @@ maxSize minSize type +utilization worker

    Methods

    afterTaskExecutionHook -afterWorkerSetup +afterWorkerSetup beforeTaskExecutionHook -chooseWorkerNode +createAndSetupDynamicWorker createAndSetupWorker createWorker destroy @@ -90,7 +90,6 @@ execute internalBusy isMain -registerWorkerMessageListener sendToWorker setTasksQueueOptions setWorkerChoiceStrategy @@ -136,7 +135,7 @@
    +
  • Defined in src/pools/thread/fixed.ts:48

    • Properties

    @@ -154,7 +153,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:60

    • Protected Readonly filePath

    filePath: string
    @@ -163,7 +162,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:98

    • Protected Readonly numberOfWorkers

    numberOfWorkers: number
    @@ -172,7 +171,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:97

    • Protected Readonly opts

    opts: ThreadPoolOptions = {}
    @@ -181,10 +180,10 @@
    +
  • Defined in src/pools/thread/fixed.ts:51

    • Protected promiseResponseMap

    -
    promiseResponseMap: Map<string, PromiseResponseWrapper<ThreadWorkerWithMessageChannel, Response>> = ...
    +
    promiseResponseMap: Map<string, PromiseResponseWrapper<Worker, Response>> = ...

    The execution response promise map.

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

    • Protected workerChoiceStrategyContext

    -
    workerChoiceStrategyContext: WorkerChoiceStrategyContext<ThreadWorkerWithMessageChannel, Data, Response>
    +
    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>

    Worker choice strategy context referencing a worker choice algorithm implementation.

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

    • Readonly workerNodes

    -
    workerNodes: WorkerNode<ThreadWorkerWithMessageChannel, Data>[] = []
    +
    workerNodes: WorkerNode<Worker, Data>[] = []

    Pool worker nodes.

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

    • Accessors

    @@ -228,7 +227,7 @@
    +
  • Defined in src/pools/thread/fixed.ts:101

    • Protected full

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

    • info

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

    • Protected maxSize

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

    • Protected minSize

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

    • Protected type

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

    Private utilization

    +

    Protected worker

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

    • Methods

    @@ -317,12 +329,12 @@ Can be overridden.

    Parameters

    @@ -330,28 +342,28 @@ Can be overridden.

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

    Protected afterWorkerSetup

    -
      +
      • -

        Function that can be hooked up when a worker has been newly created and moved to the pool worker nodes.

        -

        Can be used to update the maxListeners or binding the main-worker<->worker connection if not bind by default.

        +

        Function that can be hooked up when a worker has been newly created and moved to the pool worker nodes. +Can be overridden.

        Parameters

        Returns void

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

    • Protected beforeTaskExecutionHook

    -
    -

    Protected chooseWorkerNode

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

    Protected createAndSetupDynamicWorker

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

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

    • destroy

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

    • Protected destroyWorker

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

    • enableTasksQueue

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

    • execute

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

    • Protected internalBusy

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

    • Protected isMain

    -
    -

    Protected registerWorkerMessageListener

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

    • Protected sendToWorker

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

    • setTasksQueueOptions

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Protected setupHook

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

    • Protected workerListener

    Returns void

    The listener function to execute when a message is received from a worker.

    +
  • Defined in src/pools/abstract-pool.ts:974
    • @@ -726,11 +701,12 @@ Can be overridden

  • maxSize
  • minSize
  • type
    • +
  • utilization
  • worker
  • afterTaskExecutionHook
    • -
  • afterWorkerSetup
    • +
  • afterWorkerSetup
  • beforeTaskExecutionHook
    • -
  • chooseWorkerNode
    • +
  • createAndSetupDynamicWorker
  • createAndSetupWorker
  • createWorker
  • destroy
    • @@ -739,7 +715,6 @@ Can be overridden

  • execute
  • internalBusy
  • isMain
    • -
  • registerWorkerMessageListener
  • sendToWorker
  • setTasksQueueOptions
  • setWorkerChoiceStrategy
    • @@ -747,7 +722,7 @@ Can be overridden

  • setupHook
  • workerListener
    • -
    +
  • WorkerTypes
    • +
  • availableParallelism

    • Generated using TypeDoc

    \ No newline at end of file