IWorkerNode | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIWorkerNode.html;h=8ca8426f69eb912f32deaafb6e71a1e66be6eb7f;hb=665702eef3ad8153279b344e0276687f7f50c10f;hp=4fcbcd16841011ff68087aa9b50cd61edaa4ed55;hpb=019581cc38fe0b47645d9b2120f325ab37388be2;p=poolifier.git diff --git a/docs/interfaces/IWorkerNode.html b/docs/interfaces/IWorkerNode.html index 4fcbcd16..8ca8426f 100644 --- a/docs/interfaces/IWorkerNode.html +++ b/docs/interfaces/IWorkerNode.html @@ -1,13 +1,13 @@ -IWorkerNode | poolifier - v2.6.28

@@ -37,29 +37,37 @@

IWorkerNode

Defined in src/pools/worker.ts:226

Properties

`Readonly` clearTasksQueue

clearTasksQueue: (() => void)

Type declaration

@@ -73,7 +81,7 @@

Returns void

Defined in src/pools/worker.ts:296

`Readonly` closeChannel

closeChannel: (() => void)

@@ -84,12 +92,12 @@

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

Returns void

Defined in src/pools/worker.ts:310

`Readonly` dequeueTask

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

@@ -106,7 +114,7 @@

Defined in src/pools/worker.ts:286

`Readonly` enqueueTask

enqueueTask: ((task) => number)

@@ -127,32 +135,53 @@

The task to queue.

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

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

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

`Readonly` info

info: WorkerInfo

@@ -160,7 +189,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

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

`Readonly` resetUsage

resetUsage: (() => void)

@@ -169,14 +239,32 @@

- (): void
- (): void
- -
  Resets 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)

@@ -185,7 +273,7 @@

- (): number
- (): number
- Tasks queue size.
  
  @@ -193,15 +281,40 @@

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

@@ -209,20 +322,20 @@

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

Index

Index

Properties

Properties

Readonly clearTasksQueue

Readonly clearTasksQueue

Type declaration

Returns void

Readonly closeChannel

Returns void

Readonly dequeueTask

Readonly enqueueTask

Returns number

Returns number

Readonly getTaskWorkerUsage

Readonly getTaskFunctionWorkerUsage

Type declaration

Parameters

name: string

Returns undefined | WorkerUsage

name: string

Returns undefined | WorkerUsage

Readonly hasBackPressure

Type declaration

Returns boolean

Readonly info

Optional Readonly messageChannel

Optional onBackPressure

Optional onEmptyQueue

Readonly popTask

Type declaration

Returns undefined | Task<Data>

Readonly resetUsage

Returns void

Optional strategyData

tasksQueueBackPressureSize

Readonly tasksQueueSize

Readonly unshiftTask

Type declaration

Parameters

task: Task<Data>

Returns number

usage

Readonly usage

Readonly worker

Settings

Settings

Member Visibility

Theme

`Readonly` clearTasksQueue

`Readonly` clearTasksQueue

`Readonly` closeChannel

`Readonly` dequeueTask

`Readonly` enqueueTask

`Readonly` getTaskWorkerUsage

`Readonly` getTaskFunctionWorkerUsage

`Readonly` hasBackPressure

`Readonly` info

`Optional` `Readonly` messageChannel

`Optional` onBackPressure

`Optional` onEmptyQueue

`Readonly` popTask

`Readonly` resetUsage

`Optional` strategyData

`Readonly` tasksQueueSize

`Readonly` unshiftTask

`Readonly` usage

`Readonly` worker