X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=2ad84030c0ad3877aa7c0fff0a4e8cf19f0d82a8;hb=6be0ab6d5c78c8e91cc4668d3d03db95f15cbfab;hp=7efd9779ab1e386b03c87ca8ffb0a7f53c7749e9;hpb=6709f3086622c12bae8060915be7a7f6be9d9763;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 7efd9779..2ad84030 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,4 +1,4 @@ -IPool | poolifier
+IPool | poolifier

Contract definition for a poolifier pool.

-
-
+
+
+

Type Parameters

-
    +
    • -

      Worker extends IWorker

      +

      Worker extends IWorker

      Type of worker which manages this pool.

      -
      • + +
    • -

      Data = unknown

      +

      Data = unknown

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

      -
      • + +
    • -

      Response = unknown

      +

      Response = unknown

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

      -
+ +

Hierarchy

+
  • Defined in src/pools/pool.ts:158
    • @@ -50,55 +54,58 @@

    Properties

    -
    destroy -emitter? -enableTasksQueue -execute -findFreeWorkerNodeKey -setTasksQueueOptions -setWorkerChoiceStrategy -setWorkerChoiceStrategyOptions -type -workerNodes +
    destroy +emitter? +enableTasksQueue +execute +info +setTasksQueueOptions +setWorkerChoiceStrategy +setWorkerChoiceStrategyOptions +workerNodes

    Properties

    -
    -

    destroy

    -
    destroy: (() => Promise<void>)
    +
    +

    destroy

    +
    destroy: (() => Promise<void>)

    Type declaration

    • -
        -
      • (): Promise<void>
        • +
          +
        • (): Promise<void>
        • -

          Shutdowns every current worker in this pool.

          +

          Terminate every current worker in this pool.

          -

          Returns Promise<void>

    -
    -

    Optional Readonly emitter

    -
    emitter?: PoolEmitter
    +
  • Defined in src/pools/pool.ts:193
    • +
    +

    Optional Readonly emitter

    +
    emitter?: PoolEmitter

    Emitter on which events can be listened to.

    Events that can currently be listened to:

    • 'full': Emitted when the pool is dynamic and full.
    • 'busy': Emitted when the pool is busy.
      • +
    • 'error': Emitted when an uncaught error occurs.
      • +
    • 'taskError': Emitted when an error occurs while executing a task.
    -
    -
    -

    enableTasksQueue

    -
    enableTasksQueue: ((enable: boolean, opts?: TasksQueueOptions) => void)
    +
  • Defined in src/pools/pool.ts:181
    • +
    +

    enableTasksQueue

    +
    enableTasksQueue: ((enable, tasksQueueOptions?) => void)

    Type declaration

    • -
        -
      • (enable: boolean, opts?: TasksQueueOptions): void
        • +
          +
        • (enable, tasksQueueOptions?): void

        • Enables/disables the worker tasks queue in this pool.

          @@ -106,66 +113,66 @@

          Parameters

          • -
            enable: boolean
            +
            enable: boolean

            Whether to enable or disable the worker tasks queue.

            -
            • +
    +
  • -
    Optional opts: TasksQueueOptions
    • -

    Returns void

    -
    -

    execute

    -
    execute: ((data: Data) => Promise<Response>)
    +
  • Defined in src/pools/pool.ts:218
    • +
    +

    execute

    +
    execute: ((data?, name?) => Promise<Response>)

    Type declaration

    • -
        -
      • (data: Data): Promise<Response>
        • +
          +
        • (data?, name?): Promise<Response>
        • -

          Executes the function specified in the constructor with the task 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.

            -
          -

          Returns Promise<Response>

    -
    -

    findFreeWorkerNodeKey

    -
    findFreeWorkerNodeKey: (() => number)
    -
    -

    Type declaration

    -
      -
    • -
        -
      • (): number
        • -
      • -

        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.

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

    Promise that will be fulfilled when the task is completed.

    -

    Returns

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

    +
    +
    +

    Readonly info

    +
    info: PoolInfo
    +

    Pool information.

    -

    Returns number

    -
    -

    setTasksQueueOptions

    -
    setTasksQueueOptions: ((tasksQueueOptions: TasksQueueOptions) => void)
    +
  • Defined in src/pools/pool.ts:166
    • +
    +

    setTasksQueueOptions

    +
    setTasksQueueOptions: ((tasksQueueOptions) => void)

    Type declaration

    • -
        -
      • (tasksQueueOptions: TasksQueueOptions): void
        • +
          +
        • (tasksQueueOptions): void

        • Sets the worker tasks queue options in this pool.

          @@ -173,21 +180,23 @@

          Parameters

    -

    Returns void

    -
    -

    setWorkerChoiceStrategy

    -
    setWorkerChoiceStrategy: ((workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN", workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions) => void)
    +
  • Defined in src/pools/pool.ts:227
    • +
    +

    setWorkerChoiceStrategy

    +
    setWorkerChoiceStrategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void)

    Type declaration

    • -
        -
      • (workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN", workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions): void
        • +
          +
        • (workerChoiceStrategy, workerChoiceStrategyOptions?): void

        • Sets the worker choice strategy in this pool.

          @@ -195,25 +204,28 @@

          Parameters

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

            The worker choice strategy.

            -
            • +
    +
  • -
    Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
    +
    Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptions

    The worker choice strategy options.

    -
    • -

    Returns void

    -
    -

    setWorkerChoiceStrategyOptions

    -
    setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions: WorkerChoiceStrategyOptions) => void)
    +
  • Defined in src/pools/pool.ts:200
    • +
    +

    setWorkerChoiceStrategyOptions

    +
    setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void)

    Type declaration

    -

    Returns void

    -
    -

    Readonly type

    -
    type: PoolType
    -

    Pool type.

    -

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

    -
    -
    -

    Readonly workerNodes

    -
    workerNodes: WorkerNode<Worker, Data>[]
    +
  • Defined in src/pools/pool.ts:209
    • +
    +

    Readonly workerNodes

    +
    workerNodes: WorkerNode<Worker, Data>[]

    Pool worker nodes.

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

    Settings

     +

    Settings

    Member Visibility

    @@ -256,62 +263,81 @@
    • -

    Theme

    +

    Theme

    -

    On This Page

     +

    On This Page

    +
  • destroy
    • +
  • emitter
    • +
  • enableTasksQueue
    • +
  • execute
    • +
  • info
    • +
  • setTasksQueueOptions
    • +
  • setWorkerChoiceStrategy
    • +
  • setWorkerChoiceStrategyOptions
    • +
  • workerNodes
    • -
    +
  • AbstractPool
    • +
  • AbstractWorker
    • +
  • CircularArray
    • +
  • ClusterWorker
    • +
  • DynamicClusterPool
    • +
  • DynamicThreadPool
    • +
  • FixedClusterPool
    • +
  • FixedThreadPool
    • +
  • PoolEmitter
    • +
  • Queue
    • +
  • ThreadWorker
    • +
  • WorkerChoiceStrategyContext
    • +
  • ClusterPoolOptions
    • +
  • EventLoopUtilizationMeasurementStatistics
    • +
  • IPool
    • +
  • IWorker
    • +
  • IWorkerChoiceStrategy
    • +
  • MeasurementOptions
    • +
  • MeasurementStatistics
    • +
  • MeasurementStatisticsRequirements
    • +
  • MessageValue
    • +
  • PoolInfo
    • +
  • PoolOptions
    • +
  • PromiseResponseWrapper
    • +
  • Task
    • +
  • TaskError
    • +
  • TaskPerformance
    • +
  • TaskStatistics
    • +
  • TaskStatisticsRequirements
    • +
  • TasksQueueOptions
    • +
  • ThreadPoolOptions
    • +
  • WorkerChoiceStrategyOptions
    • +
  • WorkerNode
    • +
  • WorkerOptions
    • +
  • WorkerStatistics
    • +
  • WorkerUsage
    • +
  • Draft
    • +
  • ErrorHandler
    • +
  • ExitHandler
    • +
  • KillBehavior
    • +
  • Measurement
    • +
  • MessageHandler
    • +
  • OnlineHandler
    • +
  • PoolEvent
    • +
  • PoolType
    • +
  • TaskFunctions
    • +
  • ThreadWorkerWithMessageChannel
    • +
  • WorkerAsyncFunction
    • +
  • WorkerChoiceStrategy
    • +
  • WorkerFunction
    • +
  • WorkerSyncFunction
    • +
  • WorkerType
    • +
  • KillBehaviors
    • +
  • Measurements
    • +
  • PoolEvents
    • +
  • PoolTypes
    • +
  • WorkerChoiceStrategies
    • +
  • WorkerTypes

    • Generated using TypeDoc

    \ No newline at end of file