X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=bbb0411cfc7d34ca0df13f48a05e18118c24dd02;hb=811dc01fd8bb1b23cc3e6e72f7fbc82cc8f473ae;hp=eb849df04c960300dec6bba54fbacb452fe92052;hpb=d6b93f1ae5603949390418b787e0ad51b026f9c5;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index eb849df0..bbb0411c 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -1,4 +1,4 @@ -AbstractPool | poolifier
+AbstractPool | poolifier

Returns void

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

    Private checkNumberOfWorkers

    -
      - +
        +

      • Parameters

        • -
          numberOfWorkers: number
        +
        numberOfWorkers: number

    Returns void

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

    Private checkPoolOptions

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

    Private checkValidTasksQueueOptions

    +
    +

    Private checkValidWorkerChoiceStrategy

    -
      - +
        +

      • Parameters

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

      Returns void

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

    Private checkValidWorkerChoiceStrategyOptions

    +
    +

    Protected chooseWorkerNode

    -
      - +
        +

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

        +

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

        -

        Returns [number, WorkerNode<Worker, Data>]

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

    Protected createAndSetupWorker

    -
      - +
        +

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

    Protected Abstract createWorker

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

    Private dequeueTask

    -
      - +
        +

      • Parameters

        • -
          workerNodeKey: number
        -

        Returns undefined | Task<Data>

      +

      Returns undefined | Task<Data>

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

    destroy

    -
      - +
        +

      • Shutdowns every current worker in this pool.

        -

        Returns Promise<void>

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

    Protected Abstract destroyWorker

    -
      - +
        +

      • Shutdowns the given worker.

        @@ -456,219 +511,203 @@ Can be overridden.

        Parameters

        • -
          worker: Worker
          +
          worker: Worker

          A worker within workerNodes.

        -

        Returns void | Promise<void>

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

    enableTasksQueue

    +
      + +
    • +

      Enables/disables the worker tasks queue in this pool.

      +
      +
      +

      Parameters

      +
        +
      • +
        enable: boolean
        +

        Whether to enable or disable the worker tasks queue.

        +
        • +
      • +
        Optional tasksQueueOptions: TasksQueueOptions
        +

        The worker tasks queue options.

        +
      +

      Returns void

    +

    Private enqueueTask

    -
      - +
        +

      • Parameters

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

      Returns number

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

    execute

    -
      - +
        +
      • -

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

        - -

        Returns

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

        +

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

        Parameters

        • -
          data: Data
          -

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

          +
          Optional data: Data
          +

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

          +
          • +
        • +
          Optional name: string
          +

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

        -

        Returns Promise<Response>

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

    Private executeTask

    -
      - +
        +

      • Parameters

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

      Returns void

    -
    -

    findFreeWorkerNodeKey

    -
      - -
    • -

      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.

      -
      -

      Returns number

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

    Private flushTasksQueue

    -
      - +
        +

      • Parameters

        • -
          workerNodeKey: number
        +
        workerNodeKey: number

      Returns void

    -
    -

    Private flushTasksQueueByWorker

    -
    +
    +

    Private flushTasksQueues

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

    Private getWorkerNodeKey

    -
      - +
        +

      • Gets the given worker its worker node key.

        - -

        Returns

        The worker node key if the worker is found in the pool worker nodes, -1 otherwise.

        Parameters

        • -
          worker: Worker
          +
          worker: Worker

          The worker.

        -

        Returns number

    -
    -

    Private getWorkerTasksUsage

    -
      - -
    • -

      Gets the given worker its tasks usage in the pool.

      - -

      Returns

      The worker tasks usage.

      -
      -
      -

      Parameters

      -
        -
      • -
        worker: Worker
        -

        The worker.

        -
      -

      Returns undefined | TasksUsage

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

    Protected internalBusy

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

    Protected Abstract isMain

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

    Private pushWorkerNode

    -
      - +
        +

      • Pushes the given worker in the pool worker nodes.

        - -

        Returns

        The worker nodes length.

        Parameters

        • -
          worker: Worker
          +
          worker: Worker

          The worker.

        -

        Returns number

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

    Protected Abstract 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/abstract-pool.ts:537
    • +

    Private removeWorkerNode

    -
      - +
        +

      • Removes the given worker from the pool worker nodes.

        @@ -676,16 +715,16 @@ Can be overridden.

        Parameters

        • -
          worker: Worker
          +
          worker: Worker

          The worker.

        Returns void

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

    Protected Abstract sendToWorker

    -
      - +
        +

      • Sends a message to the given worker.

        @@ -693,20 +732,38 @@ Can be overridden.

        Parameters

        • -
          worker: Worker
          +
          worker: Worker

          The worker which should receive the message.

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

          The message.

        Returns void

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

    setTasksQueueOptions

    +
    +

    setWorkerChoiceStrategy

    -
      - +
        +

      • Sets the worker choice strategy in this pool.

        @@ -714,17 +771,39 @@ Can be overridden.

        Parameters

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

          The worker choice strategy.

          +
          • +
        • +
          Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
          +

          The worker choice strategy options.

          +
        +

        Returns void

    +
    +

    setWorkerChoiceStrategyOptions

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

    Private setWorkerNode

    -
      - +
        +

      • Sets the given worker in the pool worker nodes.

        @@ -732,28 +811,28 @@ Can be overridden.

        Parameters

        • -
          workerNodeKey: number
          +
          workerNodeKey: number

          The worker node key.

        • -
          worker: Worker
          +
          worker: Worker

          The worker.

        • -
          tasksUsage: TasksUsage
          +
          tasksUsage: TasksUsage

          The worker tasks usage.

        • -
          tasksQueue: Task<Data>[]
          +
          tasksQueue: Queue<Task<Data>>

          The worker task queue.

        Returns void

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

    Private setWorkerNodeTasksUsage

    -
      - +
        +

      • Sets the given worker node its tasks usage in the pool.

        @@ -761,67 +840,95 @@ Can be overridden.

        Parameters

        Returns void

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

    Protected setupHook

    -
      - +
        +

      • Setup hook to execute code before worker node are created in the abstract constructor. Can be overridden

        Returns void

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

    Private tasksQueueSize

    -
      - +
        +

      • Parameters

        • -
          workerNodeKey: number
        +
        workerNodeKey: number

      Returns number

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

    Private updateRunTimeTasksUsage

    +
    +
    +

    Private updateWaitTimeTasksUsage

    +
    +

    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:583
    • @@ -836,99 +943,111 @@ Can be overridden

    • -

    Theme

    +

    Theme

    On This Page
    +
  • constructor
    • +
  • emitter
    • +
  • filePath
    • +
  • numberOfWorkers
    • +
  • opts
    • +
  • promiseResponseMap
    • +
  • workerChoiceStrategyContext
    • +
  • workerNodes
    • +
  • busy
    • +
  • full
    • +
  • numberOfQueuedTasks
    • +
  • numberOfRunningTasks
    • +
  • size
    • +
  • type
    • +
  • afterTaskExecutionHook
    • +
  • afterWorkerSetup
    • +
  • beforeTaskExecutionHook
    • +
  • buildTasksQueueOptions
    • +
  • checkAndEmitEvents
    • +
  • checkFilePath
    • +
  • checkNumberOfWorkers
    • +
  • checkPoolOptions
    • +
  • checkValidTasksQueueOptions
    • +
  • checkValidWorkerChoiceStrategy
    • +
  • checkValidWorkerChoiceStrategyOptions
    • +
  • chooseWorkerNode
    • +
  • createAndSetupWorker
    • +
  • createWorker
    • +
  • dequeueTask
    • +
  • destroy
    • +
  • destroyWorker
    • +
  • enableTasksQueue
    • +
  • enqueueTask
    • +
  • execute
    • +
  • executeTask
    • +
  • flushTasksQueue
    • +
  • flushTasksQueues
    • +
  • getWorkerNodeKey
    • +
  • internalBusy
    • +
  • isMain
    • +
  • pushWorkerNode
    • +
  • registerWorkerMessageListener
    • +
  • removeWorkerNode
    • +
  • sendToWorker
    • +
  • setTasksQueueOptions
    • +
  • setWorkerChoiceStrategy
    • +
  • setWorkerChoiceStrategyOptions
    • +
  • setWorkerNode
    • +
  • setWorkerNodeTasksUsage
    • +
  • setupHook
    • +
  • tasksQueueSize
    • +
  • updateRunTimeTasksUsage
    • +
  • updateWaitTimeTasksUsage
    • +
  • 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
    • +
  • TaskFunctions
    • +
  • ThreadWorkerWithMessageChannel
    • +
  • WorkerAsyncFunction
    • +
  • WorkerChoiceStrategy
    • +
  • WorkerFunction
    • +
  • WorkerSyncFunction
    • +
  • KillBehaviors
    • +
  • PoolEvents
    • +
  • WorkerChoiceStrategies

    • Generated using TypeDoc

    \ No newline at end of file