X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedClusterPool.html;h=15300e68c3ac6e51bde0f9c6a83ca2732d1da3f7;hb=50b332ec235604105c6290eee79d16ab5757eac1;hp=19b53f146f0a058dfdaf75d50b3679866ad205e7;hpb=b9da9d7e74c720f83482a09d1b883fc83d04f4ed;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index 19b53f14..15300e68 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -1,13 +1,13 @@ -FixedClusterPool | poolifier - v2.6.37
+FixedClusterPool | poolifier - v2.6.44
-
+
  • The search index is not available
    • poolifier - v2.6.44 +
    @@ -45,19 +45,19 @@ +
  • Defined in src/pools/cluster/fixed.ts:33
    • - +

    Constructors

    -
    constructor +
    constructor

    Properties

    -
    emitter? +
    emitter? filePath max? numberOfWorkers @@ -68,7 +68,7 @@

    Accessors

    -
    busy +
    busy full info maxSize @@ -80,7 +80,7 @@

    Methods

    -
    afterTaskExecutionHook +
    afterTaskExecutionHook afterWorkerNodeSetup beforeTaskExecutionHook checkDynamicPoolSize @@ -110,7 +110,7 @@

    Constructors

    -

    constructor

    +

    constructor

    • @@ -129,20 +129,23 @@
    • 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

    @@ -163,7 +166,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:68

    • Protected Readonly filePath

    filePath: string
    @@ -172,7 +175,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:117

    • Protected Optional Readonly max

    max?: number
    @@ -181,7 +184,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:93

    • Protected Readonly numberOfWorkers

    numberOfWorkers: number
    @@ -190,7 +193,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:116

    • Protected Readonly opts

    opts: ClusterPoolOptions = {}
    @@ -199,7 +202,7 @@
    +
  • Defined in src/pools/cluster/fixed.ts:47

    • Protected promiseResponseMap

    promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
    @@ -213,7 +216,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:78

    • Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -222,7 +225,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:84

    • Readonly Internal workerNodes

    workerNodes: IWorkerNode<Worker, Data>[] = []
    @@ -231,7 +234,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:65

    • Accessors

    @@ -246,7 +249,7 @@
    +
  • Defined in src/pools/cluster/fixed.ts:124

    • Protected full

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

    • info

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

    • Protected maxSize

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

    • Protected minSize

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

    • Private ready

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

    • Protected type

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

    • Private utilization

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

    • Protected worker

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

    • Methods

    @@ -362,16 +365,18 @@ 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

    • Protected afterWorkerNodeSetup

    + +

    Returns void

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

    • Protected beforeTaskExecutionHook

    + +

    Returns void

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

    • Protected checkDynamicPoolSize

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

    • Protected createAndSetupDynamicWorkerNode

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

    • Protected createAndSetupWorkerNode

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

    • Protected createWorker

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

    • destroy

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

    • Protected destroyWorkerNode

    + +

    Returns Promise<void>

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

    • enableTasksQueue

    + +

    Returns void

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

    • execute

    + +

    Returns Promise<Response>

    Promise that will be fulfilled when the task is completed.

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

    • Protected flushTasksQueue

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

    • Protected getWorkerInfo

    -

    Returns undefined | WorkerInfo

    The worker information.

    + +
    +

    Returns WorkerInfo

    The worker information.

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

    • hasWorkerNodeBackPressure

    + +

    Returns boolean

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

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

    • Protected internalBusy

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

    • Protected isMain

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

    • listTaskFunctions

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

    • Protected registerWorkerMessageListener

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

    • Protected sendKillMessageToWorker

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

    • Protected sendStartupMessageToWorker

    + +

    Returns void

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

    • Protected sendToWorker

    + +

    Returns void

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

    • setTasksQueueOptions

    + +

    Returns void

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

    • setWorkerChoiceStrategy

    + +

    Returns void

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

    • setWorkerChoiceStrategyOptions

    + +

    Returns void

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

    • Protected setupHook

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

    • Protected workerListener

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

    Settings

     +

    Settings

    Member Visibility

      -
      • -
      • -
      • -
    +
    • +
    • +
    • +

    • Theme

    @@ -908,71 +933,30 @@ Can be overridden.

  • setupHook
  • workerListener
    • -
    +

    Generated using TypeDoc

    -
    \ No newline at end of file +
    \ No newline at end of file