X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=b410d044d298f91e3f64b94fe4504ba845dfa40d;hb=49fb18fe8d6e6a35ceabe2bce83b26073871e3b0;hp=30e274150032886fbe6b379f1afb57adb239e5c4;hpb=953288ed6e2b952fb17b6fb0ebc4188ce813d53b;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 30e27415..b410d044 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,13 +1,13 @@ -IPool | poolifier - v2.6.31
+IPool | poolifier - v2.7.4
-
+
  • The search index is not available
    • poolifier - v2.7.4 +
    @@ -46,62 +46,103 @@ +
  • Defined in src/pools/pool.ts:201
    • - +

    Properties

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

    Properties

    +
    +

    Readonly addTaskFunction

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

    Type declaration

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

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

        +
        +
        +

        Parameters

        +
          +
        • +
          name: string
          +

          The name of the task function.

          +
          +
          • +
        • +
          fn: TaskFunction<Data, Response>
          +

          The task function.

          +
          +
        +

        Returns Promise<boolean>

        true if the task function was added, false otherwise.

        + +
        +

        Throws

        https://nodejs.org/api/errors.html#class-typeerror If the name parameter is not a string or an empty string.

        + +

        Throws

        https://nodejs.org/api/errors.html#class-typeerror If the fn parameter is not a function.

        +
    -

    Readonly destroy

    +

    Readonly destroy

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

    Type declaration

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

      • Terminates all workers in this pool.

        Returns Promise<void>

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

    • Optional Readonly emitter

    -
    emitter?: PoolEmitter
    -

    Emitter on which events can be listened to.

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

    • '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.
      • +
    • '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.
      • +
    • '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).
      • +
    • 'backPressure': Emitted when all worker nodes have back pressure (i.e. their tasks queue is full: queue size >= maximum queue size).
    +
  • Defined in src/pools/pool.ts:238

    • Readonly enableTasksQueue

    enableTasksQueue: ((enable, tasksQueueOptions?) => void)
    @@ -110,27 +151,27 @@
      • -
      • (enable, tasksQueueOptions?): void
        • +
      • (enable, tasksQueueOptions?): void
      • -

        Enables/disables the worker tasks queue in this pool.

        +

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

        Parameters

        • enable: boolean
          -

          Whether to enable or disable the worker tasks queue.

          +

          Whether to enable or disable the worker node tasks queue.

        • Optional tasksQueueOptions: TasksQueueOptions
          -

          The worker tasks queue options.

          +

          The worker node tasks queue options.

        Returns void

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

    • Readonly execute

    execute: ((data?, name?, transferList?) => Promise<Response>)
    @@ -139,7 +180,7 @@
      • -
      • (data?, name?, transferList?): Promise<Response>
        • +
      • (data?, name?, transferList?): Promise<Response>

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

        @@ -165,7 +206,32 @@
    +
  • Defined in src/pools/pool.ts:247
    • +
    +

    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.

        + +

    Readonly hasWorkerNodeBackPressure

    hasWorkerNodeBackPressure: ((workerNodeKey) => boolean)
    @@ -174,7 +240,7 @@
    +
  • Defined in src/pools/pool.ts:223

    • Readonly info

    info: PoolInfo
    @@ -198,16 +264,16 @@
    -
    -

    Readonly listTaskFunctions

    -
    listTaskFunctions: (() => string[])
    +
  • Defined in src/pools/pool.ts:209
    • +
    +

    Readonly listTaskFunctionNames

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

    Type declaration

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

    Readonly removeTaskFunction

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

    Type declaration

    +
    +
    +

    Readonly setDefaultTaskFunction

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

    Type declaration

    +

    Readonly setTasksQueueOptions

    setTasksQueueOptions: ((tasksQueueOptions) => void)
    @@ -224,22 +340,22 @@
    +
  • Defined in src/pools/pool.ts:334

    • Readonly setWorkerChoiceStrategy

    setWorkerChoiceStrategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void)
    @@ -248,7 +364,7 @@
    +
  • Defined in src/pools/pool.ts:307

    • Readonly setWorkerChoiceStrategyOptions

    setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void)
    @@ -277,7 +393,7 @@
    +
  • Defined in src/pools/pool.ts:316
    • +
    +

    Readonly start

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

    Type declaration

    +

    Readonly Internal workerNodes

    workerNodes: IWorkerNode<Worker, Data>[]
    @@ -300,100 +432,67 @@
    +
  • Defined in src/pools/pool.ts:215
    • -

    Settings

     +

    Settings

    Member Visibility

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

    • Theme

    On This Page
    -
    +
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    +
    \ No newline at end of file