X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractWorker.html;h=2d8dfa499b03c9a01becfa39d87a2b8cb4e3a410;hb=b22361f4474e4a63a7482741d98f0c58b4b03b4c;hp=88a908c324ef4646e4e540fe10094abc103cee58;hpb=f1583b4edd427f8c3f2b4ddc652d2e102390b08e;p=poolifier.git diff --git a/docs/classes/AbstractWorker.html b/docs/classes/AbstractWorker.html index 88a908c3..2d8dfa49 100644 --- a/docs/classes/AbstractWorker.html +++ b/docs/classes/AbstractWorker.html @@ -1,554 +1,128 @@ -AbstractWorker | poolifier
-
- -
-
-
-
- -

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 serializable data.

    -
  • -
  • -

    Response = unknown

    -

    Type of response the worker sends back to the main worker. This can only be serializable data.

    -
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
- -
    - -
  • -

    Constructs a new poolifier worker.

    -
    -
    -

    Type Parameters

    -
      -
    • -

      MainWorker extends Worker | MessagePort

    • -
    • -

      Data = unknown

    • -
    • -

      Response = unknown

    -
    -

    Parameters

    -
      -
    • -
      type: string
      -

      The type of async event.

      -
    • -
    • -
      isMain: boolean
      -

      Whether this is the main worker or not.

      -
    • -
    • -
      fn: ((data: Data) => Response)
      -

      Function processed by the worker when the pool's execution function is invoked.

      -
      -
        -
      • -
          -
        • (data: Data): Response
        • -
        • -
          -

          Parameters

          -
            -
          • -
            data: Data
          -

          Returns Response

    • -
    • -
      mainWorker: undefined | null | MainWorker
      -

      Reference to main worker.

      -
    • -
    • -
      opts: WorkerOptions = ...
      -

      Options for the worker.

      -
    -

    Returns AbstractWorker<MainWorker, Data, Response>

-
-

Properties

-
- -
aliveInterval?: Timeout
-

Handler Id of the aliveInterval worker alive check.

-
-
- -
lastTaskTimestamp: number
-

Timestamp of the last task processed by this worker.

-
-
- -
mainWorker: undefined | null | MainWorker
-
- - -

Options for the worker.

-
-
-

Methods

-
- -
    - -
  • -
    -

    Returns

    The unique asyncId assigned to the resource.

    -
    -

    Returns number

-
- -
    - -
  • -

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

    -

    The returned function will have an asyncResource property referencing -the AsyncResource to which the function is bound.

    - -

    Since

    v14.8.0, v12.19.0

    -
    -
    -

    Type Parameters

    -
      -
    • -

      Func extends ((...args: any[]) => any)

    -
    -

    Parameters

    -
      -
    • -
      fn: Func
      -

      The function to bind to the current AsyncResource.

      -
    -

    Returns Func & { asyncResource: AsyncResource }

-
- -
    - -
  • -

    Check to see if the worker should be terminated, because its living too long.

    -
    -

    Returns void

-
- -
    - -
  • -

    Checks if the fn parameter is passed to the constructor.

    -
    -
    -

    Parameters

    -
      -
    • -
      fn: ((data: Data) => Response)
      -

      The function that should be defined.

      -
      -
        -
      • -
          -
        • (data: Data): Response
        • -
        • -
          -

          Parameters

          -
            -
          • -
            data: Data
          -

          Returns Response

    -

    Returns void

-
- -
-
- -
    - -
  • -

    Call all destroy hooks. This should only ever be called once. An error will +AbstractWorker | poolifier - v3.0.5

    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

    • 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

      A reference to asyncResource.

      -
      -

      Returns AbstractWorker<MainWorker, Data, Response>

    -
    - -
      - -
    • -

      Returns the main worker.

      - -

      Returns

      Reference to the main worker.

      -
      -

      Returns MainWorker

    -
    - -
      - -
    • -

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

      - -

      Returns

      Message of the error.

      -
      -
      -

      Parameters

      -
        -
      • -
        e: string | Error
        -

        The error raised by the worker.

        -
      -

      Returns string

    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        value: MessageValue<Data, MainWorker>
      • -
      • -
        fn: ((data: Data) => Response)
        -
          -
        • -
            -
          • (data: Data): Response
          • -
          • -
            -

            Parameters

            -
              -
            • -
              data: Data
            -

            Returns Response

      -

      Returns void

    -
    - -
      - -
    • -

      Runs the given function synchronously.

      -
      -
      -

      Parameters

      -
        -
      • -
        fn: ((data?: Data) => Response)
        -

        Function that will be executed.

        -
        -
          -
        • -
            -
          • (data?: Data): Response
          • -
          • -
            -

            Parameters

            -
              -
            • -
              Optional data: Data
            -

            Returns Response

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

        Input data for the given function.

        -
      -

      Returns void

    -
    - -
      - -
    • -

      Runs the given function asynchronously.

      -
      -
      -

      Parameters

      -
        -
      • -
        fn: ((data?: Data) => Promise<Response>)
        -

        Function that will be executed.

        -
        -
          -
        • -
            -
          • (data?: Data): Promise<Response>
          • -
          • -
            -

            Parameters

            -
              -
            • -
              Optional data: Data
            -

            Returns Promise<Response>

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

        Input data for the given function.

        -
      -

      Returns void

    -
    - -
      - -
    • -

      Call the provided function with the provided arguments in the execution context +

      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.

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

      +

      Returns string[]

      The names of the worker's task functions.

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

      - -

      Since

      v9.6.0

      -
      -
      -

      Type Parameters

      -
        -
      • -

        This

      • -
      • -

        Result

      -
      -

      Parameters

      -
        -
      • -
        fn: ((this: This, ...args: any[]) => Result)
        -

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

        -
        -
          -
        • -
            -
          • (this: This, ...args: any[]): 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

    -
    - -
      - -
    • -

      Sends a message to the main worker.

      -
      -
      -

      Parameters

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

        The response message.

        -
      -

      Returns void

    -
    - -
      - -
    • -
      -

      Returns

      The same triggerAsyncId that is passed to the AsyncResource constructor.

      -
      -

      Returns number

    -
    - -
      - -
    • -

      Binds the given function to the current execution context.

      -

      The returned function will have an asyncResource property referencing -the AsyncResource to which the function is bound.

      - -

      Since

      v14.8.0, v12.19.0

      -
      -
      -

      Type Parameters

      -
        -
      • -

        Func extends ((this: ThisArg, ...args: any[]) => 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 & { asyncResource: AsyncResource }

    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    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

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