X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIWorkerNode.html;h=16bedd81a4516ef05e52a531d5d25feac0e9ccac;hb=603ce450e1c02a53a06aff9e9ba5f3cdee24a3f2;hp=00d32712e9ac4533f8de48879ccfc3ff947e4f4e;hpb=c2d2417cb80d8c14637fe6a19d58bcf5ce18ae98;p=poolifier.git diff --git a/docs/interfaces/IWorkerNode.html b/docs/interfaces/IWorkerNode.html index 00d32712..16bedd81 100644 --- a/docs/interfaces/IWorkerNode.html +++ b/docs/interfaces/IWorkerNode.html @@ -1,4 +1,4 @@ -IWorkerNode | poolifier - v2.6.9
+IWorkerNode | poolifier - v2.6.34
  • Preparing search index...
    • -
  • The search index is not available
poolifier - v2.6.9
+
  • The search index is not available
    • poolifier - v2.6.34
    @@ -37,7 +37,7 @@
    • IWorkerNode
    +
  • Defined in src/pools/worker.ts:205
    • @@ -46,11 +46,20 @@

    Properties

    clearTasksQueue +closeChannel dequeueTask enqueueTask +getTaskFunctionWorkerUsage +hasBackPressure info +messageChannel? +onBackPressure? +onEmptyQueue? +popTask resetUsage +tasksQueueBackPressureSize tasksQueueSize +unshiftTask usage worker
    @@ -66,12 +75,28 @@
    +
  • Defined in src/pools/worker.ts:274
    • +
    +

    Readonly closeChannel

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

    Type declaration

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

        Closes communication channel.

        +
        +

        Returns void

        +

    Readonly dequeueTask

    dequeueTask: (() => undefined | Task<Data>)
    @@ -80,15 +105,15 @@
    +
  • Defined in src/pools/worker.ts:264

    • Readonly enqueueTask

    enqueueTask: ((task) => number)
    @@ -97,9 +122,9 @@
    +
    +

    Readonly getTaskFunctionWorkerUsage

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

    Type declaration

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

        Gets task function worker usage statistics.

        +
        +
        +

        Parameters

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

    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
    -

    Worker node worker info.

    +

    Worker info.

    +
    +
    +
    +

    Optional Readonly messageChannel

    +
    messageChannel?: MessageChannel
    +

    Message channel (worker_threads only).

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

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

    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)
    @@ -146,31 +295,56 @@
    +
  • Defined in src/pools/worker.ts:244
    • +
    +

    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
    -

    Worker node worker usage statistics.

    +

    Worker usage statistics.

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

    • Readonly worker

    worker: Worker
    -

    Worker node worker.

    +

    Worker.

    +
  • Defined in src/pools/worker.ts:209
    • @@ -191,26 +365,35 @@
    -