X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedThreadPool.html;h=0b08b110c58590aa9d949523b117d5066c06ce3c;hb=be71219a2e687e8a46a167503df4f5620807db0b;hp=c2557b461d595e571b6e70ad55090f01b1695d58;hpb=fd98bbb90c7202f5dd734c029f3cee2f997aea24;p=poolifier.git diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index c2557b46..0b08b110 100644 --- a/docs/classes/FixedThreadPool.html +++ b/docs/classes/FixedThreadPool.html @@ -1,4 +1,4 @@ -FixedThreadPool | poolifier - v2.6.32
+FixedThreadPool | poolifier - v2.6.36
  • Preparing search index...
  • -
  • The search index is not available
poolifier - v2.6.32
+
  • The search index is not available
  • poolifier - v2.6.36
    @@ -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

    @@ -157,7 +154,7 @@
  • '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.
  • +
  • '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:67
  • filePath: string
    @@ -175,7 +172,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:116
  • max?: number
    @@ -184,7 +181,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:92
  • numberOfWorkers: number
    @@ -193,7 +190,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:115
  • @@ -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:77
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -225,7 +222,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:83
  • workerNodes: IWorkerNode<Worker, Data>[] = []
    @@ -234,7 +231,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:64
  • Accessors

    @@ -249,7 +246,7 @@
    +
  • Defined in src/pools/thread/fixed.ts:132
  • +
  • Defined in src/pools/abstract-pool.ts:688
  • +
  • Defined in src/pools/abstract-pool.ts:349
  • +
  • Defined in src/pools/abstract-pool.ts:561
  • +
  • Defined in src/pools/abstract-pool.ts:554
  • +
  • Defined in src/pools/abstract-pool.ts:506
  • +
  • Defined in src/pools/thread/fixed.ts:122
  • +
  • Defined in src/pools/abstract-pool.ts:523
  • +
  • Defined in src/pools/thread/fixed.ts:127
  • 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:881
  • +

    Returns void

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

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:851
  • +
  • Defined in src/pools/abstract-pool.ts:186
  • +
  • Defined in src/pools/abstract-pool.ts:1098
  • +
  • Defined in src/pools/abstract-pool.ts:1054
  • +
  • Defined in src/pools/thread/fixed.ts:114
  • +
  • Defined in src/pools/abstract-pool.ts:796
  • +

    Returns Promise<void>

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

    Returns void

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

    Returns Promise<Response>

    Promise that will be fulfilled when the task is completed.

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

    Returns undefined | WorkerInfo

    The worker information.

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

    Returns boolean

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

    +
  • Defined in src/pools/abstract-pool.ts:1466
  • +
  • Defined in src/pools/abstract-pool.ts:704
  • +
  • Defined in src/pools/thread/fixed.ts:55
  • +
  • Defined in src/pools/abstract-pool.ts:725
  • +
  • Defined in src/pools/thread/fixed.ts:104
  • +
  • Defined in src/pools/abstract-pool.ts:806
  • +

    Returns void

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

    Returns void

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

    Returns void

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

    Returns void

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

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:628
  • +
  • Defined in src/pools/abstract-pool.ts:835
  • +
  • Defined in src/pools/abstract-pool.ts:1335
  • -

    Generated using TypeDoc

    +

    Generated using TypeDoc

    \ No newline at end of file