X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=b64725e9908f76f69b5b40cc232538def3381e9d;hb=af98b972cd1f5145852682b8167e4af0ff994260;hp=3ff97450c4e8cda5fbd5dd529f938371d91b729d;hpb=23d03397abcbf7274ba08acf89728bcaf32f0f6f;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 3ff97450..b64725e9 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,13 +1,13 @@ -IPool | poolifier
+IPool | poolifier - v2.7.4
-
+
  • The search index is not available
    • poolifier - v2.7.4 +
    @@ -17,22 +17,26 @@

    Interface IPool<Worker, Data, Response>

    Contract definition for a poolifier pool.

    -
    -
    +
    +
    +

    Type Parameters

    -
    +
  • -

    Data = unknown

    -

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

    -
    • +

    Data = unknown

    +

    Type of data sent to the worker. This can only be structured-cloneable data.

    +
    +
  • -

    Response = unknown

    -

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

    -
    • +

    Response = unknown

    +

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

    +
    +

    Hierarchy

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

    Properties

    -
    destroy -emitter? -execute -findFreeWorkerNodeKey -setWorkerChoiceStrategy -type -workerNodes +
    addTaskFunction +destroy +emitter? +enableTasksQueue +execute +hasTaskFunction +hasWorkerNodeBackPressure +info +listTaskFunctionNames +removeTaskFunction +setDefaultTaskFunction +setTasksQueueOptions +setWorkerChoiceStrategy +setWorkerChoiceStrategyOptions +start +workerNodes

    Properties

    -
    -

    destroy

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

    Readonly addTaskFunction

    +
    addTaskFunction: ((name, fn) => Promise<boolean>)

    Type declaration

    • -
        -
      • (): Promise<void>
        • +
          +
        • (name, fn): Promise<boolean>
        • -

          Shutdowns every current worker in this pool.

          +

          Adds a task function to this pool. +If a task function with the same name already exists, it will be overwritten.

          -

          Returns Promise<void>

    -
    -

    Optional Readonly emitter

    -
    emitter?: PoolEmitter
    -

    Emitter on which events can be listened to.

    +
  • Defined in src/pools/pool.ts:277
    • +
    +

    Readonly destroy

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

    Type declaration

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

        Terminates all workers in this pool.

        +
        +

        Returns Promise<void>

        +
    +
    +

    Optional Readonly emitter

    +
    emitter?: __module | EventEmitterAsyncResource
    +

    Event emitter integrated with async resource on which events can be listened to. +The async tracking tooling identifier is poolifier:<PoolType>-<WorkerType>-pool.

    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 concurrently their tasks quota.
      • +
    • '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 >= maximum queue size).
    -
    +
    +

    Readonly enableTasksQueue

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

    Type declaration

    +
      +
    • +
        +
      • (enable, tasksQueueOptions?): void
        • +
      • +

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

        +
        +
        +

        Parameters

        +
          +
        • +
          enable: boolean
          +

          Whether to enable or disable the worker node tasks queue.

          +
          +
          • +
        • +
          Optional tasksQueueOptions: TasksQueueOptions
          +

          The worker node tasks queue options.

          +
          +
        +

        Returns void

        +
    +
    +

    Readonly execute

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

    Type declaration

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

        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.

        + +
    +
    +

    Readonly hasTaskFunction

    +
    hasTaskFunction: ((name) => boolean)
    +
    +

    Type declaration

    +
      +
    • +
        +
      • (name): boolean
        • +
      • +

        Whether the specified task function exists in this pool.

        +
        +
        +

        Parameters

        +
          +
        • +
          name: string
          +

          The name of the task function.

          +
          +
        +

        Returns boolean

        true if the task function exists, false otherwise.

        + +
    -
    -

    execute

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

    Readonly hasWorkerNodeBackPressure

    +
    hasWorkerNodeBackPressure: ((workerNodeKey) => boolean)

    Type declaration

    • -
        -
      • (data: Data): Promise<Response>
        • +
          +
        • (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.

    +
    +
    +
    +

    Readonly listTaskFunctionNames

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

    Type declaration

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

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

        +

        Lists the names of task function available in this pool.

        +
        +

        Returns string[]

        The names of task function available in this pool.

        -

        Returns

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

        +
    +
    +

    Readonly removeTaskFunction

    +
    removeTaskFunction: ((name) => Promise<boolean>)
    +
    +

    Type declaration

    +
      +
    • +
        +
      • (name): Promise<boolean>
        • +
      • +

        Removes a task function from 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:287
    • +
    +

    Readonly setDefaultTaskFunction

    +
    setDefaultTaskFunction: ((name) => Promise<boolean>)

    Type declaration

    • -
        -
      • (): number
        • +
          +
        • (name): Promise<boolean>
        • -

          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.

          +

          Sets the default task function in this pool.

          +
          +
          +

          Parameters

          +
            +
          • +
            name: string
            +

            The name of the task function.

            +
            +
          +

          Returns Promise<boolean>

          true if the default task function was set, false otherwise.

          -

          Returns

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

          +
    +
    +

    Readonly setTasksQueueOptions

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

    Type declaration

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

        Sets the worker node tasks queue options in this pool.

        +
        +
        +

        Parameters

        +
          +
        • +
          tasksQueueOptions: TasksQueueOptions
          +

          The worker node tasks queue options.

          -

          Returns number

    -
    -

    setWorkerChoiceStrategy

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

    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.

          @@ -146,94 +372,127 @@

          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 workerNodes

    -
    workerNodes: WorkerNode<Worker, Data>[]
    + +
    +
  • +
    Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
    +

    The worker choice strategy options.

    +
    +
    • +

    Returns void

    +
    +
    +

    Readonly setWorkerChoiceStrategyOptions

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

    Type declaration

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

        Sets the worker choice strategy options in this pool.

        +
        +
        +

        Parameters

        +
        +

        Returns void

        +
    +
    +

    Readonly start

    +
    start: (() => void)
    +
    +

    Type declaration

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

        Starts the minimum number of workers in this pool.

        +
        +

        Returns void

        +
    +
    +

    Readonly Internal workerNodes

    +
    workerNodes: IWorkerNode<Worker, Data>[]

    Pool worker nodes.

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

    Settings

     +

    Settings

    Member Visibility

      -
      • -
      • -
      • -
    +
    • +
    • +
    • +
    • -

    Theme

    +

    Theme

    -

    On This Page

     +

    On This Page

    +
  • addTaskFunction
    • +
  • destroy
    • +
  • emitter
    • +
  • enableTasksQueue
    • +
  • execute
    • +
  • hasTaskFunction
    • +
  • hasWorkerNodeBackPressure
    • +
  • info
    • +
  • listTaskFunctionNames
    • +
  • removeTaskFunction
    • +
  • setDefaultTaskFunction
    • +
  • setTasksQueueOptions
    • +
  • setWorkerChoiceStrategy
    • +
  • setWorkerChoiceStrategyOptions
    • +
  • start
    • +
  • workerNodes
    • -
    +
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    +
    \ No newline at end of file