X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedThreadPool.html;h=38e5f6684eea18148b13d7f6344f3747957913aa;hb=cc35cd9cb7323e39c9f521cdd4fbf51d1d31bbdf;hp=f2bd8f7c02c44eeb3d3b2001c782a4b32c53e750;hpb=46e29227a97fe04f886969199f1c14338af50543;p=poolifier.git diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index f2bd8f7c..38e5f668 100644 --- a/docs/classes/FixedThreadPool.html +++ b/docs/classes/FixedThreadPool.html @@ -1,4 +1,4 @@ -FixedThreadPool | poolifier - v2.6.30
+FixedThreadPool | poolifier - v2.6.40
  • Preparing search index...
  • -
  • The search index is not available
poolifier - v2.6.30
+
  • The search index is not available
  • poolifier - v2.6.40
    @@ -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,18 +152,18 @@

    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 >= pool maximum size^2).
    • +
    • 'backPressure': Emitted when all worker nodes have back pressure (i.e. their tasks queue is full: queue size >= maximum queue size).
    +
  • Defined in src/pools/abstract-pool.ts:66
  • filePath: string
    @@ -175,7 +172,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:115
  • max?: number
    @@ -184,7 +181,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:91
  • numberOfWorkers: number
    @@ -193,7 +190,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:114
  • @@ -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:76
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -225,7 +222,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:82
  • workerNodes: IWorkerNode<Worker, Data>[] = []
    @@ -234,7 +231,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:63
  • Accessors

    @@ -249,7 +246,7 @@
    +
  • Defined in src/pools/thread/fixed.ts:135
  • +
  • Defined in src/pools/abstract-pool.ts:687
  • +
  • Defined in src/pools/abstract-pool.ts:348
  • +
  • Defined in src/pools/abstract-pool.ts:560
  • +
  • Defined in src/pools/abstract-pool.ts:553
  • +
  • Defined in src/pools/abstract-pool.ts:505
  • +
  • Defined in src/pools/thread/fixed.ts:125
  • +
  • Defined in src/pools/abstract-pool.ts:522
  • +
  • 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:886
  • +

    Returns void

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

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:856
  • +
  • Defined in src/pools/abstract-pool.ts:185
  • +
  • Defined in src/pools/abstract-pool.ts:1103
  • +
  • Defined in src/pools/abstract-pool.ts:1059
  • +
  • Defined in src/pools/thread/fixed.ts:117
  • +
  • Defined in src/pools/abstract-pool.ts:801
  • +

    Returns Promise<void>

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

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

    Returns Promise<Response>

    Promise that will be fulfilled when the task is completed.

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

    Returns WorkerInfo

    The worker information.

    + +

    Returns undefined | 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:703
  • +
  • Defined in src/pools/thread/fixed.ts:55
  • +
  • Defined in src/pools/abstract-pool.ts:724
  • +
  • Defined in src/pools/thread/fixed.ts:107
  • +
  • Defined in src/pools/abstract-pool.ts:811
  • +

    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:653
  • +Optional

    Returns void

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

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:627
  • +
  • Defined in src/pools/abstract-pool.ts:840
  • +
  • Defined in src/pools/abstract-pool.ts:1329
  • -

    Generated using TypeDoc

    +

    Generated using TypeDoc

    \ No newline at end of file