X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicClusterPool.html;h=afc454110a1456263a093f9170ec3efaa683cbec;hb=aba8d9bd41f1bd46f3cc3863c0c2e74bdfacb7b6;hp=d12c5c0ec1fd026208c99d09e4515a5b1572ece6;hpb=1b0aa06b3ab5cf8ae8bd135087143165889901cc;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index d12c5c0e..afc45411 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -1,4 +1,4 @@ -DynamicClusterPool | poolifier
+DynamicClusterPool | poolifier
-
+
  • poolifier
  • @@ -19,30 +19,33 @@

    A cluster pool with a dynamic number of workers, but a guaranteed minimum number of workers.

    This cluster pool creates new workers when the others are busy, up to the maximum number of workers. When the maximum number of workers is reached and workers are busy, an event is emitted. If you want to listen to this event, use the pool's emitter.

    +
    +
    +

    Author

    Christopher Quadflieg

    -

    Author

    Christopher Quadflieg

    - -

    Since

    2.0.0

    +

    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,593 +53,668 @@ 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>

    Properties

    -
    - -
    emitter?: PoolEmitter
    -
    -

    Inherit Doc

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

    Options for this fixed cluster pool.

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

    The promise response map.

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

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

    Worker choice strategy context referencing a worker choice algorithm implementation.

    -

    Default to a round robin algorithm.

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

    Inherit Doc

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

    Pool worker nodes.

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

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

      Whether the pool is full or not.

      +

      The pool filling boolean status.

      +
      +

      Returns boolean

      +
    +
    + +
      +
    • get info(): PoolInfo
    • -

      Number of tasks queued in the pool.

      +

      Pool information.

      -

      Returns number

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

      Number of tasks running in the pool.

      +

      Pool maximum size.

      -

      Returns number

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

      Inherit Doc

      -

      Returns PoolType

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

      Pool type.

      +

      If it is 'dynamic', it provides the max property.

      +
      +

      Returns "fixed" | "dynamic"

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

    Methods

    -
    - -
      - +
      + +
        +
      • -

        Hook executed after the worker task promise resolution. +

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

        Parameters

        • -
          worker: Worker
          +
          worker: Worker

          The worker.

          -
        • +
        +
      • -
        message: MessageValue<Response, unknown>
        +
        message: MessageValue<Response, unknown, Worker | MessagePort>

        The received message.

        -
      -

      Returns void

    -
    - -
      - + +
    +

    Returns void

    +
    +
    + +
      +
    • -
      -

      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
      -

      Returns void

    +

    Returns void

    +
    -
    - -
    +
    + +
      +
    • -

      Hook executed before the worker task promise resolution. +

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

      Parameters

      • -
        workerNodeKey: number
        +
        workerNodeKey: number

        The worker node key.

        -
      -

      Returns void

    -
    - -
      - + +
      +
    • +
      task: Task<Data>
      +

      The task to execute.

      +
      +
    +

    Returns void

    +
    +
    + +
      +
    • -

      Chooses a worker node for the next task.

      -

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

      - -

      Returns

      [worker node key, worker node].

      +

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

      -

      Returns [number, WorkerNode<Worker, Data>]

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

      Inherit Doc

      +

      Terminates the given worker.

      +

      Parameters

      • -
        worker: Worker
      -

      Returns void

    +

    Returns void

    +
    -
    - -
    +
    + +
      +
    • +

      Enables/disables the worker tasks queue in this pool.

      +

      Parameters

      • -
        workerNodeKey: number
      • +
        enable: boolean
        +

        Whether to enable or disable the worker tasks queue.

        +
        +
      • -
        task: Task<Data>
      -

      Returns void

    -
    - -
      - +
      Optional tasksQueueOptions: TasksQueueOptions
      +

      The worker tasks queue options.

      +
      +
    +

    Returns void

    +
    +
    + +
      +
    • -
      -

      Inherit Doc

      +

      Executes the specified function in the worker constructor with the task data input parameter.

      +

      Parameters

      • -
        data: Data
      -

      Returns Promise<Response>

    • +
    • +
      Optional name: string
      +

      The name of the worker function to execute. If not specified, the default worker function will be executed.

      +
      +
    +

    Returns Promise<Response>

    Promise that will be fulfilled when the task is completed.

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

      Inherit Doc

      -
      +

      Registers a listener callback on the given worker.

      +
      +

      Type Parameters

      -
        +
        • -

          Message

      +

      Message

    Parameters

    • -
      worker: Worker
    • +
      worker: Worker
      +

      The worker which should register a listener.

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

      The message listener callback.

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

            • -
              message: MessageValue<Message, unknown>
            +
            message: MessageValue<Message, unknown, Worker | MessagePort>

    Returns void

    -

    Returns void

    -
    - -
    +
    + +
    -
    - - +

    Returns void

    +
    +
    + +
    -
    - - +

    Returns void

    +
    +
    + + +

    Returns void

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

    Returns void

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

    On This Page

    - -
    +
  • constructor
  • +
  • emitter
  • +
  • filePath
  • +
  • max
  • +
  • numberOfWorkers
  • +
  • opts
  • +
  • promiseResponseMap
  • +
  • workerChoiceStrategyContext
  • +
  • workerNodes
  • +
  • busy
  • +
  • full
  • +
  • info
  • +
  • maxSize
  • +
  • minSize
  • +
  • type
  • +
  • worker
  • +
  • afterTaskExecutionHook
  • +
  • afterWorkerSetup
  • +
  • beforeTaskExecutionHook
  • +
  • createAndSetupDynamicWorker
  • +
  • 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