X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIWorkerNode.html;h=8c20eb68e712a08b54fe08b3f3bbdade78e82df1;hb=447eca603b96bc46303dfa16f3048b68ae576b0c;hp=a61ede3e4a794ca30cdb77aa1b0532fffcbe3577;hpb=6b83e544b1827a8a04898c3032dab73fe19687e6;p=poolifier.git diff --git a/docs/interfaces/IWorkerNode.html b/docs/interfaces/IWorkerNode.html index a61ede3e..8c20eb68 100644 --- a/docs/interfaces/IWorkerNode.html +++ b/docs/interfaces/IWorkerNode.html @@ -1,13 +1,13 @@ -IWorkerNode | poolifier - v2.6.23
+IWorkerNode | poolifier - v2.7.0
-
+
  • The search index is not available
    • poolifier - v2.7.0 +
    @@ -37,29 +37,38 @@
    • IWorkerNode
    +
  • Defined in src/pools/worker.ts:226
    • - +

    Properties

    -
    clearTasksQueue +
    clearTasksQueue closeChannel +deleteTaskFunctionWorkerUsage dequeueTask enqueueTask -getTaskWorkerUsage +getTaskFunctionWorkerUsage +hasBackPressure info +messageChannel? +onBackPressure? +onEmptyQueue? +popTask resetUsage +strategyData? +tasksQueueBackPressureSize tasksQueueSize +unshiftTask usage worker

    Properties

    -

    Readonly clearTasksQueue

    +

    Readonly clearTasksQueue

    clearTasksQueue: (() => void)

    Type declaration

    @@ -73,7 +82,7 @@

    Returns void

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

    • Readonly closeChannel

    closeChannel: (() => void)
    @@ -84,12 +93,37 @@
    • (): void
    • -

      Close communication channel.

      +

      Closes communication channel.

      Returns void

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

    Readonly deleteTaskFunctionWorkerUsage

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

        + +

    Readonly dequeueTask

    dequeueTask: (() => undefined | Task<Data>)
    @@ -98,7 +132,7 @@
      • -
      • (): undefined | Task<Data>
        • +
      • (): undefined | Task<Data>

      • Dequeue task.

        @@ -106,7 +140,7 @@
    +
  • Defined in src/pools/worker.ts:286

    • Readonly enqueueTask

    enqueueTask: ((task) => number)
    @@ -115,7 +149,7 @@
    -

    Returns number

    The task queue size.

    +

    Returns number

    The tasks queue size.

    -
    -

    Readonly getTaskWorkerUsage

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

    Readonly getTaskFunctionWorkerUsage

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

    + +
    +
    +

    Readonly hasBackPressure

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

    Type declaration

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

    • Readonly info

    info: WorkerInfo
    @@ -160,7 +215,48 @@
    +
  • Defined in src/pools/worker.ts:234
    • +
    +

    Optional Readonly messageChannel

    +
    messageChannel?: MessageChannel
    +

    Message channel (worker_threads only).

    +
    +
    +
    +

    Optional onBackPressure

    +
    onBackPressure?: WorkerNodeEventCallback
    +

    Callback invoked when worker node tasks queue is back pressured.

    +
    +
    +
    +

    Optional onEmptyQueue

    +
    onEmptyQueue?: WorkerNodeEventCallback
    +

    Callback invoked when worker node tasks queue is empty.

    +
    +
    +
    +

    Readonly popTask

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

    Type declaration

    +

    Readonly resetUsage

    resetUsage: (() => void)
    @@ -169,14 +265,32 @@
    +
  • Defined in src/pools/worker.ts:306
    • +
    +

    Optional strategyData

    +
    strategyData?: StrategyData
    +

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

    +
    +
    +
    +

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

    Readonly unshiftTask

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

    Type declaration

    +
    -

    usage

    +

    Readonly usage

    usage: WorkerUsage

    Worker usage statistics.

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

    • Readonly worker

    worker: Worker
    @@ -209,20 +348,20 @@
    +
  • Defined in src/pools/worker.ts:230
    • -

    Settings

     +

    Settings

    Member Visibility

      -
      • -
      • -
      • -
    +
    • +
    • +
    • +

    • Theme

    @@ -231,76 +370,48 @@
    -
    +
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    +
    \ No newline at end of file