X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIWorkerNode.html;h=8c20eb68e712a08b54fe08b3f3bbdade78e82df1;hb=447eca603b96bc46303dfa16f3048b68ae576b0c;hp=a2b1da92de18131c65469cabaf6afc4fabf807ea;hpb=b7ca12ae3bfb54a42c0e9879067fc3a976685bb7;p=poolifier.git diff --git a/docs/interfaces/IWorkerNode.html b/docs/interfaces/IWorkerNode.html index a2b1da92..8c20eb68 100644 --- a/docs/interfaces/IWorkerNode.html +++ b/docs/interfaces/IWorkerNode.html @@ -1,13 +1,13 @@ -IWorkerNode | poolifier - v2.6.32
+IWorkerNode | poolifier - v2.7.0
-
+
  • The search index is not available
    • poolifier - v2.7.0 +
    @@ -37,16 +37,17 @@
    • IWorkerNode
    +
  • Defined in src/pools/worker.ts:226
    • - +

    Properties

    -
    clearTasksQueue +
    clearTasksQueue closeChannel +deleteTaskFunctionWorkerUsage dequeueTask enqueueTask getTaskFunctionWorkerUsage @@ -54,8 +55,10 @@ info messageChannel? onBackPressure? +onEmptyQueue? popTask resetUsage +strategyData? tasksQueueBackPressureSize tasksQueueSize unshiftTask @@ -65,7 +68,7 @@

    Properties

    -

    Readonly clearTasksQueue

    +

    Readonly clearTasksQueue

    clearTasksQueue: (() => void)

    Type declaration

    @@ -79,7 +82,7 @@

    Returns void

    +
  • Defined in src/pools/worker.ts:296

    • Readonly closeChannel

    closeChannel: (() => void)
    @@ -95,7 +98,32 @@

    Returns void

    +
  • Defined in src/pools/worker.ts:310
    • +
    +

    Readonly deleteTaskFunctionWorkerUsage

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

    Type declaration

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

        Deletes task function worker usage statistics.

        +
        +
        +

        Parameters

        +
          +
        • +
          name: string
          +

          The task function name.

          +
          +
        +

        Returns boolean

        true if the task function worker usage statistics were deleted, false otherwise.

        + +

    Readonly dequeueTask

    dequeueTask: (() => undefined | Task<Data>)
    @@ -104,7 +132,7 @@
      • -
      • (): undefined | Task<Data>
        • +
      • (): undefined | Task<Data>

      • Dequeue task.

        @@ -112,7 +140,7 @@
    +
  • Defined in src/pools/worker.ts:286

    • Readonly enqueueTask

    enqueueTask: ((task) => number)
    @@ -121,7 +149,7 @@
      • -
      • (task): number
        • +
      • (task): number

      • Enqueue task.

        @@ -137,7 +165,7 @@
    +
  • Defined in src/pools/worker.ts:273

    • Readonly getTaskFunctionWorkerUsage

    getTaskFunctionWorkerUsage: ((name) => undefined | WorkerUsage)
    @@ -146,7 +174,7 @@
    +
  • Defined in src/pools/worker.ts:317

    • Readonly hasBackPressure

    hasBackPressure: (() => boolean)
    @@ -171,7 +199,7 @@
    +
  • Defined in src/pools/worker.ts:302

    • Readonly info

    info: WorkerInfo
    @@ -187,7 +215,7 @@
    +
  • Defined in src/pools/worker.ts:234

    • Optional Readonly messageChannel

    messageChannel?: MessageChannel
    @@ -195,31 +223,23 @@
    +
  • Defined in src/pools/worker.ts:247

    • Optional onBackPressure

    -
    onBackPressure?: ((workerId) => void)
    -
    -

    Type declaration

    -
    +
    +

    Optional onEmptyQueue

    +
    onEmptyQueue?: WorkerNodeEventCallback
    +

    Callback invoked when worker node tasks queue is empty.

    -
    -

    Returns void

    -
    +
  • Defined in src/pools/worker.ts:260

    • Readonly popTask

    popTask: (() => undefined | Task<Data>)
    @@ -236,7 +256,7 @@
    +
  • Defined in src/pools/worker.ts:292

    • Readonly resetUsage

    resetUsage: (() => void)
    @@ -252,7 +272,16 @@

    Returns void

    +
  • Defined in src/pools/worker.ts:306
    • +
    +

    Optional strategyData

    +
    strategyData?: StrategyData
    +

    Worker choice strategy data. +This is used to store data that is specific to the worker choice strategy.

    +
    +

    tasksQueueBackPressureSize

    tasksQueueBackPressureSize: number
    @@ -261,7 +290,7 @@ This is the number of tasks that can be enqueued before the worker node has back
    +
  • Defined in src/pools/worker.ts:252

    • Readonly tasksQueueSize

    tasksQueueSize: (() => number)
    @@ -278,7 +307,7 @@ This is the number of tasks that can be enqueued before the worker node has back
    +
  • Defined in src/pools/worker.ts:266

    • Readonly unshiftTask

    unshiftTask: ((task) => number)
    @@ -303,15 +332,15 @@ This is the number of tasks that can be enqueued before the worker node has back
    +
  • Defined in src/pools/worker.ts:280
    • -

    usage

    +

    Readonly usage

    usage: WorkerUsage

    Worker usage statistics.

    +
  • Defined in src/pools/worker.ts:238

    • Readonly worker

    worker: Worker
    @@ -319,20 +348,20 @@ This is the number of tasks that can be enqueued before the worker node has back
    +
  • Defined in src/pools/worker.ts:230
    • -

    Settings

     +

    Settings

    Member Visibility

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

    • Theme

    @@ -341,6 +370,7 @@ This is the number of tasks that can be enqueued before the worker node has back
    -
    +
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    +
    \ No newline at end of file