X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=66c5140b59b8e081abe82742ca6ed282fc050389;hb=447eca603b96bc46303dfa16f3048b68ae576b0c;hp=6e2db3c6c9aabbadad1badb107aa34773929eaa1;hpb=a47027a0bf90ce21b528708dadd0eb23b5537b43;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 6e2db3c6..66c5140b 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,13 +1,13 @@ -IPool | poolifier - v2.6.21
+IPool | poolifier - v2.7.0
-
+
  • The search index is not available
    • poolifier - v2.7.0 +
    @@ -46,58 +46,102 @@ +
  • Defined in src/pools/pool.ts:206
    • - +

    Properties

    -
    destroy +
    addTaskFunction +destroy emitter? enableTasksQueue execute +hasTaskFunction +hasWorkerNodeBackPressure info +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:263

    • 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 the number of workers created has reached the maximum size expected.
    • '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.
    • '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).
    +
  • Defined in src/pools/pool.ts:242

    • Readonly enableTasksQueue

    enableTasksQueue: ((enable, tasksQueueOptions?) => void)
    @@ -106,36 +150,36 @@
      • -
      • (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:329

    • Readonly execute

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

    Type declaration

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

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

        @@ -144,19 +188,74 @@
        • Optional data: Data
          -

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

          +

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

        • Optional name: string
          -

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

          +

          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.

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

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

    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
    @@ -164,7 +263,74 @@
    +
  • Defined in src/pools/pool.ts:214
    • +
    +

    Readonly listTaskFunctionNames

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

    Type declaration

    +
    +
    +

    Readonly removeTaskFunction

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

    Type declaration

    +
    +
    +

    Readonly setDefaultTaskFunction

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

    Type declaration

    +

    Readonly setTasksQueueOptions

    setTasksQueueOptions: ((tasksQueueOptions) => void)
    @@ -173,22 +339,22 @@
    +
  • Defined in src/pools/pool.ts:338

    • Readonly setWorkerChoiceStrategy

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

    • Readonly setWorkerChoiceStrategyOptions

    setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void)
    @@ -226,7 +392,7 @@
    +
  • Defined in src/pools/pool.ts:320
    • +
    +

    Readonly start

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

    Type declaration

    +
    -

    Readonly workerNodes

    +

    Readonly Internal workerNodes

    workerNodes: IWorkerNode<Worker, Data>[]

    Pool worker nodes.

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

    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