X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=089d3914170dc88a6b071f5e1a68bf46ecdde8cd;hb=cc35cd9cb7323e39c9f521cdd4fbf51d1d31bbdf;hp=26706be591388e6711d133b5d89c868b9567d7b9;hpb=46e29227a97fe04f886969199f1c14338af50543;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 26706be5..089d3914 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,4 +1,4 @@ -IPool | poolifier - v2.6.30
+IPool | poolifier - v2.6.40
  • Preparing search index...
  • -
  • The search index is not available
poolifier - v2.6.30
+
  • The search index is not available
  • poolifier - v2.6.40
    @@ -46,7 +46,7 @@ +
  • Defined in src/pools/pool.ts:182
  • @@ -83,7 +83,7 @@

    Returns Promise<void>

    +
  • Defined in src/pools/pool.ts:235
  • emitter?: PoolEmitter
    @@ -91,17 +91,17 @@

    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:218
  • enableTasksQueue: ((enable, tasksQueueOptions?) => void)
    @@ -112,25 +112,23 @@

    Returns void

    +
  • Defined in src/pools/pool.ts:266
  • execute: ((data?, name?, transferList?) => Promise<Response>)
    @@ -149,23 +147,20 @@
  • Optional data: Data

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

    -
    -
  • +Optional
  • Optional name: string

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

    -
    -
  • +Optional
  • 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.

    -
    -
  • +Optional

    Returns Promise<Response>

    Promise that will be fulfilled when the task is completed.

    +
  • Defined in src/pools/pool.ts:227
  • hasWorkerNodeBackPressure: ((workerNodeKey) => boolean)
    @@ -184,13 +179,12 @@
  • workerNodeKey: number

    The worker node key.

    -
    -
  • +

    Returns boolean

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

    +
  • Defined in src/pools/pool.ts:204
  • info: PoolInfo
    @@ -198,7 +192,7 @@
    +
  • Defined in src/pools/pool.ts:190
  • listTaskFunctions: (() => string[])
    @@ -215,7 +209,7 @@
    +
  • Defined in src/pools/pool.ts:241
  • setTasksQueueOptions: ((tasksQueueOptions) => void)
    @@ -226,20 +220,19 @@

    Returns void

    +
  • Defined in src/pools/pool.ts:275
  • setWorkerChoiceStrategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void)
    @@ -258,17 +251,15 @@
  • 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

    The worker choice strategy options.

    -
    -
  • +Optional

    Returns void

    +
  • Defined in src/pools/pool.ts:248
  • setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void)
    @@ -287,12 +278,11 @@
  • workerChoiceStrategyOptions: WorkerChoiceStrategyOptions

    The worker choice strategy options.

    -
    -
  • +

    Returns void

    +
  • Defined in src/pools/pool.ts:257
  • workerNodes: IWorkerNode<Worker, Data>[]
    @@ -300,7 +290,7 @@
    +
  • Defined in src/pools/pool.ts:196
  • -

    Generated using TypeDoc

    +

    Generated using TypeDoc

    \ No newline at end of file