X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedClusterPool.html;h=2c2045191ea718d373dfb9b7da348d1cf8466138;hb=b4d61a7596f314145be453ddbcaa9b0dade39bfb;hp=8b00a0312a95fd1064e800327d9db7eba44bc31b;hpb=a76fac14098cf2138cf8d6997ac7c89d8c3ae508;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index 8b00a031..2c204519 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,12 +58,9 @@

    Properties

    @@ -73,19 +72,16 @@

    Methods

    -
    afterWorkerSetup +
    afterPromiseResponseHook +afterWorkerSetup +beforePromiseResponseHook chooseWorker createAndSetupWorker createWorker -decreaseWorkersTasks destroy destroyWorker execute -findFreeWorker -getWorkerIndex -getWorkerRunningTasks -increaseWorkersTask -internalExecute +findFreeWorkerKey internalGetBusyStatus isMain registerWorkerMessageListener @@ -100,7 +96,7 @@
      - +
    • Constructs a new poolifier fixed cluster pool.

      @@ -123,78 +119,60 @@

      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

    -
    emitter?: PoolEmitter
    -
    -

    Inherit Doc

    +
  • Defined in src/pools/abstract-pool.ts:32
  • -
    filePath: string
    -
    - -
    max?: number
    -
    -

    Inherit Doc

    -
    - -
    nextMessageId: number = 0
    -

    Id of the next message.

    +
    filePath: string
    +

    Path to the worker-file.

    +
  • Defined in src/pools/abstract-pool.ts:67
  • -
    numberOfWorkers: number
    +
  • Defined in src/pools/abstract-pool.ts:66
  • -
    -
    - -
    promiseMap: Map<number, PromiseWorkerResponseWrapper<Worker, Response>> = ...
    -

    The promise map.

    +
  • Defined in src/pools/cluster/fixed.ts:53
  • +
    + +
    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.

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

    Inherit Doc

    +
  • Defined in src/pools/abstract-pool.ts:42
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -203,15 +181,15 @@
    +
  • Defined in src/pools/abstract-pool.ts:52
  • -
    workers: Worker[] = []
    -
    -

    Inherit Doc

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

    @@ -219,43 +197,66 @@
    +
  • Defined in src/pools/cluster/fixed.ts:104
  • +
  • Defined in src/pools/abstract-pool.ts:141
  • +
  • Defined in src/pools/cluster/fixed.ts:99
  • Methods

    +
    + +
      + +
    • +

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

      +
      +
      +

      Parameters

      +
        +
      • +
        worker: Worker
        +

        The worker.

        +
      • +
      • +
        message: MessageValue<Response, unknown>
        +

        The received message.

        +
      +

      Returns void

    • -
      -

      Inherit Doc

      +

      {@inheritDoc}

      +

      Parameters

    +
  • Defined in src/pools/cluster/fixed.ts:93
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:289
  • +
  • Defined in src/pools/abstract-pool.ts:334
  • -
    - -
    +
  • Defined in src/pools/cluster/fixed.ts:88
  • +
  • Defined in src/pools/abstract-pool.ts:207
  • +
  • Defined in src/pools/cluster/fixed.ts:69
  • -
    - +
  • Defined in src/pools/abstract-pool.ts:192
  • +
    +
    -
    - -
    -
    - -
    -
    - -
    -
    - -
    +
  • Defined in src/pools/abstract-pool.ts:185
  • +
  • Defined in src/pools/abstract-pool.ts:177
  • +
  • Defined in src/pools/cluster/fixed.ts:64
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:276
  • +
  • Defined in src/pools/cluster/fixed.ts:75
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:156
  • +
  • Defined in src/pools/cluster/fixed.ts:59
  • +
  • Defined in src/pools/abstract-pool.ts:363