X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicClusterPool.html;h=76a15e97be8519bfaa041890ed7f46a001edca14;hb=cfc6e8df4c903b63514c46cb67b3f5e24079d3ce;hp=5e8ceb76f84d47a8c1fd4f1d335bec4060a9200f;hpb=248bc34b348a7d8d2b90eecff49d60a3b465da9e;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index 5e8ceb76..76a15e97 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -1,11 +1,13 @@ DynamicClusterPool | poolifier
-
+
@@ -18,10 +20,6 @@

This cluster pool creates new workers when the others are busy, up to the maximum number of workers. When the maximum number of workers is reached, an event is emitted. If you want to listen to this event, use the pool's emitter.

-

Template

of data sent to the worker. This can only be serializable data.

- -

Template

of response of execution. This can only be serializable data.

-

Author

Christopher Quadflieg

Since

2.0.0

@@ -30,9 +28,13 @@ When the maximum number of workers is reached, an event is emitted. If you want

Type Parameters

  • -

    Data = unknown

    • +

    Data = unknown

    +

    Type of data sent to the worker. This can only be serializable data.

    +
  • -

    Response = unknown

+

Response = unknown

+

Type of response of execution. This can only be serializable data.

+

Hierarchy

    @@ -40,7 +42,7 @@ When the maximum number of workers is reached, an event is emitted. If you want
    • DynamicClusterPool
+
  • Defined in src/pools/cluster/dynamic.ts:17
    • @@ -54,14 +56,14 @@ When the maximum number of workers is reached, an event is emitted. If you want

    Properties

    emitter? filePath -max +max nextMessageId numberOfWorkers opts promiseMap -tasks workerChoiceStrategyContext workers +workersTasksUsage

    Accessors

    @@ -71,19 +73,19 @@ When the maximum number of workers is reached, an event is emitted. If you want

    Methods

    -
    afterWorkerSetup +
    afterPromiseWorkerResponseHook +afterWorkerSetup +beforePromiseWorkerResponseHook chooseWorker createAndSetupWorker createWorker -decreaseWorkersTasks destroy destroyWorker execute findFreeWorker +getWorkerAverageTasksRunTime getWorkerIndex getWorkerRunningTasks -increaseWorkersTask -internalExecute internalGetBusyStatus isMain registerWorkerMessageListener @@ -98,7 +100,7 @@ When the maximum number of workers is reached, an event is emitted. If you want

    constructor

      - +

    • Constructs a new poolifier dynamic cluster pool.

      @@ -125,37 +127,38 @@ When the maximum number of workers is reached, an event is emitted. If you want

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

    • -
      Optional opts: ClusterPoolOptions = {}
      +
      opts: ClusterPoolOptions = EMPTY_OBJECT_LITERAL

      Options for this dynamic cluster pool.

    Returns DynamicClusterPool<Data, Response>

    +
  • Defined in src/pools/cluster/dynamic.ts:29

    • Properties

    Optional Readonly emitter

    -
    emitter?: PoolEmitter
    -
    -

    Inherit Doc

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

    • Readonly filePath

    -
    filePath: string
    -
    -

    Readonly max

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

    Protected Readonly max

    max: number
    -
    -

    Inherit Doc

    +
  • Defined in src/pools/cluster/dynamic.ts:31

    • Protected nextMessageId

    nextMessageId: number = 0
    @@ -163,19 +166,23 @@ When the maximum number of workers is reached, an event is emitted. If you want
    +
  • Defined in src/pools/abstract-pool.ts:58

    • Readonly numberOfWorkers

    -
    numberOfWorkers: number
    +
  • Defined in src/pools/abstract-pool.ts:79

    • Readonly opts

    -
    opts: ClusterPoolOptions = {}
    +
  • Defined in src/pools/cluster/fixed.ts:54

    • Protected promiseMap

    promiseMap: Map<number, PromiseWorkerResponseWrapper<Worker, Response>> = ...
    @@ -188,15 +195,7 @@ When the maximum number of workers is reached, an event is emitted. If you want
    -
    -

    Readonly tasks

    -
    tasks: Map<Worker, number> = ...
    -
    -

    Inherit Doc

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

    • Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -205,15 +204,23 @@ When the maximum number of workers is reached, an event is emitted. If you want
    +
  • Defined in src/pools/abstract-pool.ts:65

    • Readonly workers

    workers: Worker[] = []
    -
    -

    Inherit Doc

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

    Readonly workersTasksUsage

    +
    workersTasksUsage: Map<Worker, TasksUsage> = ...
    +

    {@inheritDoc}

    +

    Accessors

    @@ -221,43 +228,66 @@ When the maximum number of workers is reached, an event is emitted. If you want
    +
  • Defined in src/pools/cluster/dynamic.ts:44

    • numberOfRunningTasks

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

    • type

    +
  • Defined in src/pools/cluster/dynamic.ts:39

    • Methods

    +
    +

    Protected afterPromiseWorkerResponseHook

    +

    Protected afterWorkerSetup

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

    Protected beforePromiseWorkerResponseHook

    +

    Protected chooseWorker

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

    -
    -

    Protected decreaseWorkersTasks

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

    • destroy

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

    • destroyWorker

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

    • execute

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

    • findFreeWorker

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

    getWorkerAverageTasksRunTime

    +

    getWorkerIndex

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

    • getWorkerRunningTasks

    -
    -

    Protected increaseWorkersTask

    -
    -
    -

    Protected internalExecute

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

    • Protected internalGetBusyStatus

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

    • Protected isMain

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

    • registerWorkerMessageListener

    Protected removeWorker

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

    • Protected sendToWorker

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

    • setWorkerChoiceStrategy

    Returns void

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

    • Protected setupHook

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:362
    • @@ -616,30 +629,30 @@ When the maximum number of workers is reached, an event is emitted. If you want
  • constructor
  • emitter?
  • filePath
    • -
  • max
    • +
  • max
  • nextMessageId
  • numberOfWorkers
  • opts
  • promiseMap
    • -
  • tasks
  • workerChoiceStrategyContext
  • workers
    • +
  • workersTasksUsage
  • busy
  • numberOfRunningTasks
  • type
    • +
  • afterPromiseWorkerResponseHook
  • afterWorkerSetup
    • +
  • beforePromiseWorkerResponseHook
  • chooseWorker
  • createAndSetupWorker
  • createWorker
    • -
  • decreaseWorkersTasks
  • destroy
  • destroyWorker
  • execute
  • findFreeWorker
    • +
  • getWorkerAverageTasksRunTime
  • getWorkerIndex
  • getWorkerRunningTasks
    • -
  • increaseWorkersTask
    • -
  • internalExecute
  • internalGetBusyStatus
  • isMain
  • registerWorkerMessageListener