X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIWorkerNode.html;h=b356e715268aa556b89a7576b26a12bc9a6b6096;hb=7c48b2a96e4a42d627bc08f67173956f1d2e30af;hp=383011bf2fc90f6292d7e605f1a50b3f51b1783f;hpb=5e972953bf3193a557a14fa794d559b2acc1d6de;p=poolifier.git diff --git a/docs/interfaces/IWorkerNode.html b/docs/interfaces/IWorkerNode.html index 383011bf..b356e715 100644 --- a/docs/interfaces/IWorkerNode.html +++ b/docs/interfaces/IWorkerNode.html @@ -1,13 +1,13 @@ -IWorkerNode | poolifier - v2.6.18
+IWorkerNode | poolifier - v3.0.2
-
+
  • The search index is not available
  • poolifier - v3.0.2 +
    @@ -35,30 +35,46 @@

    Hierarchy

      -
    • IWorkerNode
    - +

    Properties

    - +
    clearTasksQueue: (() => void)

    Type declaration

    @@ -72,7 +88,48 @@

    Returns void

    +
  • Defined in src/pools/worker.ts:290
  • +
    + +
    closeChannel: (() => void)
    +
    +

    Type declaration

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

        Closes communication channel.

        +
        +

        Returns void

        +
    +
    + +
    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.

        + +
    dequeueTask: (() => undefined | Task<Data>)
    @@ -81,7 +138,7 @@
      • -
      • (): undefined | Task<Data>
      • +
      • (): undefined | Task<Data>
      • Dequeue task.

        @@ -89,7 +146,7 @@
    +
  • Defined in src/pools/worker.ts:280
  • enqueueTask: ((task) => number)
    @@ -98,7 +155,7 @@
      • -
      • (task): number
      • +
      • (task): number
      • Enqueue task.

        @@ -110,32 +167,53 @@

        The task to queue.

    -

    Returns number

    The task queue size.

    +

    Returns number

    The tasks queue size.

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

    Type declaration

    +

    Returns undefined | WorkerUsage

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

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

    Type declaration

    +
    +
  • Defined in src/pools/worker.ts:296
  • info: WorkerInfo
    @@ -143,7 +221,32 @@
    +
  • Defined in src/pools/worker.ts:236
  • +
    + +
    messageChannel?: MessageChannel
    +

    Message channel (worker_threads only).

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

    Type declaration

    +
    resetUsage: (() => void)
    @@ -152,14 +255,32 @@
    +
  • Defined in src/pools/worker.ts:300
  • +
    + +
    strategyData?: StrategyData
    +

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

    +
    +
    +
    + +
    tasksQueueBackPressureSize: number
    +

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

    +
    +
    tasksQueueSize: (() => number)
    @@ -168,7 +289,7 @@
    +
  • Defined in src/pools/worker.ts:260
  • +
    + +
    unshiftTask: ((task) => number)
    +
    +

    Type declaration

    +
    - +
    usage: WorkerUsage

    Worker usage statistics.

    +
  • Defined in src/pools/worker.ts:240
  • worker: Worker
    @@ -192,12 +338,82 @@
    +
  • Defined in src/pools/worker.ts:232
  • +
    +

    Methods

    +
    + +
    +
    + +
    +
    + +
    +
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    +
    \ No newline at end of file