X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicClusterPool.html;h=6383bbff27f10fe587f8d7256ef7c439111292d4;hb=fbc22127e53d3ec0ecbd38ecea25fb92ebef50e7;hp=adb3ab28e4f45c1b2df59f518299961e7f1b5319;hpb=94ab998f44abe7ed2184a0702c45621b06f5641f;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index adb3ab28..6383bbff 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -1,4 +1,4 @@ -DynamicClusterPool | poolifier
+DynamicClusterPool | poolifier
-
+
  • poolifier
  • @@ -28,21 +28,21 @@ When the maximum number of workers is reached and workers are busy, an event is

    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:16
@@ -50,53 +50,55 @@ When the maximum number of workers is reached and workers are busy, an event is

Constructors

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

      @@ -104,434 +106,506 @@ When the maximum number of workers is reached and workers are busy, an event is

      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:28
  • Properties

    -
    +
    -
    emitter?: PoolEmitter
    -
    -

    Inherit Doc

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

    Path to the worker-file.

    +
    filePath: string
    +

    Path to the worker file.

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

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

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

    Number of workers that this pool should manage.

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

    Options for this fixed cluster pool.

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

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

      Inherit Doc

      +

      Whether the pool is full or not.

      +

      The pool filling boolean status.

      +

      Returns boolean

    -
    +
  • Defined in src/pools/cluster/dynamic.ts:43
  • +
    + +
      +
    • get numberOfQueuedTasks(): number
    • +
    • +

      Number of tasks queued in the pool.

      +
      +

      Returns number

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

        Number of tasks concurrently running in the pool.

        +

        Number of tasks running in the pool.

        Returns number

    -
    +
  • Defined in src/pools/abstract-pool.ts:185
  • +
    -
      -
    • get type(): PoolType
    • +
    +
  • Defined in src/pools/cluster/dynamic.ts:38
  • 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

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

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

    -
    - -
    +
    + +
      +
    • -
      -

      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

    -
    - -
    +
    + +
      +
    • -
      -

      Inherit Doc

      -

      Returns number

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

      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>

    Returns void

    Returns void

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

    Returns void

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

    On This Page

    - -
    +
  • constructor
  • +
  • emitter
  • +
  • filePath
  • +
  • max
  • +
  • numberOfWorkers
  • +
  • opts
  • +
  • promiseResponseMap
  • +
  • workerChoiceStrategyContext
  • +
  • workerNodes
  • +
  • busy
  • +
  • full
  • +
  • numberOfQueuedTasks
  • +
  • numberOfRunningTasks
  • +
  • type
  • +
  • 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