X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIWorkerNode.html;h=24f78d03d5998446b0305047701ee931b791d238;hb=da7631f88ed580377ddba0882eac576bb32832eb;hp=516a1d8fb0b8251a6e483680f0668c97d0af420a;hpb=3f25036f6dab9916ac40916ca1dc5358ec1f88ba;p=poolifier.git diff --git a/docs/interfaces/IWorkerNode.html b/docs/interfaces/IWorkerNode.html index 516a1d8f..24f78d03 100644 --- a/docs/interfaces/IWorkerNode.html +++ b/docs/interfaces/IWorkerNode.html @@ -1,4 +1,4 @@ -IWorkerNode | poolifier - v2.6.33
+IWorkerNode | poolifier - v2.6.41
  • Preparing search index...
    • -
  • The search index is not available
poolifier - v2.6.33
+
  • The search index is not available
    • poolifier - v2.6.41
    @@ -37,7 +37,7 @@
    • IWorkerNode
    +
  • Defined in src/pools/worker.ts:226
    • @@ -57,6 +57,7 @@ onEmptyQueue? popTask resetUsage +strategyData? tasksQueueBackPressureSize tasksQueueSize unshiftTask @@ -80,7 +81,7 @@

    Returns void

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

    • Readonly closeChannel

    closeChannel: (() => void)
    @@ -96,7 +97,7 @@

    Returns void

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

    • Readonly dequeueTask

    dequeueTask: (() => undefined | Task<Data>)
    @@ -113,7 +114,7 @@
    +
  • Defined in src/pools/worker.ts:286

    • Readonly enqueueTask

    enqueueTask: ((task) => number)
    @@ -132,13 +133,12 @@
  • task: Task<Data>

    The task to queue.

    -
    -
    • +

    Returns number

    The tasks queue size.

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

    • Readonly getTaskFunctionWorkerUsage

    getTaskFunctionWorkerUsage: ((name) => undefined | WorkerUsage)
    @@ -157,13 +157,12 @@
  • name: string

    The task function name.

    -
    -
    • +

    Returns undefined | WorkerUsage

    The task function worker usage statistics if the task function worker usage statistics are initialized, undefined otherwise.

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

    • Readonly hasBackPressure

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

    • Readonly info

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

    • Optional Readonly messageChannel

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

    • Optional onBackPressure

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

    Type declaration

    -
      -
    • -
        -
      • (workerId): void
        • -
      • +
        onBackPressure?: WorkerNodeEventCallback

        Callback invoked when worker node tasks queue is back pressured.

        -
        -

        Parameters

        -
          -
        • -
          workerId: number
          -

          The worker id.

          -
          -
        -

        Returns void

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

    • Optional onEmptyQueue

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

    Type declaration

    -
      -
    • -
        -
      • (workerId): void
        • -
      • +
        onEmptyQueue?: WorkerNodeEventCallback

        Callback invoked when worker node tasks queue is empty.

        -
        -

        Parameters

        -
          -
        • -
          workerId: number
          -

          The worker id.

          -
          -
        -

        Returns void

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

    • Readonly popTask

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

    • Readonly resetUsage

    resetUsage: (() => void)
    @@ -270,14 +237,23 @@
    +
  • 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
    @@ -286,7 +262,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)
    @@ -295,7 +271,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)
    @@ -312,7 +288,7 @@ This is the number of tasks that can be enqueued before the worker node has back

    Returns number

    The tasks queue size.

    +
  • 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
    @@ -344,7 +319,7 @@ This is the number of tasks that can be enqueued before the worker node has back
    +
  • Defined in src/pools/worker.ts:230
    • @@ -376,13 +351,14 @@ This is the number of tasks that can be enqueued before the worker node has back
  • onEmptyQueue
  • popTask
  • resetUsage
    • +
  • strategyData
  • tasksQueueBackPressureSize
  • tasksQueueSize
  • unshiftTask
  • usage
  • worker
    • -
    -

    Generated using TypeDoc

    +

    Generated using TypeDoc

    \ No newline at end of file