X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedClusterPool.html;h=e16a76ea3d8ac0a74f17c5457236bc7727726325;hb=999ef664722a6ef639e3b3a90542e3ed2f38288c;hp=7a09afa0faab302eec9e2721794724bd6598faaa;hpb=019581cc38fe0b47645d9b2120f325ab37388be2;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index 7a09afa0..e16a76ea 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -1,4 +1,4 @@ -FixedClusterPool | poolifier - v2.6.28
+FixedClusterPool | poolifier - v2.6.36
  • Preparing search index...
  • -
  • The search index is not available
poolifier - v2.6.28
+
  • The search index is not available
  • poolifier - v2.6.36
    @@ -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

    @@ -155,15 +154,16 @@
  • '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).
  • +
  • Defined in src/pools/abstract-pool.ts:67
  • filePath: string
    @@ -172,7 +172,16 @@
    +
  • Defined in src/pools/abstract-pool.ts:116
  • +
    + +
    max?: number
    +

    Dynamic pool maximum size property placeholder.

    +
    +
    numberOfWorkers: number
    @@ -181,7 +190,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:115
  • @@ -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:77
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -213,16 +222,16 @@
    +
  • Defined in src/pools/abstract-pool.ts:83
  • - +
    workerNodes: IWorkerNode<Worker, Data>[] = []

    Pool worker nodes.

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

    @@ -237,7 +246,7 @@
    +
  • Defined in src/pools/cluster/fixed.ts:120
  • +
  • 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/cluster/fixed.ts:110
  • +
  • Defined in src/pools/abstract-pool.ts:523
  • +
  • Defined in src/pools/cluster/fixed.ts:115
  • 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: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/cluster/fixed.ts:105
  • +
  • Defined in src/pools/abstract-pool.ts:796
  • +

    Returns Promise<void>

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

    The worker information.

    + +

    Returns undefined | WorkerInfo

    The worker information.

    +
  • Defined in src/pools/abstract-pool.ts:1423
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:704
  • +
  • Defined in src/pools/cluster/fixed.ts:58
  • +
  • Defined in src/pools/abstract-pool.ts:725
  • +
  • Defined in src/pools/cluster/fixed.ts:97
  • +
  • Defined in src/pools/abstract-pool.ts:806
  • +

    Returns void

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

    Returns void

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

    Generated using TypeDoc

    +

    Generated using TypeDoc

    \ No newline at end of file