X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIWorkerNode.html;h=7f7dad3c89e7a8388105d6642903ae1ef2c809c9;hb=8b80810a81554f0e6442dd681e68f59fdfd23312;hp=b50d324c2876730112ae66ed1503cb665a66e878;hpb=8ad621cc1d32ed396fca3ef2ec48337e42d2dcc2;p=poolifier.git diff --git a/docs/interfaces/IWorkerNode.html b/docs/interfaces/IWorkerNode.html index b50d324c..7f7dad3c 100644 --- a/docs/interfaces/IWorkerNode.html +++ b/docs/interfaces/IWorkerNode.html @@ -1,4 +1,4 @@ -IWorkerNode | poolifier - v2.6.25
+IWorkerNode | poolifier - v2.6.36
  • Preparing search index...
    • -
  • The search index is not available
poolifier - v2.6.25
+
  • The search index is not available
    • poolifier - v2.6.36
    @@ -37,7 +37,7 @@
    • IWorkerNode
    +
  • Defined in src/pools/worker.ts:209
    • @@ -49,10 +49,17 @@ closeChannel dequeueTask enqueueTask -getTaskWorkerUsage +getTaskFunctionWorkerUsage +hasBackPressure info +messageChannel? +onBackPressure? +onEmptyQueue? +popTask resetUsage +tasksQueueBackPressureSize tasksQueueSize +unshiftTask usage worker
    @@ -73,7 +80,7 @@

    Returns void

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

    • Readonly closeChannel

    closeChannel: (() => void)
    @@ -84,12 +91,12 @@
    +
  • Defined in src/pools/worker.ts:292

    • Readonly dequeueTask

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

    • Readonly enqueueTask

    enqueueTask: ((task) => number)
    @@ -125,34 +132,53 @@
  • task: Task<Data>

    The task to queue.

    -
    -
    • -

    Returns number

    The task queue size.

    + +

    Returns number

    The tasks queue size.

    -
    -

    Readonly getTaskWorkerUsage

    -
    getTaskWorkerUsage: ((name) => undefined | WorkerUsage)
    +
  • Defined in src/pools/worker.ts:255
    • +
    +

    Readonly getTaskFunctionWorkerUsage

    +
    getTaskFunctionWorkerUsage: ((name) => undefined | WorkerUsage)

    Type declaration

      • -
      • (name): undefined | WorkerUsage
        • +
      • (name): undefined | WorkerUsage
      • -

        Gets task worker usage statistics.

        +

        Gets task function worker usage statistics.

        Parameters

        • -
          name: string
        -

        Returns undefined | WorkerUsage

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

    Readonly hasBackPressure

    +
    hasBackPressure: (() => boolean)
    +
    +

    Type declaration

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

        Whether the worker node has back pressure (i.e. its tasks queue is full).

        +
        +

        Returns boolean

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

        + +

    Readonly info

    info: WorkerInfo
    @@ -160,7 +186,78 @@
    +
  • Defined in src/pools/worker.ts:217
    • +
    +

    Optional Readonly messageChannel

    +
    messageChannel?: MessageChannel
    +

    Message channel (worker_threads only).

    +
    +
    +
    +

    Optional onBackPressure

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

    Type declaration

    +
      +
    • +
        +
      • (workerId): void
        • +
      • +

        Callback invoked when worker node tasks queue is back pressured.

        +
        +
        +

        Parameters

        +
          +
        • +
          workerId: number
          +

          The worker id.

          +
        +

        Returns void

        +
    +
    +

    Optional onEmptyQueue

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

    Type declaration

    +
      +
    • +
        +
      • (workerId): void
        • +
      • +

        Callback invoked when worker node tasks queue is empty.

        +
        +
        +

        Parameters

        +
          +
        • +
          workerId: number
          +

          The worker id.

          +
        +

        Returns void

        +
    +
    +

    Readonly popTask

    +
    popTask: (() => undefined | Task<Data>)
    +
    +

    Type declaration

    +
      +
    • +
        +
      • (): undefined | Task<Data>
        • +
      • +

        Pops a task from the tasks queue.

        +
        +

        Returns undefined | Task<Data>

        The popped task.

        + +

    Readonly resetUsage

    resetUsage: (() => void)
    @@ -169,14 +266,23 @@
    +
  • Defined in src/pools/worker.ts:288
    • +
    +

    tasksQueueBackPressureSize

    +
    tasksQueueBackPressureSize: number
    +

    Tasks queue back pressure size. +This is the number of tasks that can be enqueued before the worker node has back pressure.

    +
    +

    Readonly tasksQueueSize

    tasksQueueSize: (() => number)
    @@ -185,7 +291,7 @@
    +
  • Defined in src/pools/worker.ts:248
    • +
    +

    Readonly unshiftTask

    +
    unshiftTask: ((task) => number)
    +
    +

    Type declaration

    +
      +
    • +
        +
      • (task): number
        • +
      • +

        Prepends a task to the tasks queue.

        +
        +
        +

        Parameters

        +
          +
        • +
          task: Task<Data>
          +

          The task to prepend.

          +
        +

        Returns number

        The tasks queue size.

        + +

    usage

    usage: WorkerUsage
    @@ -201,7 +331,7 @@
    +
  • Defined in src/pools/worker.ts:221

    • Readonly worker

    worker: Worker
    @@ -209,7 +339,7 @@
    +
  • Defined in src/pools/worker.ts:213
    • @@ -233,25 +363,33 @@
  • closeChannel
  • dequeueTask
  • enqueueTask
    • -
  • getTaskWorkerUsage
    • +
  • getTaskFunctionWorkerUsage
    • +
  • hasBackPressure
  • info
    • +
  • messageChannel
    • +
  • onBackPressure
    • +
  • onEmptyQueue
    • +
  • popTask
  • resetUsage
    • +
  • tasksQueueBackPressureSize
  • tasksQueueSize
    • +
  • unshiftTask
  • usage
  • worker
    • -
    -

    Generated using TypeDoc

    +

    Generated using TypeDoc

    \ No newline at end of file