X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedClusterPool.html;h=8dc3e624df12bc9968bb8ba8553a289b33be18fe;hb=e1230e386080ae19766e2a7863c807a90f13a3ef;hp=5e4adf05eeb4282930373887bdcaca42041520fa;hpb=e83f3916315e18f3ca0c614d6ec9e064ab76c13c;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index 5e4adf05..8dc3e624 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -1,11 +1,13 @@ FixedClusterPool | poolifier
-
+
@@ -18,10 +20,6 @@

It is possible to perform tasks in sync or asynchronous mode as you prefer.

This pool selects the workers in a round robin fashion.

-

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 @@

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

+
  • Defined in src/pools/cluster/fixed.ts:39
    • @@ -56,7 +58,6 @@

    Properties

    emitter? filePath -max? nextMessageId numberOfWorkers opts @@ -86,8 +87,6 @@ getWorkerAverageTasksRunTime getWorkerIndex getWorkerRunningTasks -initWorkerTasksUsage -internalExecute internalGetBusyStatus isMain registerWorkerMessageListener @@ -102,7 +101,7 @@

    constructor

      - +

    • Constructs a new poolifier fixed cluster pool.

      @@ -125,37 +124,31 @@

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

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

      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

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

    • Readonly filePath

    -
    filePath: string
    -
    -

    Optional Readonly max

    -
    max?: number
    -
    -

    Inherit Doc

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

    • Protected nextMessageId

    nextMessageId: number = 0
    @@ -163,19 +156,23 @@
    +
  • 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:53

    • Protected promiseMap

    promiseMap: Map<number, PromiseWorkerResponseWrapper<Worker, Response>> = ...
    @@ -188,7 +185,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:50

    • Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -197,23 +194,23 @@
    +
  • 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> = ...
    -
    -

    Inherit Doc

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

    • Accessors

    @@ -221,34 +218,34 @@
    +
  • Defined in src/pools/cluster/fixed.ts:104

    • numberOfRunningTasks

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

    • type

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

    • Methods

    @@ -273,14 +270,14 @@ Can be overridden.

    Returns void

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

    • Protected afterWorkerSetup

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

    • Protected beforePromiseWorkerResponseHook

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

    • Protected chooseWorker

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

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

    • destroy

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

    • destroyWorker

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

    • execute

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

    • findFreeWorker

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

    • getWorkerAverageTasksRunTime

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

    • getWorkerIndex

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

    • getWorkerRunningTasks

    -
    -

    initWorkerTasksUsage

    -
    -
    -

    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:64

    • registerWorkerMessageListener

    Protected removeWorker

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

    • Protected sendToWorker

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

    • setWorkerChoiceStrategy

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

    • Protected setupHook

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:363
    • @@ -656,7 +619,6 @@ Can be overridden.

  • constructor
  • emitter?
  • filePath
    • -
  • max?
  • nextMessageId
  • numberOfWorkers
  • opts
    • @@ -680,8 +642,6 @@ Can be overridden.

  • getWorkerAverageTasksRunTime
  • getWorkerIndex
  • getWorkerRunningTasks
    • -
  • initWorkerTasksUsage
    • -
  • internalExecute
  • internalGetBusyStatus
  • isMain
  • registerWorkerMessageListener