X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractWorker.html;h=62d07519ef83be25da752177239cc27e2153b57d;hb=ecde6ea8c439bbdd9dc2ca118731b5006a1a9884;hp=1dd4753f9126d474ccaf6193504cbeb54e59ed37;hpb=d93988cdbc3eb55747301602bfa03d8543223c71;p=poolifier.git diff --git a/docs/classes/AbstractWorker.html b/docs/classes/AbstractWorker.html index 1dd4753f..62d07519 100644 --- a/docs/classes/AbstractWorker.html +++ b/docs/classes/AbstractWorker.html @@ -1,895 +1,98 @@ -AbstractWorker | poolifier - v2.7.4
-
- -
-
-
-
- -

Class AbstractWorker<MainWorker, Data, Response>Abstract

-
-

Base class that implements some shared logic for all poolifier workers.

-
-
-
-

Type Parameters

-
    -
  • -

    MainWorker extends Worker | MessagePort

    -

    Type of main worker.

    -
    -
  • -
  • -

    Data = unknown

    -

    Type of data this worker receives from pool's execution. This can only be structured-cloneable data.

    -
    -
  • -
  • -

    Response = unknown

    -

    Type of response the worker sends back to the main worker. This can only be structured-cloneable data.

    -
    -
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
- -
    - -
  • -

    Constructs a new poolifier worker.

    -
    -
    -

    Type Parameters

    -
      -
    • -

      MainWorker extends MessagePort | Worker

    • -
    • -

      Data = unknown

    • -
    • -

      Response = unknown

    -
    -

    Parameters

    -
      -
    • -
      type: string
      -

      The type of async event.

      -
      -
    • -
    • -
      isMain: boolean
      -

      Whether this is the main worker or not.

      -
      -
    • -
    • -
      mainWorker: MainWorker
      -

      Reference to main worker.

      -
      -
    • -
    • -
      taskFunctions: TaskFunction<Data, Response> | TaskFunctions<Data, Response>
      -

      Task function(s) processed by the worker when the pool's execution function is invoked. The first function is the default function.

      -
      -
    • -
    • -
      opts: WorkerOptions = DEFAULT_WORKER_OPTIONS
      -

      Options for the worker.

      -
      -
    -

    Returns AbstractWorker<MainWorker, Data, Response>

    -
-
-

Properties

-
- -
activeInterval?: Timeout
-

Handler id of the activeInterval worker activity check.

-
-
-
- -
id: number
-

Worker id.

-
-
-
- -
isMain: boolean
-

Whether this is the main worker or not.

-
-
-
- -
lastTaskTimestamp: number
-

Timestamp of the last task processed by this worker.

-
-
-
- -
mainWorker: MainWorker
-

Reference to main worker.

-
-
-
- -
opts: WorkerOptions = DEFAULT_WORKER_OPTIONS
-

Options for the worker.

-
-
-
- -
statistics: WorkerStatistics
-

Performance statistics computation requirements.

-
-
-
- -
taskFunctions: Map<string, TaskFunction<Data, Response>>
-

Task function(s) processed by the worker when the pool's execution function is invoked.

-
-
-
-

Methods

-
- -
  • Handles an error and convert it to a string so it can be sent back to the main worker.

    +

    Parameters

    • error: string | Error

      The error raised by the worker.

      +

    Returns string

    The error message.

    +
  • Lists the names of the worker's task functions.

    +

    Returns string[]

    The names of the worker's task functions.

    +

Generated using TypeDoc

\ No newline at end of file