X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedClusterPool.html;h=abeed306e2cc6cc3cb7787417145c354f18fbddc;hb=94ab998f44abe7ed2184a0702c45621b06f5641f;hp=fe962139bfb6f81fa119ac3053a8f35d98a8b2e8;hpb=6f0e7f0609e779dbf314d3f1a31660e7d369f591;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index fe962139..abeed306 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -6,7 +6,7 @@ poolifier +
  • The search index is not available
    • poolifier
    @@ -44,7 +44,7 @@ +
  • Defined in src/pools/cluster/fixed.ts:39
    • @@ -58,37 +58,32 @@

    Properties

    emitter? filePath -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 -internalExecute -internalGetBusyStatus +findFreeWorkerKey +internalBusy isMain registerWorkerMessageListener removeWorker @@ -131,7 +126,7 @@

    Returns FixedClusterPool<Data, Response>

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

    • Properties

    @@ -141,71 +136,61 @@

    Inherit Doc

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

    • Readonly filePath

    -
    filePath: string
    -
    -

    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

    @@ -218,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:149

    • 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.

      @@ -255,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:268

    • 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.

      @@ -294,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:257

    • Protected chooseWorker

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

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

    • destroy

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

    • destroyWorker

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

    • execute

    -
    -

    findFreeWorker

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

    findFreeWorkerKey

    -
    -

    getWorkerAverageTasksRunTime

    -
    -
    -

    getWorkerIndex

    -
    -
    -

    getWorkerRunningTasks

    -
    -
    -

    Protected internalExecute

    -
    -
    -

    Protected internalGetBusyStatus

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

    Protected internalBusy

    +
  • 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:487

    • Protected sendToWorker

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

    • setWorkerChoiceStrategy

    +
    workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"

    Returns void

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

    • Protected setupHook

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:392
    • @@ -630,31 +562,26 @@ Can be overridden.

  • constructor
  • emitter?
  • filePath
    • -
  • 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
    • -
  • internalExecute
    • -
  • internalGetBusyStatus
    • +
  • findFreeWorkerKey
    • +
  • internalBusy
  • isMain
  • registerWorkerMessageListener
  • removeWorker