X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicClusterPool.html;h=33d2afd58c6e9a31091c177e8a41426704b705cf;hb=184d530faf6acf70e116cb4a3fb831938b73e2c0;hp=c2a71928d2e7e05a2fd0822e52d4553862b13786;hpb=7cd8af0033b35def46016a78ea9be1ee516480bf;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index c2a71928..33d2afd5 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -1,4 +1,4 @@ -DynamicClusterPool | poolifier
+DynamicClusterPool | poolifier
-
+
  • poolifier
  • @@ -24,25 +24,25 @@ When the maximum number of workers is reached and workers are busy, an event is

    Since

    2.0.0

-
+

Type Parameters

-
    +
    • -

      Data = unknown

      +

      Data = unknown

      Type of data sent to the worker. This can only be serializable data.

    • -

      Response = unknown

      -

      Type of response of execution. This can only be serializable data.

      +

      Response = unknown

      +

      Type of execution response. This can only be serializable data.

Hierarchy

+
  • Defined in src/pools/cluster/dynamic.ts:15
  • @@ -50,504 +50,604 @@ When the maximum number of workers is reached and workers are busy, an event is

    Constructors

    -
    +
    -
      - +
        +
      • Constructs a new poolifier dynamic cluster pool.

        -
        +

        Type Parameters

        -
          +
          • -

            Data = unknown

          • +

            Data = unknown

          • -

            Response = unknown

        +

        Response = unknown

    Parameters

    • -
      min: number
      +
      min: number

      Minimum number of workers which are always active.

    • -
      max: number
      +
      max: number

      Maximum number of workers that can be created by this pool.

    • -
      filePath: string
      +
      filePath: string

      Path to an implementation of a ClusterWorker file, which can be relative or absolute.

    • -
      opts: ClusterPoolOptions = {}
      +
      opts: ClusterPoolOptions = {}

      Options for this dynamic cluster pool.

    -

    Returns DynamicClusterPool<Data, Response>

    +
  • Defined in src/pools/cluster/dynamic.ts:27
  • Properties

    -
    +
    -
    emitter?: PoolEmitter
    -
    -

    Inherit Doc

    -
    - -
    filePath: string
    -

    Path to the worker-file.

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

    Path to the worker file.

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

    Maximum number of workers that can be created by this pool.

    -
    - -
    numberOfWorkers: number
    +
  • Defined in src/pools/cluster/dynamic.ts:29
  • +
    + +
    numberOfWorkers: number

    Number of workers that this pool should manage.

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

    Options for this fixed cluster pool.

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

    The promise response map.

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

    The execution response promise map.

    • key: The message id of each submitted task.
    • -
    • value: An object that contains the worker, the promise resolve and reject callbacks.
    • +
    • 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 with the promise resolve/reject bound to 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:57
  • +
    -
    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    +
    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>

    Worker choice strategy context referencing a worker choice algorithm implementation.

    Default to a round robin algorithm.

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

    Inherit Doc

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

    Pool worker nodes.

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

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

      Inherit Doc

      +

      Whether the pool is full or not.

      +

      The pool filling boolean status.

      +

      Returns boolean

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

      Number of tasks concurrently running in the pool.

      +

      Pool minimum size.

      Returns number

    -
    - -
    +
    + +
      +
    • get type(): "fixed" | "dynamic"
    • -
      -

      Inherit Doc

      -

      Returns PoolType

    +
  • Defined in src/pools/cluster/dynamic.ts:37
  • +
    + +
      +
    • get worker(): "cluster" | "thread"
    • +
    • +

      Gets the worker type.

      +
      +

      Returns "cluster" | "thread"

    Methods

    -
    - -
    +
    -
      - +
        +
      • -
        -

        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

    -
    - -
    +
    + +
    -
    - -
    +
    + +
      +
    • -

      Chooses a worker for the next task.

      -

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

      - -

      Returns

      [worker key, worker].

      +

      Chooses a worker node for the next task.

      +

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

      -

      Returns [number, Worker]

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

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

        - -

        Returns

        New, completely set up worker.

        +

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

        -

        Returns Worker

    -
    +
  • Defined in src/pools/abstract-pool.ts:596
  • +
    -
    -
    +
  • Defined in src/pools/cluster/fixed.ts:92
  • +
    -
    -
    - -
    +
    + +
      +
    • -
      -

      Inherit Doc

      +

      Shutdowns the given worker.

      +

      Parameters

      • -
        worker: Worker
      +
      worker: Worker
      +

      A worker within workerNodes.

      +

    Returns void

    -
    - -
    +
    + +
      +
    • -
      -

      Inherit Doc

      +

      Enables/disables the worker tasks queue in this pool.

      +

      Parameters

      • -
        data: Data
      -

      Returns Promise<Response>

    • +
    • +
      Optional tasksQueueOptions: TasksQueueOptions
      +

      The worker tasks queue options.

      +
    +

    Returns void

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

    Parameters

    Returns void

    Returns void

    -
    - -
    +
    + +
    -
    - -
    +
    + +

    Returns void

    -
    +
  • Defined in src/pools/abstract-pool.ts:337
  • +
    -
    -
    +
  • Defined in src/pools/abstract-pool.ts:284
  • +
    + +
    +
    -
    -
    +
  • Defined in src/pools/cluster/fixed.ts:63
  • +
    -
    - +
    +
    +
    +

    On This Page

    - -
    +
  • constructor
  • +
  • emitter
  • +
  • filePath
  • +
  • max
  • +
  • numberOfWorkers
  • +
  • opts
  • +
  • promiseResponseMap
  • +
  • workerChoiceStrategyContext
  • +
  • workerNodes
  • +
  • busy
  • +
  • full
  • +
  • info
  • +
  • maxSize
  • +
  • minSize
  • +
  • type
  • +
  • worker
  • +
  • afterTaskExecutionHook
  • +
  • afterWorkerSetup
  • +
  • beforeTaskExecutionHook
  • +
  • chooseWorkerNode
  • +
  • createAndSetupWorker
  • +
  • createWorker
  • +
  • destroy
  • +
  • destroyWorker
  • +
  • enableTasksQueue
  • +
  • execute
  • +
  • internalBusy
  • +
  • isMain
  • +
  • registerWorkerMessageListener
  • +
  • sendToWorker
  • +
  • setTasksQueueOptions
  • +
  • setWorkerChoiceStrategy
  • +
  • setWorkerChoiceStrategyOptions
  • +
  • setupHook
  • +
  • workerListener
  • + +

    Generated using TypeDoc

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