X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FFixedClusterPool.html;h=3604f5524ee3d54162d4e71601d076fd5317ae81;hb=e7339cfd46bfe4600187ae2c6bd6c9e7f63e7052;hp=5680e5ebfe5a5f3f34f1986a3d652760e6915f1d;hpb=42db2d3372ac49ab00dd1889378238b7a78ac4ce;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index 5680e5eb..3604f552 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -38,13 +38,13 @@

Hierarchy

+
  • Defined in src/pools/cluster/fixed.ts:39
    • @@ -124,46 +124,51 @@

    Options for this fixed cluster pool.

    Returns FixedClusterPool<Data, Response>

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

    • Properties

    Optional Readonly emitter

    emitter?: PoolEmitter
    -
    -

    Inherit Doc

    +
  • 'full': Emitted when the pool is dynamic and full.
    • +
  • 'busy': Emitted when the pool is busy.
    • + +

    Readonly filePath

    filePath: string

    Path to the worker-file.

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

    • Readonly numberOfWorkers

    numberOfWorkers: number

    Number of workers that this pool should manage.

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

    • Readonly opts

    opts: ClusterPoolOptions = {}

    Options for this fixed cluster pool.

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

    • Protected promiseResponseMap

    -
    promiseResponseMap: Map<string, PromiseResponseWrapper<Worker, Response>> = ...
    +
    promiseResponseMap: Map<string, PromiseResponseWrapper<Worker, Response>> = ...

    The execution response promise map.

    When we receive a message from the worker, we get a map entry with the promise resolve/reject bound to the message id.

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

    • Protected workerChoiceStrategyContext

    -
    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    +
    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>

    Worker choice strategy context referencing a worker choice algorithm implementation.

    Default to a round robin algorithm.

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

    • Readonly workerNodes

    -
    workerNodes: WorkerNode<Worker, Data>[] = []
    -
    -

    Inherit Doc

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

    • Accessors

    @@ -198,23 +203,25 @@
    +
  • Defined in src/pools/cluster/fixed.ts:109

    • full

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

    • Private numberOfQueuedTasks

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

    • Private numberOfRunningTasks

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

    • type

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

    • Methods

    Protected afterTaskExecutionHook

    Returns void

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

    • Protected afterWorkerSetup

    Returns void

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

    • Protected beforeTaskExecutionHook

    Returns void

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

    • Protected chooseWorkerNode

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

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

    • destroy

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

    • destroyWorker

    Returns void

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

    • execute

    Returns Promise<Response>

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

    • findFreeWorkerNodeKey

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

    • Protected internalBusy

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

    • Protected isMain

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

    • registerWorkerMessageListener

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

    • Protected sendToWorker

    Returns void

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

    • setWorkerChoiceStrategy

    Returns void

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

    • Protected setupHook

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:445
    • @@ -579,21 +611,33 @@ Can be overridden.