X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedThreadPool.html;h=86de8020aa34966609205e272def7aad402ce20c;hb=f33c2d55c063a50c0025bf707fa4faf7a5e25f6e;hp=c94a503a31bdd7a4a161b872c6717e79eab178ef;hpb=004a8816ae9b52388de246a9c7a5184a73915ad6;p=poolifier.git diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index c94a503a..86de8020 100644 --- a/docs/classes/FixedThreadPool.html +++ b/docs/classes/FixedThreadPool.html @@ -1,4 +1,4 @@ -FixedThreadPool | poolifier
+FixedThreadPool | poolifier - v2.6.12
  • Preparing search index...
    • -
  • The search index is not available
poolifier
+
  • The search index is not available
    • poolifier - v2.6.12
    @@ -17,8 +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.

    -

    This pool selects the threads in a round robin fashion.

    Author

    Alessandro Pio Ardizio

    @@ -30,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:32
    • @@ -74,15 +72,19 @@ info maxSize minSize +ready +starting type +utilization worker

    Methods

    afterTaskExecutionHook -afterWorkerSetup +afterWorkerSetup beforeTaskExecutionHook -chooseWorkerNode +checkDynamicPoolSize +createAndSetupDynamicWorker createAndSetupWorker createWorker destroy @@ -91,7 +93,6 @@ execute internalBusy isMain -registerWorkerMessageListener sendToWorker setTasksQueueOptions setWorkerChoiceStrategy @@ -137,7 +138,7 @@
    +
  • Defined in src/pools/thread/fixed.ts:43

    • Properties

    @@ -146,8 +147,9 @@

    Emitter on which events can be listened to.

    Events that can currently be listened to:

      -
    • 'full': Emitted when the pool is dynamic and full.
      • -
    • 'busy': Emitted when the pool is busy.
      • +
    • '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.
    • 'error': Emitted when an uncaught error occurs.
    • 'taskError': Emitted when an error occurs while executing a task.
    @@ -155,7 +157,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:62

    • Protected Readonly filePath

    filePath: string
    @@ -164,7 +166,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:100

    • Protected Readonly numberOfWorkers

    numberOfWorkers: number
    @@ -173,7 +175,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:99

    • Protected Readonly opts

    opts: ThreadPoolOptions = {}
    @@ -182,10 +184,10 @@
    +
  • Defined in src/pools/thread/fixed.ts:46

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

    • Protected workerChoiceStrategyContext

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

    Worker choice strategy context referencing a worker choice algorithm implementation.

    -

    Default to a round robin algorithm.

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

    • Readonly workerNodes

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

    Pool worker nodes.

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

    • Accessors

    @@ -230,7 +231,7 @@
    +
  • Defined in src/pools/thread/fixed.ts:96

    • Protected full

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

    • info

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

    • Protected maxSize

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

    • Protected minSize

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

    Private ready

    +
    +
    +

    Private starting

    +

    Protected type

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

    Private utilization

    +

    Protected worker

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

    • Methods

    @@ -319,12 +351,12 @@ Can be overridden.

    Parameters

    @@ -332,32 +364,32 @@ Can be overridden.

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

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

    • Protected beforeTaskExecutionHook

    Returns void

    -
    -

    Protected chooseWorkerNode

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

    Protected checkDynamicPoolSize

    +
    +
    +

    Protected createAndSetupDynamicWorker

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

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

    • destroy

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

    • Protected destroyWorker

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

    • enableTasksQueue

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

    • execute

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

    • Protected internalBusy

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

    • Protected isMain

    -
    -

    Protected registerWorkerMessageListener

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

    • Protected sendToWorker

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

    • setTasksQueueOptions

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Protected setupHook

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

    • Protected workerListener

    Returns void

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

    +
  • Defined in src/pools/abstract-pool.ts:1041
    • @@ -722,12 +738,16 @@ Can be overridden

  • info
  • maxSize
  • minSize
    • +
  • ready
    • +
  • starting
  • type
    • +
  • utilization
  • worker
  • afterTaskExecutionHook
    • -
  • afterWorkerSetup
    • +
  • afterWorkerSetup
  • beforeTaskExecutionHook
    • -
  • chooseWorkerNode
    • +
  • checkDynamicPoolSize
    • +
  • createAndSetupDynamicWorker
  • createAndSetupWorker
  • createWorker
  • destroy
    • @@ -736,7 +756,6 @@ Can be overridden

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

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

    • Generated using TypeDoc

    \ No newline at end of file