IWorkerNode | poolifier - v2.6.9

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIWorkerNode.html;h=ff963f6c2473abf4620e40c8ce3fc6b7c78bc263;hb=da66e34cda2cbcb3a94865d24696c668f50a1437;hp=2c1118a212cd485d2964e90b7d8ef32930bd75c9;hpb=84d0f4f2937987e5adbb8cfa94839eaf050c7502;p=poolifier.git diff --git a/docs/interfaces/IWorkerNode.html b/docs/interfaces/IWorkerNode.html index 2c1118a2..ff963f6c 100644 --- a/docs/interfaces/IWorkerNode.html +++ b/docs/interfaces/IWorkerNode.html @@ -1,13 +1,13 @@ -IWorkerNode | poolifier - v2.6.9

@@ -37,27 +37,37 @@

IWorkerNode

+

Defined in src/pools/worker.ts:226

-

Index

+

Index

Properties

-

clearTasksQueue +

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

Properties

-

`Readonly` clearTasksQueue

+

`Readonly` clearTasksQueue

clearTasksQueue: (() => void)

Type declaration

@@ -66,12 +76,28 @@

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

Returns void

+

Defined in src/pools/worker.ts:296

+

+

`Readonly` closeChannel

+

closeChannel: (() => void)

+

+

Type declaration

+

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

`Readonly` dequeueTask

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

@@ -80,15 +106,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:286

`Readonly` enqueueTask

enqueueTask: ((task) => number)

@@ -97,9 +123,9 @@

- (task): number
- (task): number
- -
  Worker node enqueue task.
  +
  Enqueue task.
  
  Parameters
  @@ -109,19 +135,102 @@
  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:302

`Readonly` info

info: WorkerInfo

-

Worker node worker info.

+

Worker info.

+

+

+

+

`Optional` `Readonly` messageChannel

+

messageChannel?: MessageChannel

+

Message channel (worker_threads only).

+

Defined in src/pools/worker.ts:247

+

+

`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

+

+
- (): undefined | Task<Data>
- +
  Pops a task from the tasks queue.
  +
  +
  Returns undefined | Task<Data>
  The popped task.
  + +

`Readonly` resetUsage

resetUsage: (() => void)

@@ -130,14 +239,32 @@

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

+

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)

@@ -146,44 +273,69 @@

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

+

+

`Readonly` unshiftTask

+

unshiftTask: ((task) => number)

+

+

Type declaration

+

+
- (task): number
- -
  Worker node tasks queue size.
  +
  Prepends a task to the tasks queue.
  +
  +
  +
  Parameters
  +
  - +
    task: Task<Data>
    +
    The task to prepend.
    
    +
  Returns number
  The tasks queue size.

+

Defined in src/pools/worker.ts:280

-

usage

+

`Readonly` usage

usage: WorkerUsage

-

Worker node worker usage statistics.

+

Worker usage statistics.

+

Defined in src/pools/worker.ts:238

`Readonly` worker

worker: Worker

-

Worker node worker.

+

Worker.

+

Defined in src/pools/worker.ts:230

+

-

Generated using TypeDoc

-

\ No newline at end of file +

Generated using TypeDoc

+

\ No newline at end of file