X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedThreadPool.html;h=9eeaa2f9a11602979fe245bed7356cf42bf22d05;hb=c8284c4cf12c3aabc04aa0c382d1494eff8a2698;hp=2c75dfba0932805a571b5144a37dafdc801cd797;hpb=f2d2c4a40a1d1652ba5fb0dee4b6aa3387321c92;p=poolifier.git diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index 2c75dfba..9eeaa2f9 100644 --- a/docs/classes/FixedThreadPool.html +++ b/docs/classes/FixedThreadPool.html @@ -1,4 +1,4 @@ -FixedThreadPool | poolifier - v2.6.34
+FixedThreadPool | poolifier - v2.6.41
  • Preparing search index...
  • -
  • The search index is not available
poolifier - v2.6.34
+
  • The search index is not available
  • poolifier - v2.6.41
    @@ -45,7 +45,7 @@ +
  • Defined in src/pools/thread/fixed.ts:35
  • @@ -129,23 +129,20 @@
  • numberOfThreads: number

    Number of threads for this pool.

    -
    -
  • +
  • filePath: string

    Path to an implementation of a ThreadWorker file, which can be relative or absolute.

    -
    -
  • +
  • opts: ThreadPoolOptions = {}

    Options for this fixed thread pool.

    -
    -
  • +

    Returns FixedThreadPool<Data, Response>

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

    @@ -155,9 +152,9 @@

    Events that can currently be listened to:

    • '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.
    • +
    • 'busy': Emitted when the number of workers created in the pool has reached the maximum size expected and are executing concurrently their tasks quota.
    • '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.
    • +
    • 'destroy': Emitted when the pool is destroyed.
    • 'error': Emitted when an uncaught error occurs.
    • 'taskError': Emitted when an error occurs while executing a task.
    • 'backPressure': Emitted when all worker nodes have back pressure (i.e. their tasks queue is full: queue size >= maximum queue size).
    • @@ -166,7 +163,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:68
  • filePath: string
    @@ -175,7 +172,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:117
  • max?: number
    @@ -184,7 +181,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:93
  • numberOfWorkers: number
    @@ -193,7 +190,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:116
  • @@ -202,7 +199,7 @@
    +
  • Defined in src/pools/thread/fixed.ts:49
  • promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
    @@ -216,7 +213,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:78
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -225,7 +222,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:84
  • workerNodes: IWorkerNode<Worker, Data>[] = []
    @@ -234,7 +231,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:65
  • Accessors

    @@ -249,7 +246,7 @@
    +
  • Defined in src/pools/thread/fixed.ts:135
  • +
  • Defined in src/pools/abstract-pool.ts:689
  • +
  • Defined in src/pools/abstract-pool.ts:350
  • +
  • Defined in src/pools/abstract-pool.ts:562
  • +
  • Defined in src/pools/abstract-pool.ts:555
  • +
  • Defined in src/pools/abstract-pool.ts:507
  • +
  • Defined in src/pools/thread/fixed.ts:125
  • +
  • Defined in src/pools/abstract-pool.ts:524
  • +
  • Defined in src/pools/thread/fixed.ts:130
  • Methods

    @@ -365,18 +362,16 @@ Can be overridden.

  • workerNodeKey: number

    The worker node key.

    -
    -
  • +
  • message: MessageValue<Response, unknown>

    The received message.

    -
    -
  • +

    Returns void

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

    Returns void

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

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:858
  • +
  • Defined in src/pools/abstract-pool.ts:187
  • +
  • Defined in src/pools/abstract-pool.ts:1105
  • +
  • Defined in src/pools/abstract-pool.ts:1061
  • +
  • Defined in src/pools/thread/fixed.ts:117
  • +
  • Defined in src/pools/abstract-pool.ts:803
  • +

    Returns Promise<void>

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

    Returns void

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

    Returns Promise<Response>

    Promise that will be fulfilled when the task is completed.

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

    Returns undefined | WorkerInfo

    The worker information.

    + +

    Returns WorkerInfo

    The worker information.

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

    Returns boolean

    true if the worker node has back pressure, false otherwise.

    +
  • Defined in src/pools/abstract-pool.ts:1459
  • +
  • Defined in src/pools/abstract-pool.ts:705
  • +
  • Defined in src/pools/thread/fixed.ts:55
  • +
  • Defined in src/pools/abstract-pool.ts:726
  • +
  • Defined in src/pools/thread/fixed.ts:107
  • +
  • Defined in src/pools/abstract-pool.ts:813
  • +

    Returns void

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

    Returns void

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

    Returns void

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

    Returns void

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

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:629
  • +
  • Defined in src/pools/abstract-pool.ts:842
  • +
  • Defined in src/pools/abstract-pool.ts:1331
  • -

    Generated using TypeDoc

    +

    Generated using TypeDoc

    \ No newline at end of file