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

    Hierarchy

      -
    • IWorkerNode
    - +

    Properties

    - +
    clearTasksQueue: (() => void)

    Type declaration

    @@ -80,7 +88,7 @@

    Returns void

    +
  • Defined in src/pools/worker.ts:290
  • closeChannel: (() => void)
    @@ -96,7 +104,32 @@

    Returns void

    +
  • Defined in src/pools/worker.ts:304
  • +
    + +
    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>)
    @@ -105,7 +138,7 @@
      • -
      • (): undefined | Task<Data>
      • +
      • (): undefined | Task<Data>
      • Dequeue task.

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

    Returns number

    The tasks queue size.

    +
  • Defined in src/pools/worker.ts:267
  • getTaskFunctionWorkerUsage: ((name) => undefined | WorkerUsage)
    @@ -146,7 +180,7 @@

    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:311
  • hasBackPressure: (() => boolean)
    @@ -170,7 +205,7 @@
    +
  • Defined in src/pools/worker.ts:296
  • info: WorkerInfo
    @@ -186,7 +221,7 @@
    +
  • Defined in src/pools/worker.ts:236
  • messageChannel?: MessageChannel
    @@ -194,23 +229,7 @@
    -
    - -
    onBackPressure?: WorkerNodeEventCallback
    -

    Callback invoked when worker node tasks queue is back pressured.

    -
    -
    -
    - -
    onEmptyQueue?: WorkerNodeEventCallback
    -

    Callback invoked when worker node tasks queue is empty.

    -
    -
    +
  • Defined in src/pools/worker.ts:249
  • popTask: (() => undefined | Task<Data>)
    @@ -219,7 +238,7 @@
    +
  • Defined in src/pools/worker.ts:286
  • resetUsage: (() => void)
    @@ -236,14 +255,23 @@
    +
  • 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
    @@ -252,7 +280,7 @@ This is the number of tasks that can be enqueued before the worker node has back
    +
  • Defined in src/pools/worker.ts:254
  • tasksQueueSize: (() => number)
    @@ -261,7 +289,7 @@ This is the number of tasks that can be enqueued before the worker node has back
    +
  • Defined in src/pools/worker.ts:260
  • unshiftTask: ((task) => number)
    @@ -278,7 +306,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:274
  • usage: WorkerUsage
    @@ -301,7 +330,7 @@ This is the number of tasks that can be enqueued before the worker node has back
    +
  • Defined in src/pools/worker.ts:240
  • worker: Worker
    @@ -309,12 +338,82 @@ This is the number of tasks that can be enqueued before the worker node has back
    +
  • Defined in src/pools/worker.ts:232
  • +
    +

    Methods

    +
    + +
    +
    + +
    +
    + +
    +

    Generated using TypeDoc

    -
    \ No newline at end of file +
    \ No newline at end of file