X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIWorkerNode.html;h=46ec8a130b85a8af80f151891ea1e98fe0e033dd;hb=95d287d1625c80929657a9f217774c5c8f6668e7;hp=ebd0f4a3ba3dd73ef33e64eb3db0afe854ff382d;hpb=1079e6ed099b03189005b33702c1e9fa912c74d1;p=poolifier.git diff --git a/docs/interfaces/IWorkerNode.html b/docs/interfaces/IWorkerNode.html index ebd0f4a3..46ec8a13 100644 --- a/docs/interfaces/IWorkerNode.html +++ b/docs/interfaces/IWorkerNode.html @@ -1,4 +1,4 @@ -IWorkerNode | poolifier - v2.6.30
+IWorkerNode | poolifier - v2.6.41
  • Preparing search index...
    • -
  • The search index is not available
poolifier - v2.6.30
+
  • The search index is not available
    • poolifier - v2.6.41
    @@ -37,7 +37,7 @@
    • IWorkerNode
    +
  • Defined in src/pools/worker.ts:226
    • @@ -53,8 +53,14 @@ hasBackPressure info messageChannel? +onBackPressure? +onEmptyQueue? +popTask resetUsage +strategyData? +tasksQueueBackPressureSize tasksQueueSize +unshiftTask usage worker
    @@ -75,7 +81,7 @@

    Returns void

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

    • Readonly closeChannel

    closeChannel: (() => void)
    @@ -91,7 +97,7 @@

    Returns void

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

    • Readonly dequeueTask

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

    • Readonly enqueueTask

    enqueueTask: ((task) => number)
    @@ -127,13 +133,12 @@
  • task: Task<Data>

    The task to queue.

    -
    -
    • +

    Returns number

    The tasks queue size.

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

    • Readonly getTaskFunctionWorkerUsage

    getTaskFunctionWorkerUsage: ((name) => undefined | WorkerUsage)
    @@ -152,13 +157,12 @@
  • 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:317

    • Readonly hasBackPressure

    hasBackPressure: (() => boolean)
    @@ -175,7 +179,7 @@
    +
  • Defined in src/pools/worker.ts:302

    • Readonly info

    info: WorkerInfo
    @@ -183,15 +187,48 @@
    +
  • Defined in src/pools/worker.ts:234

    • Optional Readonly messageChannel

    messageChannel?: MessageChannel
    -

    Message channel.

    +

    Message channel (worker_threads only).

    +
    +
    +
    +

    Optional onBackPressure

    +
    onBackPressure?: WorkerNodeEventCallback
    +

    Callback invoked when worker node tasks queue is back pressured.

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

    Optional onEmptyQueue

    +
    onEmptyQueue?: WorkerNodeEventCallback
    +

    Callback invoked when worker node tasks queue is empty.

    +
    +
    +
    +

    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)
    @@ -200,14 +237,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)
    @@ -216,7 +271,7 @@
    +
  • Defined in src/pools/worker.ts:266
    • +
    +

    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

    +

    Readonly usage

    usage: WorkerUsage

    Worker usage statistics.

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

    • Readonly worker

    worker: Worker
    @@ -240,7 +319,7 @@
    +
  • Defined in src/pools/worker.ts:230
    • @@ -268,23 +347,30 @@
  • hasBackPressure
  • info
  • messageChannel
    • +
  • onBackPressure
    • +
  • onEmptyQueue
    • +
  • popTask
  • resetUsage
    • +
  • strategyData
    • +
  • tasksQueueBackPressureSize
  • tasksQueueSize
    • +
  • unshiftTask
  • usage
  • worker
    • -
    -

    Generated using TypeDoc

    +

    Generated using TypeDoc

    \ No newline at end of file