IWorkerNode | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIWorkerNode.html;h=a2b1da92de18131c65469cabaf6afc4fabf807ea;hb=cfeb9528531b00167f2e849c8b96709769159598;hp=be1ccbdc5f15cf10cd8d2457f4ddad626ddd500b;hpb=04cb7adbacc7fb0d1b76db6122f86c52e33d136d;p=poolifier.git diff --git a/docs/interfaces/IWorkerNode.html b/docs/interfaces/IWorkerNode.html index be1ccbdc..a2b1da92 100644 --- a/docs/interfaces/IWorkerNode.html +++ b/docs/interfaces/IWorkerNode.html @@ -1,4 +1,4 @@ -IWorkerNode | poolifier - v2.6.10

+IWorkerNode | poolifier - v2.6.32

@@ -37,7 +37,7 @@

IWorkerNode

Defined in src/pools/worker.ts:205

@@ -46,11 +46,19 @@

Properties

clearTasksQueue +closeChannel dequeueTask enqueueTask +getTaskFunctionWorkerUsage +hasBackPressure info +messageChannel? +onBackPressure? +popTask resetUsage +tasksQueueBackPressureSize tasksQueueSize +unshiftTask usage worker

@@ -66,12 +74,28 @@

(): void
-
Worker node clear tasks queue.
+
Clears tasks queue.

Returns void

Defined in src/pools/worker.ts:268

`Readonly` closeChannel

closeChannel: (() => void)

Type declaration

+
- (): void
- +
  Closes communication channel.
  +
  +
  Returns void
  +

`Readonly` dequeueTask

dequeueTask: (() => undefined | Task<Data>)

@@ -80,15 +104,15 @@

- (): undefined | Task<Data>
- (): undefined | Task<Data>
- -
  Worker node dequeue task.
  +
  Dequeue task.
  
  Returns undefined | Task<Data>
  The dequeued task.

Defined in src/pools/worker.ts:258

`Readonly` enqueueTask

enqueueTask: ((task) => number)

@@ -97,9 +121,9 @@

- (task): number
- (task): number
- -
  Worker node enqueue task.
  +
  Enqueue task.
  
  Parameters
  @@ -109,19 +133,110 @@
  The task to queue.
-
Returns number
The task queue size.
+
Returns number
The tasks queue size.
+ +

`Readonly` getTaskFunctionWorkerUsage

getTaskFunctionWorkerUsage: ((name) => undefined | WorkerUsage)

Type declaration

+
- (name): undefined | WorkerUsage
- +
  Gets task function worker usage statistics.
  +
  +
  +
  Parameters
  +
  - +
    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.
  + +

`Readonly` hasBackPressure

hasBackPressure: (() => boolean)

Type declaration

+
- (): boolean
- +
  Whether the worker node has back pressure (i.e. its tasks queue is full).
  +
  +
  Returns boolean
  true if the worker node has back pressure, false otherwise.

Defined in src/pools/worker.ts:274

`Readonly` info

info: WorkerInfo

Worker node worker info.

Worker info.

Defined in src/pools/worker.ts:213

`Optional` `Readonly` messageChannel

messageChannel?: MessageChannel

Message channel (worker_threads only).

`Optional` onBackPressure

onBackPressure?: ((workerId) => void)

Type declaration

+
- (workerId): void
- +
  Callback invoked when worker node tasks queue is back pressured.
  +
  +
  +
  Parameters
  +
  - +
    workerId: number
    +
    The worker id.
    +
    +
  +
  Returns void
  +

`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)

@@ -130,14 +245,23 @@

- (): void
- (): void
- -
  Worker node reset usage statistics .
  +
  Resets usage statistics.
  
  Returns void

Defined in src/pools/worker.ts:278

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)

@@ -146,31 +270,56 @@

- (): number
- (): number
- -
  Worker node tasks queue size.
  +
  Tasks queue size.
  
  Returns number
  The tasks queue size.

Defined in src/pools/worker.ts:238

`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

usage: WorkerUsage

Worker node worker usage statistics.

Worker usage statistics.

Defined in src/pools/worker.ts:221

`Readonly` worker

worker: Worker

Worker node worker.

Worker.

Defined in src/pools/worker.ts:209

name: string

workerId: number

task: Task<Data>