X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=docs%2Fclasses%2FFixedClusterPool.html;h=2076e589ebc674bd8efa60f795f3d55155a6273a;hb=bfed591d93e26b1e424e916abdb27c6f91dc9b45;hp=9a7ec8cb3244fac5aec2ec0a9b7a0fe03cb69ba1;hpb=c0b0686de0f8c5483b20b94fac97d2b8175c0556;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index 9a7ec8cb..2076e589 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -1,11 +1,13 @@ FixedClusterPool | poolifier
-
+
  • The search index is not available
    • 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
    • @@ -61,9 +63,9 @@ numberOfWorkers opts promiseMap -tasks workerChoiceStrategyContext workers +workersTasksUsage

    Accessors

    @@ -73,18 +75,20 @@

    Methods

    -
    afterWorkerSetup +
    afterPromiseWorkerResponseHook +afterWorkerSetup +beforePromiseWorkerResponseHook chooseWorker createAndSetupWorker createWorker -decreaseWorkersTasks destroy destroyWorker execute findFreeWorker +getWorkerAverageTasksRunTime getWorkerIndex getWorkerRunningTasks -increaseWorkersTask +initWorkerTasksUsage internalExecute internalGetBusyStatus isMain @@ -100,7 +104,7 @@

    constructor

      - +

    • Constructs a new poolifier fixed cluster pool.

      @@ -123,29 +127,29 @@

      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
    +
    emitter?: PoolEmitter

    Inherit Doc

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

    • Readonly filePath

    filePath: string
    +
  • Defined in src/pools/abstract-pool.ts:83

    • Optional Readonly max

    max?: number
    @@ -153,7 +157,7 @@

    Inherit Doc

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

    • Protected nextMessageId

    nextMessageId: number = 0
    @@ -161,19 +165,19 @@
    +
  • Defined in src/pools/abstract-pool.ts:61

    • Readonly numberOfWorkers

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

    • Readonly opts

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

    • Protected promiseMap

    promiseMap: Map<number, PromiseWorkerResponseWrapper<Worker, Response>> = ...
    @@ -186,15 +190,7 @@
    -
    -

    Readonly tasks

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

    Inherit Doc

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

    • Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -203,7 +199,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:68

    • Readonly workers

    workers: Worker[] = []
    @@ -211,7 +207,15 @@

    Inherit Doc

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

    Readonly workersTasksUsage

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

    Inherit Doc

    Accessors

    @@ -224,7 +228,7 @@

    Returns boolean

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

    • numberOfRunningTasks

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

    • type

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

    • Methods

    +
    +

    Protected afterPromiseWorkerResponseHook

    +

    Protected afterWorkerSetup

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

    Protected beforePromiseWorkerResponseHook

    +

    Protected chooseWorker

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

    -
    -

    Protected decreaseWorkersTasks

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

    • destroy

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

    • destroyWorker

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

    • execute

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

    • findFreeWorker

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

    getWorkerAverageTasksRunTime

    +

    getWorkerIndex

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

    • getWorkerRunningTasks

    -
    -

    Protected increaseWorkersTask

    -
    +
    +

    initWorkerTasksUsage

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

    • Protected internalExecute

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

    • Protected internalGetBusyStatus

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

    • Protected isMain

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

    • registerWorkerMessageListener

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

    • Protected removeWorker

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

    • Protected sendToWorker

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

    • setWorkerChoiceStrategy

    Returns void

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

    • Protected setupHook

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:368
    • @@ -619,24 +663,26 @@
  • 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
    • +
  • initWorkerTasksUsage
  • internalExecute
  • internalGetBusyStatus
  • isMain