X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIWorkerNode.html;h=a2b1da92de18131c65469cabaf6afc4fabf807ea;hb=31542ddfe8297d3bd0f9cf97a3de06a03dafc15d;hp=b44e7b4c823cc165e03d07c72ffcc4412ca8888f;hpb=7b88db4b8420d92d98e93c04492319ea814d0fc5;p=poolifier.git diff --git a/docs/interfaces/IWorkerNode.html b/docs/interfaces/IWorkerNode.html index b44e7b4c..a2b1da92 100644 --- a/docs/interfaces/IWorkerNode.html +++ b/docs/interfaces/IWorkerNode.html @@ -1,4 +1,4 @@ -IWorkerNode | poolifier - v2.6.14
+IWorkerNode | poolifier - v2.6.32
  • Preparing search index...
    • -
  • The search index is not available
poolifier - v2.6.14
+
  • The search index is not available
    • poolifier - v2.6.32
    @@ -37,7 +37,7 @@
    • IWorkerNode
    +
  • Defined in src/pools/worker.ts:205
    • @@ -46,12 +46,19 @@

    Properties

    clearTasksQueue +closeChannel dequeueTask enqueueTask -getTaskWorkerUsage +getTaskFunctionWorkerUsage +hasBackPressure info +messageChannel? +onBackPressure? +popTask resetUsage +tasksQueueBackPressureSize tasksQueueSize +unshiftTask usage worker
    @@ -72,7 +79,23 @@

    Returns void

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

    Readonly closeChannel

    +
    closeChannel: (() => void)
    +
    +

    Type declaration

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

        Closes communication channel.

        +
        +

        Returns void

        +

    Readonly dequeueTask

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

    • Readonly enqueueTask

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

    Readonly getTaskWorkerUsage

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

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

    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
    @@ -143,7 +187,56 @@
    +
  • Defined in src/pools/worker.ts:213
    • +
    +

    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

        +
    +
    +

    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)
    @@ -152,14 +245,23 @@
    +
  • Defined in src/pools/worker.ts:278
    • +
    +

    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)
    @@ -168,7 +270,7 @@
    +
  • Defined in src/pools/worker.ts:238
    • +
    +

    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
    @@ -184,7 +311,7 @@
    +
  • Defined in src/pools/worker.ts:221

    • Readonly worker

    worker: Worker
    @@ -192,7 +319,7 @@
    +
  • Defined in src/pools/worker.ts:209
    • @@ -213,27 +340,34 @@
    -