X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=26706be591388e6711d133b5d89c868b9567d7b9;hb=c38a523624d95c0329fac3d0748883c361db9d93;hp=379d6c3b358825df2004d517c4ea64c9ed5d3ffc;hpb=842d8918a19fc2720d4436789a2e373bc623452e;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 379d6c3b..26706be5 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,4 +1,4 @@ -IPool | poolifier
+IPool | poolifier - v2.6.30
  • Preparing search index...
    • -
  • The search index is not available
poolifier
+
  • The search index is not available
    • poolifier - v2.6.30
    @@ -17,22 +17,26 @@

    Interface IPool<Worker, Data, Response>

    Contract definition for a poolifier pool.

    -
    -
    +
    +
    +

    Type Parameters

    -
    +

    Response = unknown

    +

    Type of execution response. This can only be structured-cloneable data.

    +
    +

    Hierarchy

    +
  • Defined in src/pools/pool.ts:171
    • @@ -50,113 +54,201 @@

    Properties

    -
    busy -destroy -emitter? -execute -findFreeWorkerNodeKey -full -setWorkerChoiceStrategy -type -workerNodes +
    destroy +emitter? +enableTasksQueue +execute +hasWorkerNodeBackPressure +info +listTaskFunctions +setTasksQueueOptions +setWorkerChoiceStrategy +setWorkerChoiceStrategyOptions +workerNodes

    Properties

    -
    -

    Readonly busy

    -
    busy: boolean
    -

    Whether the pool is busy or not.

    -

    The pool busyness boolean status.

    -
    -
    -

    destroy

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

    Readonly destroy

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

    Type declaration

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

          Shutdowns every current worker in this pool.

          +

          Terminates all workers in this pool.

          -

          Returns Promise<void>

    -
    -

    Optional Readonly emitter

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

    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.
      • +
    • 'ready': Emitted when the number of workers created in the pool has reached the minimum size expected and are ready.
      • +
    • 'busy': Emitted when the number of workers created in the pool has reached the maximum size expected and are executing at least one task.
      • +
    • 'full': Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.
      • +
    • 'destroy': Emitted when the pool is destroyed.
      • +
    • 'error': Emitted when an uncaught error occurs.
      • +
    • 'taskError': Emitted when an error occurs while executing a task.
      • +
    • 'backPressure': Emitted when all worker nodes have back pressure (i.e. their tasks queue is full: queue size >= pool maximum size^2).
    -
    -
    -

    execute

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

    Readonly enableTasksQueue

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

    Type declaration

    • -
        -
      • (data: Data): Promise<Response>
        • +
          +
        • (enable, tasksQueueOptions?): void
        • -

          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.

            -
          -

          Returns Promise<Response>

    -
    -

    findFreeWorkerNodeKey

    -
    findFreeWorkerNodeKey: (() => number)
    +
  • Defined in src/pools/pool.ts:255
    • +
    +

    Readonly execute

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

    Type declaration

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

          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.

          +

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

          +
          +
          +

          Parameters

          +
            +
          • +
            Optional data: Data
            +

            The optional task input data for the specified task function. This can only be structured-cloneable data.

            +
            +
            • +
          • +
            Optional name: string
            +

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

            +
            +
            • +
          • +
            Optional transferList: TransferListItem[]
            +

            An optional array of transferable objects to transfer ownership of. Ownership of the transferred objects is given to the pool's worker_threads worker and they should not be used in the main thread afterwards.

            +
            +
          +

          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 hasWorkerNodeBackPressure

    +
    hasWorkerNodeBackPressure: ((workerNodeKey) => boolean)
    +
    +

    Type declaration

    +
      +
    • +
        +
      • (workerNodeKey): boolean
        • +
      • Internal +

        Whether the worker node has back pressure (i.e. its tasks queue is full).

        +
        +
        +

        Parameters

        +
          +
        • +
          workerNodeKey: number
          +

          The worker node key.

          +
          +
        +

        Returns boolean

        true if the worker node has back pressure, false otherwise.

        + +
    +
    +

    Readonly info

    +
    info: PoolInfo
    +

    Pool information.

    -

    Returns number

    -
    -

    Readonly full

    -
    full: boolean
    -

    Whether the pool is full or not.

    -

    The pool filling boolean status.

    -
    +
    +

    Readonly listTaskFunctions

    +
    listTaskFunctions: (() => string[])
    +
    +

    Type declaration

    +
      +
    • +
        +
      • (): string[]
        • +
      • +

        Lists the names of task function available in this pool.

        +
        +

        Returns string[]

        The names of task function available in this pool.

        + +
    +
    +

    Readonly setTasksQueueOptions

    +
    setTasksQueueOptions: ((tasksQueueOptions) => void)
    +
    +

    Type declaration

    +
      +
    • +
        +
      • (tasksQueueOptions): void
        • +
      • +

        Sets the worker tasks queue options in this pool.

        +
        +
        +

        Parameters

        +
        +

        Returns void

        +
    -
    -

    setWorkerChoiceStrategy

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

    Readonly setWorkerChoiceStrategy

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

    Type declaration

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

        • Sets the worker choice strategy in this pool.

          @@ -164,32 +256,56 @@

          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.

            -
    -

    Returns void

    -
    -

    Readonly type

    -
    type: PoolType
    -

    Pool type.

    -

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

    -
    +
    +

    Readonly setWorkerChoiceStrategyOptions

    +
    setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void)
    +
    +

    Type declaration

    +
      +
    • +
        +
      • (workerChoiceStrategyOptions): void
        • +
      • +

        Sets the worker choice strategy options in this pool.

        +
        +
        +

        Parameters

        +
        +

        Returns void

        +
    -
    -

    Readonly workerNodes

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

    Readonly Internal workerNodes

    +
    workerNodes: IWorkerNode<Worker, Data>[]

    Pool worker nodes.

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

    Settings

     +

    Settings

    Member Visibility

    @@ -199,61 +315,85 @@
    • -

    Theme

    +

    Theme

    -

    On This Page

     +

    On This Page

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

    • Generated using TypeDoc

    \ No newline at end of file