X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedClusterPool.html;h=5c98f2fd45d03fa0df979d5a69f5441f4d6e402c;hb=010ae1ba98e5ab018fa09870982d511c9389b48b;hp=2e5dd84e56c7176ef78dad947d0802d54bb1dd6b;hpb=d8e6bb3c5f8adc1797760260a1a22c228f76e984;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index 2e5dd84e..5c98f2fd 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -1,4 +1,4 @@ -FixedClusterPool | poolifier - v2.6.27
+FixedClusterPool | poolifier - v2.6.37
  • Preparing search index...
  • -
  • The search index is not available
poolifier - v2.6.27
+
  • The search index is not available
  • poolifier - v2.6.37
    @@ -45,7 +45,7 @@ +
  • Defined in src/pools/cluster/fixed.ts:33
  • @@ -59,6 +59,7 @@

    Properties

    emitter? filePath +max? numberOfWorkers opts promiseResponseMap @@ -70,8 +71,8 @@
    busy full info -maxSize -minSize +maxSize +minSize ready type utilization @@ -92,6 +93,7 @@ execute flushTasksQueue getWorkerInfo +hasWorkerNodeBackPressure internalBusy isMain listTaskFunctions @@ -127,23 +129,20 @@
  • numberOfWorkers: number

    Number of workers for this pool.

    -
    -
  • +
  • filePath: string

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

    -
    -
  • +
  • opts: ClusterPoolOptions = {}

    Options for this fixed cluster pool.

    -
    -
  • +

    Returns FixedClusterPool<Data, Response>

    +
  • Defined in src/pools/cluster/fixed.ts:44
  • Properties

    @@ -153,17 +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 >= maximum queue size).
    +
  • Defined in src/pools/abstract-pool.ts:66
  • filePath: string
    @@ -172,7 +172,16 @@
    +
  • Defined in src/pools/abstract-pool.ts:115
  • +
    + +
    max?: number
    +

    Dynamic pool maximum size property placeholder.

    +
    +
    numberOfWorkers: number
    @@ -181,7 +190,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:114
  • @@ -190,7 +199,7 @@
    +
  • Defined in src/pools/cluster/fixed.ts:47
  • promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
    @@ -204,7 +213,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:76
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -213,16 +222,16 @@
    +
  • Defined in src/pools/abstract-pool.ts:82
  • - +
    workerNodes: IWorkerNode<Worker, Data>[] = []

    Pool worker nodes.

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

    @@ -237,7 +246,7 @@
    +
  • Defined in src/pools/cluster/fixed.ts:124
  • +
  • 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/cluster/fixed.ts:114
  • +
  • Defined in src/pools/abstract-pool.ts:522
  • +
  • Defined in src/pools/cluster/fixed.ts:119
  • Methods

    @@ -353,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/cluster/fixed.ts:109
  • +
  • Defined in src/pools/abstract-pool.ts:801
  • +

    Returns Promise<void>

    +
  • Defined in src/pools/cluster/fixed.ts:63
  • 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:1500
  • -

    Returns WorkerInfo

    The worker information.

    + +

    Returns undefined | WorkerInfo

    The worker information.

    +
  • Defined in src/pools/abstract-pool.ts:1416
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:703
  • +
  • Defined in src/pools/cluster/fixed.ts:58
  • +
  • Defined in src/pools/abstract-pool.ts:724
  • +
  • Defined in src/pools/cluster/fixed.ts:101
  • +
  • Defined in src/pools/abstract-pool.ts:811
  • +

    Returns void

    +
  • Defined in src/pools/cluster/fixed.ts:93
  • +

    Returns void

    +
  • Defined in src/pools/cluster/fixed.ts:85
  • 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/cluster/fixed.ts:53
  • +
  • Defined in src/pools/abstract-pool.ts:1328
  • -

    Generated using TypeDoc

    +

    Generated using TypeDoc

    \ No newline at end of file