X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicClusterPool.html;h=04a93b1b4670f98d81eaa1afd7d0ef827b238d8a;hb=67de15a041152a973334839ad2c73284b1b3cbb3;hp=2ade942cc1ea7b0e9fdd3cf7317abf0a95cd8522;hpb=6c525543a7ed67a926b7c1f4bf98985aaad1f088;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index 2ade942c..04a93b1b 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -1,4 +1,4 @@ -DynamicClusterPool | poolifier
+DynamicClusterPool | poolifier
-
+

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

    Constructors

    -
    constructor +
    constructor

    Properties

    -
    emitter? -filePath -max -numberOfWorkers -opts -promiseResponseMap -workerChoiceStrategyContext -workerNodes +
    emitter? +filePath +max +numberOfWorkers +opts +promiseResponseMap +workerChoiceStrategyContext +workerNodes

    Accessors

    -
    busy -full -numberOfQueuedTasks -numberOfRunningTasks -type +
    busy +full +numberOfQueuedTasks +numberOfRunningTasks +type

    Methods

    -
    afterTaskExecutionHook -afterWorkerSetup -beforeTaskExecutionHook -chooseWorkerNode -createAndSetupWorker -createWorker -destroy -destroyWorker -execute -findFreeWorkerNodeKey -internalBusy -isMain -registerWorkerMessageListener -sendToWorker -setWorkerChoiceStrategy -setupHook -workerListener +
    afterTaskExecutionHook +afterWorkerSetup +beforeTaskExecutionHook +chooseWorkerNode +createAndSetupWorker +createWorker +destroy +destroyWorker +enableTasksQueue +execute +internalBusy +isMain +registerWorkerMessageListener +sendToWorker +setTasksQueueOptions +setWorkerChoiceStrategy +setWorkerChoiceStrategyOptions +setupHook +workerListener

    Constructors

    -
    +

    constructor

    -
      - +
        +

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

    • Properties

    -
    +

    Optional Readonly emitter

    -
    emitter?: PoolEmitter
    +
    emitter?: PoolEmitter

    Emitter on which events can be listened to.

    Events that can currently be listened to:

      @@ -144,41 +146,41 @@ When the maximum number of workers is reached and workers are busy, an event is
    -
    +
  • Defined in src/pools/abstract-pool.ts:43
    • +

    Readonly filePath

    -
    filePath: string
    -

    Path to the worker-file.

    +
    filePath: string
    +

    Path to the worker file.

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

    Readonly max

    -
    max: number
    +
    max: number

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

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

    Readonly numberOfWorkers

    -
    numberOfWorkers: number
    +
    numberOfWorkers: number

    Number of workers that this pool should manage.

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

    Readonly opts

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

    Options for this fixed cluster pool.

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

    Protected promiseResponseMap

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

    The execution response promise map.

    • key: The message id of each submitted task.
      • @@ -188,29 +190,29 @@ When the maximum number of workers is reached and workers are busy, an event is
    -
    +
  • Defined in src/pools/abstract-pool.ts:53
    • +

    Protected workerChoiceStrategyContext

    -
    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.

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

    Readonly workerNodes

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

    Pool worker nodes.

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

    • Accessors

    -
    -

    busy

    -
      +
      +

      Protected busy

      +
      • get busy(): boolean

      • Whether the pool is busy or not.

        @@ -219,10 +221,10 @@ When the maximum number of workers is reached and workers are busy, an event is

        Returns boolean

      -
      -

      full

      -
    +
    +

    Protected full

    +
    • get full(): boolean

    • Whether the pool is full or not.

      @@ -231,10 +233,10 @@ When the maximum number of workers is reached and workers are busy, an event is

      Returns boolean

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

    Private numberOfQueuedTasks

    -
      +
      • get numberOfQueuedTasks(): number

      • Number of tasks queued in the pool.

        @@ -242,10 +244,10 @@ When the maximum number of workers is reached and workers are busy, an event is

        Returns number

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

    Private numberOfRunningTasks

    -
      +
      • get numberOfRunningTasks(): number

      • Number of tasks running in the pool.

        @@ -253,25 +255,25 @@ When the maximum number of workers is reached and workers are busy, an event is

        Returns number

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

    type

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

    • Methods

    -
    +

    Protected afterTaskExecutionHook

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

    Protected afterWorkerSetup

    -
      - +
        +

      • 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.

        @@ -303,17 +305,17 @@ Can be overridden.

        Parameters

        • -
          worker: Worker
          +
          worker: Worker

          The newly created worker.

        Returns void

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

    Protected beforeTaskExecutionHook

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

    Protected chooseWorkerNode

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

    Protected createAndSetupWorker

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

    Protected createWorker

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

    destroy

    -
    -
    -

    destroyWorker

    -
    +
    +

    Protected destroyWorker

    +
      +

    • Shutdowns the given worker.

      @@ -389,110 +389,116 @@ Can be overridden.

      Parameters

      • -
        worker: Worker
        +
        worker: Worker

        A worker within workerNodes.

    Returns void

    -
    -

    execute

    -
    +
    +

    enableTasksQueue

    +
      +
    • -

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

      - -

      Returns

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

      +

      Enables/disables the worker tasks queue in this pool.

      Parameters

      • -
        data: Data
        -

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

        +
        enable: boolean
        +

        Whether to enable or disable the worker tasks queue.

        +
        • +
      • +
        Optional tasksQueueOptions: TasksQueueOptions
        +

        The worker tasks queue options.

      -

      Returns Promise<Response>

    -
    -

    findFreeWorkerNodeKey

    -
    +
    +

    execute

    +
      +
    • -

      Finds a free worker node key based on the number of tasks the worker has applied.

      -

      If a worker is found with 0 running tasks, it is detected as free and its worker node key is returned.

      -

      If no free worker is found, -1 is returned.

      - -

      Returns

      A worker node key if there is one, -1 otherwise.

      +

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

      -

      Returns number

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

    Protected internalBusy

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

    Protected isMain

    -
    -
    -

    registerWorkerMessageListener

    -
    +
    +

    Protected registerWorkerMessageListener

    +
      +

    • 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.

    Returns void

    Returns void

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

    Protected sendToWorker

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

    setTasksQueueOptions

    +
    +

    setWorkerChoiceStrategy

    -
      - +
        +

      • Sets the worker choice strategy in this pool.

        @@ -522,17 +546,39 @@ Can be overridden.

        Parameters

        • -
          workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
          +
          workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"

          The worker choice strategy.

          +
          • +
        • +
          Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
          +

          The worker choice strategy options.

        Returns void

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

    setWorkerChoiceStrategyOptions

    +
    +

    Protected setupHook

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

    Protected workerListener

    -
      - +
        +

      • This function is the listener registered for each worker message.

        - -

        Returns

        The listener function to execute when a message is received from a worker.

        -

        Returns ((message: MessageValue<Response, unknown>) => void)

        +

        Returns ((message) => void)

        The listener function to execute when a message is received from a worker.

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

            • This function is the listener registered for each worker message.

              - -

              Returns

              The listener function to execute when a message is received from a worker.

              Parameters

              -

              Returns void

        +

        Returns void

        The listener function to execute when a message is received from a worker.

        +
    +
  • Defined in src/pools/abstract-pool.ts:505
    • @@ -583,77 +627,89 @@ Can be overridden

    • -

    Theme

    +

    Theme

    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
    • +
  • PoolType
    • +
  • AbstractPool
    • +
  • AbstractWorker
    • +
  • CircularArray
    • +
  • ClusterWorker
    • +
  • DynamicClusterPool
    • +
  • DynamicThreadPool
    • +
  • FixedClusterPool
    • +
  • FixedThreadPool
    • +
  • PoolEmitter
    • +
  • Queue
    • +
  • ThreadWorker
    • +
  • WorkerChoiceStrategyContext
    • +
  • ClusterPoolOptions
    • +
  • IPool
    • +
  • IWorker
    • +
  • IWorkerChoiceStrategy
    • +
  • MessageValue
    • +
  • PoolOptions
    • +
  • PromiseResponseWrapper
    • +
  • RequiredStatistics
    • +
  • Task
    • +
  • TasksQueueOptions
    • +
  • TasksUsage
    • +
  • WorkerChoiceStrategyOptions
    • +
  • WorkerNode
    • +
  • WorkerOptions
    • +
  • Draft
    • +
  • ErrorHandler
    • +
  • ExitHandler
    • +
  • KillBehavior
    • +
  • MessageHandler
    • +
  • OnlineHandler
    • +
  • PoolEvent
    • +
  • ThreadWorkerWithMessageChannel
    • +
  • WorkerAsyncFunction
    • +
  • WorkerChoiceStrategy
    • +
  • WorkerFunction
    • +
  • WorkerSyncFunction
    • +
  • KillBehaviors
    • +
  • PoolEvents
    • +
  • WorkerChoiceStrategies

    • Generated using TypeDoc

    \ No newline at end of file