X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedClusterPool.html;h=c45ee12c87cbe727863ab5443853215926dd1238;hb=e39450c0889208d6dcde666fc05b95fe7a98ee29;hp=b6a1b7225c0567f9c6034f3b8f4fd41ad52511f7;hpb=f1583b4edd427f8c3f2b4ddc652d2e102390b08e;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index b6a1b722..c45ee12c 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -1,13 +1,15 @@ -FixedClusterPool | poolifier
+FixedClusterPool | poolifier
-
+
-
+
  • 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,19 +28,23 @@

    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 execution response. This can only be serializable data.

    +

Hierarchy

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

    Properties

    Accessors

    -

    Methods

    -
    afterPromiseWorkerResponseHook +
    afterTaskExecutionHook afterWorkerSetup -beforePromiseWorkerResponseHook -chooseWorker +beforeTaskExecutionHook +chooseWorkerNode createAndSetupWorker createWorker destroy -destroyWorker +destroyWorker execute -findFreeWorker -getWorkerAverageTasksRunTime -getWorkerIndex -getWorkerRunningTasks -initWorkerTasksUsage -internalExecute -internalGetBusyStatus +findFreeWorkerNodeKey +internalBusy isMain -registerWorkerMessageListener -removeWorker +registerWorkerMessageListener sendToWorker setWorkerChoiceStrategy setupHook @@ -102,7 +97,7 @@
    -

    Returns FixedClusterPool<Data, Response>

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

    -
    emitter?: PoolEmitter
    -
    -

    Inherit Doc

    +
  • Defined in src/pools/abstract-pool.ts:41
  • -
    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:76
  • -
    numberOfWorkers: number
    +
  • Defined in src/pools/abstract-pool.ts:75
  • -
    -
    - -
    promiseMap: Map<number, PromiseWorkerResponseWrapper<Worker, Response>> = ...
    -

    The promise map.

    +
  • Defined in src/pools/cluster/fixed.ts:53
  • +
    + +
    promiseResponseMap: Map<string, PromiseResponseWrapper<Worker, Response>> = ...
    +

    The execution response promise 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 execution response 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 id.

    +
  • Defined in src/pools/abstract-pool.ts:51
  • -
    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    -

    Worker choice strategy instance implementing the worker choice algorithm.

    -

    Default to a strategy implementing a round robin algorithm.

    +
    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    +

    Worker choice strategy context referencing a worker choice algorithm implementation.

    +

    Default to a round robin algorithm.

    -
    - -
    workers: Worker[] = []
    -
    -

    Inherit Doc

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

    Inherit Doc

    +

    Inherited from AbstractPool.workerChoiceStrategyContext

    + +
    + +
    workerNodes: WorkerNode<Worker, Data>[] = []
    +

    Pool worker nodes.

    +

    Accessors

    -
    - -
    +
    + +
      +
    • get full(): boolean
    • +
    • +

      Whether the pool is full or not.

      +

      The pool filling boolean status.

      +
      +

      Returns boolean

    +
    + +
      +
    • get numberOfQueuedTasks(): number
    • +
    • +

      Number of tasks queued in the pool.

      +
      +

      Returns number

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

      Inherit Doc

      +

      Number of tasks running in the pool.

      +

      Returns number

    +
  • Defined in src/pools/abstract-pool.ts:176
    • -
    • get type(): PoolType
    • +
    • get type(): PoolType
    • -
      -

      Inherit Doc

      -

      Returns PoolType

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

    -
    - +
    +
      - +
    • -

      Hook executed after the worker task promise resolution. +

      Hook executed after the worker task execution. 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:335
    • -
      -

      Inherit Doc

      +

      Function that can be hooked up when a worker has been newly created and moved to the pool worker nodes.

      +

      Can be used to update the maxListeners or binding the main-worker<->worker connection if not bind by default.

      +

      Parameters

      • -
        worker: Worker
      +
      worker: Worker
      +

      The newly created worker.

      +

    Returns void

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

      Hook executed before the worker task promise resolution. +

      Hook executed before the worker task execution. Can be overridden.

      Parameters

      • -
        worker: Worker
        -

        The worker.

        +
        workerNodeKey: number
        +

        The worker node key.

      Returns void

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

      Chooses a worker for the next task.

      -

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

      +

      Chooses a worker node for the next task.

      +

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

      -

      Returns

      Worker.

      +

      Returns

      [worker node key, worker node].

      -

      Returns Worker

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

      Creates a new worker for this pool and sets it up completely.

      +

      Creates a new worker and sets it up completely in the pool worker nodes.

      Returns

      New, completely set up worker.

      Returns Worker

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

      Inherit Doc

      +

      Shutdowns the given worker.

      +

      Parameters

      • -
        worker: Worker
      +
      worker: Worker
      +

      A worker within workerNodes.

      +

    Returns void

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

      Inherit Doc

      -
      -

      Parameters

      -
        -
      • -
        data: Data
      -

      Returns Promise<Response>

    -
    - -
      - -
    • -
      -

      Inherit Doc

      -

      Returns false | Worker

    -
    - -
      - -
    • -
      -

      Inherit Doc

      -
      -

      Parameters

      -
        -
      • -
        worker: Worker
      -

      Returns undefined | number

    -
    - -
      - -
    • -
      -

      Inherit Doc

      -
      -

      Parameters

      -
        -
      • -
        worker: Worker
      -

      Returns number

    -
    - -
      - -
    • -
      -

      Inherit Doc

      -
      -

      Parameters

      -
        -
      • -
        worker: Worker
      -

      Returns undefined | number

    -
    - -
      - +
    • -

      Initializes tasks usage statistics.

      +

      Performs the task specified in the constructor with the data parameter.

      + +

      Returns

      Promise that will be resolved when the task is successfully completed.

      Parameters

      • -
        worker: Worker
        -

        The worker.

        +
        data: Data
        +

        The input for the specified task. This can only be serializable data.

      -

      Returns void

    -
    - -
    +
    + +
      +
    • -
      -

      Parameters

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

      Returns Promise<Response>

    -
    - +
  • Defined in src/pools/abstract-pool.ts:249
  • +
    +
    +
  • Defined in src/pools/abstract-pool.ts:244
  • -
    - -
      - +
    • Defined in src/pools/cluster/fixed.ts:64
    +
    + +
      +
    • -
      -

      Inherit Doc

      +

      Registers a listener callback on the given worker.

      +

      Type Parameters

        @@ -519,103 +457,96 @@ Can be overridden.

        Parameters

        • -
          worker: Worker
        • +
          worker: Worker
          +

          The worker which should register a listener.

          +
        • -
          listener: ((message: MessageValue<Message, unknown>) => void)
          +
          listener: ((message: MessageValue<Message, unknown>) => void)
          +

          The message listener callback.

          +
            • -
            • (message: MessageValue<Message, unknown>): void
            • +
            • (message: MessageValue<Message, unknown>): void
            • Parameters

              • -
                message: MessageValue<Message, unknown>
              +
              message: MessageValue<Message, unknown>

    Returns void

    Returns void

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

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

    +
  • Defined in src/pools/abstract-pool.ts:209
  • +
  • Defined in src/pools/cluster/fixed.ts:59
  • - +
    +
    -
    +
  • constructor
  • +
  • emitter
  • +
  • filePath
  • +
  • numberOfWorkers
  • +
  • opts
  • +
  • promiseResponseMap
  • +
  • workerChoiceStrategyContext
  • +
  • workerNodes
  • +
  • busy
  • +
  • full
  • +
  • numberOfQueuedTasks
  • +
  • numberOfRunningTasks
  • +
  • type
  • +
  • afterTaskExecutionHook
  • +
  • afterWorkerSetup
  • +
  • beforeTaskExecutionHook
  • +
  • chooseWorkerNode
  • +
  • createAndSetupWorker
  • +
  • createWorker
  • +
  • destroy
  • +
  • destroyWorker
  • +
  • execute
  • +
  • findFreeWorkerNodeKey
  • +
  • internalBusy
  • +
  • isMain
  • +
  • registerWorkerMessageListener
  • +
  • sendToWorker
  • +
  • setWorkerChoiceStrategy
  • +
  • setupHook
  • +
  • workerListener
  • + +

    Generated using TypeDoc

    -
    \ No newline at end of file +
    \ No newline at end of file