X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractWorker.html;h=510188e336700ab0f194b1636e7f58797bcd6c13;hb=47b6e0b781f54f5fa66c58a6d832dac5efe6bae8;hp=f29da7f4f9ffcecbd52ae0a675ddaccadee66d93;hpb=904ddac9d4d1484aa4364ee8c042c62871ec2e39;p=poolifier.git diff --git a/docs/classes/AbstractWorker.html b/docs/classes/AbstractWorker.html index f29da7f4..510188e3 100644 --- a/docs/classes/AbstractWorker.html +++ b/docs/classes/AbstractWorker.html @@ -1,21 +1,20 @@ -AbstractWorker | poolifier - v3.0.13

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

constructor +AbstractWorker | poolifier - v3.1.19

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 (view full)

Constructors

  • Constructs a new poolifier worker.

    -

    Type Parameters

    • MainWorker extends MessagePort | Worker

    • Data = unknown

    • Response = unknown

    Parameters

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

      +

Constructors

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

Returns AbstractWorker<MainWorker, Data, Response>

Properties

activeInterval?: Timeout

Handler id of the activeInterval worker activity check.

+
id: number

Worker id.

+
isMain: undefined | boolean

Whether this is the main worker or not.

+
lastTaskTimestamp: number

Timestamp of the last task processed by this worker.

+
mainWorker: undefined | null | 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

  • Checks if the taskFunctions parameter is passed to the constructor and valid.

    -

    Parameters

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

      The task function(s) parameter that should be checked.

      -

    Returns void

  • Returns the main worker.

    -

    Returns MainWorker

    Reference to the main worker.

    +

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file