X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIWorkerNode.html;h=6b4b5265d81022dd91adb48fb7d054fe6ee156a2;hb=b4e93467358d93166716dc6e5075d58c18c961c7;hp=ebd0f4a3ba3dd73ef33e64eb3db0afe854ff382d;hpb=edc0cdb11d19cc5993ca98004a7dbbf49439acd8;p=poolifier.git diff --git a/docs/interfaces/IWorkerNode.html b/docs/interfaces/IWorkerNode.html index ebd0f4a3..6b4b5265 100644 --- a/docs/interfaces/IWorkerNode.html +++ b/docs/interfaces/IWorkerNode.html @@ -1,340 +1,67 @@ -IWorkerNode | poolifier - v2.6.30
-
- -
-
-
-
- -

Interface IWorkerNode<Worker, Data>Internal

-
-

Worker node interface.

-
-
-
-

Type Parameters

-
    -
  • -

    Worker extends IWorker

    -

    Type of worker.

    -
    -
    • -
  • -

    Data = unknown

    -

    Type of data sent to the worker. This can only be structured-cloneable data.

    -
    -
-
-

Hierarchy

-
    -
  • IWorkerNode
-
-
-
- -
-
-

Properties

-
clearTasksQueue +IWorkerNode | poolifier - v3.0.6

Interface IWorkerNode<Worker, Data>Internal

Worker node interface.

+

Type Parameters

  • Worker extends IWorker

    Type of worker.

    +

  • Data = unknown

    Type of data sent to the worker. This can only be structured-cloneable data.

    +

Hierarchy

  • EventTarget
    • IWorkerNode

Properties

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

Properties

-
-

Readonly clearTasksQueue

-
clearTasksQueue: (() => void)
-
-

Type declaration

-
    -
  • -
      -
    • (): void
      • -
    • -

      Clears tasks queue.

      -
      -

      Returns void

      -
-
-

Readonly closeChannel

-
closeChannel: (() => void)
-
-

Type declaration

-
    -
  • -
      -
    • (): void
      • -
    • -

      Closes communication channel.

      -
      -

      Returns void

      -
-
-

Readonly dequeueTask

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

Type declaration

-
    -
  • -
      -
    • (): undefined | Task<Data>
      • -
    • -

      Dequeue task.

      -
      -

      Returns undefined | Task<Data>

      The dequeued task.

      - -
-
-

Readonly enqueueTask

-
enqueueTask: ((task) => number)
-
-

Type declaration

-
    -
  • -
      -
    • (task): number
      • -
    • -

      Enqueue task.

      -
      -
      -

      Parameters

      -
        -
      • -
        task: Task<Data>
        -

        The task to queue.

        -
        -
      -

      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.

      - -
-
-

Readonly info

-
info: WorkerInfo
-

Worker info.

-
-
-
-

Optional Readonly messageChannel

-
messageChannel?: MessageChannel
-

Message channel.

-
-
-
-

Readonly resetUsage

-
resetUsage: (() => void)
-
-

Type declaration

-
    -
  • -
      -
    • (): void
      • -
    • -

      Resets usage statistics.

      -
      -

      Returns void

      -
-
-

Readonly tasksQueueSize

-
tasksQueueSize: (() => number)
-
-

Type declaration

-
    -
  • -
      -
    • (): number
      • -
    • -

      Tasks queue size.

      -
      -

      Returns number

      The tasks queue size.

      - -
-
-

usage

-
usage: WorkerUsage
-

Worker usage statistics.

-
-
-
-

Readonly worker

-
worker: Worker
-

Worker.

-
-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Methods

addEventListener +dispatchEvent +removeEventListener +

Properties

Readonly clearTasksQueue

clearTasksQueue: (() => void)

Type declaration

    • (): void

    • Clears tasks queue.

      +

      Returns void

Readonly closeChannel

closeChannel: (() => void)

Type declaration

    • (): void

    • Closes communication channel.

      +

      Returns void

Readonly deleteTaskFunctionWorkerUsage

deleteTaskFunctionWorkerUsage: ((name) => boolean)

Type declaration

    • (name): boolean

    • Deletes task function worker usage statistics.

      +

      Parameters

      • name: string

        The task function name.

        +

      Returns boolean

      true if the task function worker usage statistics were deleted, false otherwise.

      +

Readonly dequeueTask

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

Type declaration

    • (): undefined | Task<Data>

    • Dequeue task.

      +

      Returns undefined | Task<Data>

      The dequeued task.

      +

Readonly enqueueTask

enqueueTask: ((task) => number)

Type declaration

    • (task): number

    • Enqueue task.

      +

      Parameters

      • task: Task<Data>

        The task to queue.

        +

      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.

      +

Readonly info

info: WorkerInfo

Worker info.

+

Optional Readonly messageChannel

messageChannel?: MessageChannel

Message channel (worker_threads only).

+

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)

Type declaration

    • (): void

    • Resets usage statistics.

      +

      Returns void

Optional strategyData

strategyData?: StrategyData

Worker choice strategy data. +This is used to store data that are 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)

Type declaration

    • (): number

    • Tasks queue size.

      +

      Returns number

      The tasks queue size.

      +

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.

      +

Readonly usage

usage: WorkerUsage

Worker usage statistics.

+

Readonly worker

worker: Worker

Worker.

+

Methods

addEventListener

  • Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

    +

    The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

    +

    When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

    +

    When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

    +

    When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

    +

    If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

    +

    The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

    +

    MDN Reference

    +

    Parameters

    • type: string
    • callback: null | EventListenerOrEventListenerObject
    • Optional options: boolean | AddEventListenerOptions

    Returns void

dispatchEvent

  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    +

    MDN Reference

    +

    Parameters

    • event: Event

    Returns boolean

removeEventListener

  • Removes the event listener in target's event listener list with the same type, callback, and options.

    +

    MDN Reference

    +

    Parameters

    • type: string
    • callback: null | EventListenerOrEventListenerObject
    • Optional options: boolean | EventListenerOptions

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file