X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIWorkerNode.html;h=83f2cfbf7cf37e3b700b9ad91bc4018d40a1e955;hb=134c1944c69547534c725e2ba8ee40fc5dacf147;hp=7651fc24eb4796e00d623be0d318b80d8260ef76;hpb=ce9e97f17ed0d1b2928919244dce5a7887f843f5;p=poolifier.git diff --git a/docs/interfaces/IWorkerNode.html b/docs/interfaces/IWorkerNode.html index 7651fc24..83f2cfbf 100644 --- a/docs/interfaces/IWorkerNode.html +++ b/docs/interfaces/IWorkerNode.html @@ -1,13 +1,13 @@ -IWorkerNode | poolifier - v2.6.29
+IWorkerNode | poolifier - v2.6.45
-
+
  • The search index is not available
    • poolifier - v2.6.45 +
    @@ -37,15 +37,15 @@
    • IWorkerNode
    +
  • Defined in src/pools/worker.ts:226
    • - +

    Properties

    -
    clearTasksQueue +
    clearTasksQueue closeChannel dequeueTask enqueueTask @@ -53,15 +53,21 @@ hasBackPressure info messageChannel? +onBackPressure? +onEmptyQueue? +popTask resetUsage +strategyData? +tasksQueueBackPressureSize tasksQueueSize +unshiftTask usage worker

    Properties

    -

    Readonly clearTasksQueue

    +

    Readonly clearTasksQueue

    clearTasksQueue: (() => void)

    Type declaration

    @@ -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)
    @@ -129,11 +135,11 @@

    The task to queue.

    -

    Returns number

    The task queue size.

    +

    Returns number

    The tasks queue size.

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

    • Readonly getTaskFunctionWorkerUsage

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

    • Readonly hasBackPressure

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

    • Readonly info

    info: WorkerInfo
    @@ -183,15 +189,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

    +

    Readonly resetUsage

    resetUsage: (() => void)
    @@ -200,14 +239,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 +273,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
    @@ -240,20 +322,20 @@
    +
  • Defined in src/pools/worker.ts:230
    • -

    Settings

     +

    Settings

    Member Visibility

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

    • Theme

    @@ -268,73 +350,41 @@
  • hasBackPressure
  • info
  • messageChannel
    • +
  • onBackPressure
    • +
  • onEmptyQueue
    • +
  • popTask
  • resetUsage
    • +
  • strategyData
    • +
  • tasksQueueBackPressureSize
  • tasksQueueSize
    • +
  • unshiftTask
  • usage
  • worker
    • -
    +
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    +
    \ No newline at end of file