X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedClusterPool.html;h=eb5e22d41eda358342853c08d4bb690084cb9b51;hb=4736ba628fabbf7e34e36ef0f55a96e86b7033ac;hp=fea43dbe739838c98175e81d3f64b1fa31d81b04;hpb=d61f24ac46792cfab91a154667f24fc57c90e66e;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index fea43dbe..eb5e22d4 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,39 +58,32 @@

    Properties

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

    Accessors

    busy -numberOfRunningTasks +full +numberOfRunningTasks type

    Methods

    -
    afterPromiseWorkerResponseHook +
    afterPromiseResponseHook afterWorkerSetup -beforePromiseWorkerResponseHook +beforePromiseResponseHook chooseWorker createAndSetupWorker createWorker destroy destroyWorker execute -findFreeWorker -getWorkerAverageTasksRunTime -getWorkerIndex -getWorkerRunningTasks -initWorkerTasksUsage -internalExecute -internalGetBusyStatus +findFreeWorkerKey +internalBusy isMain registerWorkerMessageListener removeWorker @@ -131,89 +126,71 @@

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

    • Readonly filePath

    -
    filePath: string
    -
    -

    Optional Readonly max

    -
    max?: number
    -
    -

    Inherit Doc

    -
    -

    Protected nextMessageId

    -
    nextMessageId: number = 0
    -

    Id of the next message.

    +
    filePath: string
    +

    Path to the worker-file.

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

    • Readonly numberOfWorkers

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

    • Readonly opts

    -
    opts: ClusterPoolOptions = {}
    -
    -

    Protected promiseMap

    -
    promiseMap: Map<number, PromiseWorkerResponseWrapper<Worker, Response>> = ...
    -

    The promise map.

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

    Protected promiseResponseMap

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

    The promise response map.

      -
    • key: This is the message Id of each submitted task.
      • -
    • value: An object that contains the worker, the resolve function and the reject function.
      • +
    • key: The message id of each submitted task.
      • +
    • value: An object that contains the worker, the promise resolve and reject callbacks.
    -

    When we receive a message from the worker we get a map entry and resolve/reject the promise based on the message.

    +

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

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

    • Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    -

    Worker choice strategy instance implementing the worker choice algorithm.

    -

    Default to a strategy implementing a round robin algorithm.

    +

    Worker choice strategy context referencing a worker choice algorithm implementation.

    +

    Default to a round robin algorithm.

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

    • Readonly workers

    -
    workers: Worker[] = []
    +
    workers: WorkerType<Worker>[] = []

    Inherit Doc

    -
    -

    Readonly workersTasksUsage

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

    Inherit Doc

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

    • Accessors

    @@ -226,18 +203,29 @@

    Returns boolean

    -
    -

    numberOfRunningTasks

    -
    +
    +

    full

    +
    +
    +

    Private numberOfRunningTasks

    +
      +
    • get numberOfRunningTasks(): number
      • +
    • +

      Number of tasks concurrently running in the pool.

      +

      Returns number

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

    • type

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

    • Methods

    -
    -

    Protected afterPromiseWorkerResponseHook

    +
    +

    Protected afterPromiseResponseHook

      - +

    • Hook executed after the worker task promise resolution. Can be overridden.

      @@ -263,17 +251,17 @@ Can be overridden.

      Parameters

      • -
        message: MessageValue<Response, unknown>
        -

        The received message.

        +
        worker: Worker
        +

        The worker.

      • -
        promise: PromiseWorkerResponseWrapper<Worker, Response>
        -

        The Promise response.

        +
        message: MessageValue<Response, unknown>
        +

        The received message.

      Returns void

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

    • Protected afterWorkerSetup

    -
    -

    Protected beforePromiseWorkerResponseHook

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

    Protected beforePromiseResponseHook

      - +

    • Hook executed before the worker task promise resolution. Can be overridden.

      @@ -302,27 +290,27 @@ Can be overridden.

      Parameters

      • -
        worker: Worker
        -

        The worker.

        +
        workerKey: number
        +

        The worker key.

      Returns void

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

    • Protected chooseWorker

      - +

    • Chooses a worker for the next task.

      -

      The default implementation uses a round robin algorithm to distribute the load.

      +

      The default uses a round robin algorithm to distribute the load.

      -

      Returns

      Worker.

      +

      Returns

      [worker key, worker].

      -

      Returns Worker

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

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

    • destroy

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

    • destroyWorker

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

    • execute

    -
    -

    findFreeWorker

    -
      - -
    • -
      -

      Inherit Doc

      -

      Returns false | Worker

    -
    -

    getWorkerAverageTasksRunTime

    -
      - -
    • -
      -

      Inherit Doc

      -
      -

      Parameters

      -
        -
      • -
        worker: Worker
      -

      Returns undefined | number

    -
    -

    getWorkerIndex

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

    findFreeWorkerKey

      - +

    • Inherit Doc

      -
      -

      Parameters

      -
        -
      • -
        worker: Worker

      Returns number

    -
    -

    getWorkerRunningTasks

    -
      - -
    • -
      -

      Inherit Doc

      -
      -

      Parameters

      -
        -
      • -
        worker: Worker
      -

      Returns undefined | number

    -
    -

    initWorkerTasksUsage

    -
      - -
    • -

      Initializes tasks usage statistics.

      -
      -
      -

      Parameters

      -
        -
      • -
        worker: Worker
        -

        The worker.

        -
      -

      Returns void

    -
    -

    Protected internalExecute

    -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        worker: Worker
        • -
      • -
        messageId: number
      -

      Returns Promise<Response>

    -
    -

    Protected internalGetBusyStatus

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

    Protected internalBusy

      - +

    • Returns boolean

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

    • Protected isMain

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

    • registerWorkerMessageListener

      @@ -536,7 +442,7 @@ Can be overridden.

      Returns void

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

    • Protected removeWorker

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

    • Protected sendToWorker

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

    • setWorkerChoiceStrategy

      - +

    • Inherit Doc

      @@ -584,11 +490,11 @@ Can be overridden.

      Parameters

      • -
        workerChoiceStrategy: "ROUND_ROBIN" | "LESS_RECENTLY_USED" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
    +
    workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"

    Returns void

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

    • Protected setupHook

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:385
    • @@ -656,33 +562,26 @@ Can be overridden.

  • constructor
  • emitter?
  • filePath
    • -
  • max?
    • -
  • nextMessageId
  • numberOfWorkers
  • opts
    • -
  • promiseMap
    • +
  • promiseResponseMap
  • workerChoiceStrategyContext
  • workers
    • -
  • workersTasksUsage
  • busy
    • -
  • numberOfRunningTasks
    • +
  • full
    • +
  • numberOfRunningTasks
  • type
    • -
  • afterPromiseWorkerResponseHook
    • +
  • afterPromiseResponseHook
  • afterWorkerSetup
    • -
  • beforePromiseWorkerResponseHook
    • +
  • beforePromiseResponseHook
  • chooseWorker
  • createAndSetupWorker
  • createWorker
  • destroy
  • destroyWorker
  • execute
    • -
  • findFreeWorker
    • -
  • getWorkerAverageTasksRunTime
    • -
  • getWorkerIndex
    • -
  • getWorkerRunningTasks
    • -
  • initWorkerTasksUsage
    • -
  • internalExecute
    • -
  • internalGetBusyStatus
    • +
  • findFreeWorkerKey
    • +
  • internalBusy
  • isMain
  • registerWorkerMessageListener
  • removeWorker