X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractWorker.html;h=96fd87bf2b9972c7e9ab6f01042e5850a9650858;hb=743917b8a6544156a5b966854a3e3747db19508d;hp=dd6c9628f805c0e90630e32c5accebac019be9d8;hpb=da631e977b488fb76cc1881c991a6fda8d8bb6e0;p=poolifier.git diff --git a/docs/classes/AbstractWorker.html b/docs/classes/AbstractWorker.html index dd6c9628..96fd87bf 100644 --- a/docs/classes/AbstractWorker.html +++ b/docs/classes/AbstractWorker.html @@ -1,85 +1,23 @@ -AbstractWorker | poolifier - v3.0.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

-
-
-

Properties

-
activeInterval? +AbstractWorker | poolifier - v3.1.15

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

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

-
- -

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 number

    The unique asyncId assigned to the resource.

    - -
-
- -
-
- -
    - -
  • -

    Binds the given function to execute to this AsyncResource's scope.

    -
    -
    -

    Type Parameters

    -
      -
    • -

      Func extends ((...args) => any)

    -
    -

    Parameters

    -
      -
    • -
      fn: Func
      -

      The function to bind to the current AsyncResource.

      -
      -
    -

    Returns Func

    -
    -

    Since

    v14.8.0, v12.19.0

    -
-
- -
-
- -
-
- -
-
- -
    - -
  • -

    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

    -
-
- -
-
- -
    - -
  • -

    Call all destroy hooks. This should only ever be called once. An error will -be thrown if it is called more than once. This must be manually called. If -the resource is left to be collected by the GC then the destroy hooks will -never be called.

    -
    -

    Returns AbstractWorker<MainWorker, Data, Response>

    A reference to asyncResource.

    - -
-
- -
-
- -
-
- -
    - -
  • -

    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.

    - -
-
- -
-
- -
    - -
  • -

    Handles the ready message sent by the main worker.

    -
    -
    -

    Parameters

    -
      -
    • -
      message: MessageValue<Data, unknown>
      -

      The ready message.

      -
      -
    -

    Returns void

    -
-
- -
-
- -
-
- -
    - -
  • -

    Lists the names of the worker's task functions.

    -
    -

    Returns string[]

    The names of the worker's task functions.

    - -
-
- -
-
- -
-
- -
-
- -
    - -
  • -

    Runs the given task function asynchronously.

    -
    -
    -

    Parameters

    -
      -
    • -
      fn: TaskAsyncFunction<Data, Response>
      -

      Task function that will be executed.

      -
      -
    • -
    • -
      task: Task<Data>
      -

      Input data for the task function.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Call the provided function with the provided arguments in the execution context -of the async resource. This will establish the context, trigger the AsyncHooks -before callbacks, call the function, trigger the AsyncHooks after callbacks, and -then restore the original execution context.

    -
    -
    -

    Type Parameters

    -
      -
    • -

      This

    • -
    • -

      Result

    -
    -

    Parameters

    -
      -
    • -
      fn: ((this, ...args) => Result)
      -

      The function to call in the execution context of this async resource.

      -
      -
      -
        -
      • -
          -
        • (this, ...args): Result
        • -
        • -
          -

          Parameters

          -
            -
          • -
            this: This
          • -
          • -
            Rest ...args: any[]
          -

          Returns Result

    • -
    • -
      Optional thisArg: This
      -

      The receiver to be used for the function call.

      -
      -
    • -
    • -
      Rest ...args: any[]
      -

      Optional arguments to pass to the function.

      -
      -
    -

    Returns Result

    -
    -

    Since

    v9.6.0

    -
-
- -
    - -
  • -

    Runs the given task function synchronously.

    -
    -
    -

    Parameters

    -
      -
    • -
      fn: TaskSyncFunction<Data, Response>
      -

      Task function that will be executed.

      -
      -
    • -
    • -
      task: Task<Data>
      -

      Input data for the task function.

      -
      -
    -

    Returns void

    -
-
- -
-
- -
-
- -
-
- -
-
- -
-
- -
    - -
  • -

    Returns number

    The same triggerAsyncId that is passed to the AsyncResource constructor.

    - -
-
- -
-
- -
    - -
  • -

    Binds the given function to the current execution context.

    -
    -
    -

    Type Parameters

    -
      -
    • -

      Func extends ((this, ...args) => any)

    • -
    • -

      ThisArg

    -
    -

    Parameters

    -
      -
    • -
      fn: Func
      -

      The function to bind to the current execution context.

      -
      -
    • -
    • -
      Optional type: string
      -

      An optional name to associate with the underlying AsyncResource.

      -
      -
    • -
    • -
      Optional thisArg: ThisArg
    -

    Returns Func

    -
    -

    Since

    v14.8.0, v12.19.0

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Parameters

Returns TaskFunctionOperationResult

Whether the task function was added or not.

+

Generated using TypeDoc

\ No newline at end of file