X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FThreadWorker.html;h=4b9f97027359c76adcd0f97879a17d9d3ec9693d;hb=938d9c678aa8e70e5642feffb90604cf25c993fe;hp=1a4d9c9138897d7e907eeed1947605a11d1e4617;hpb=79458fb6e10234a237757111e710f8f71424fa06;p=poolifier.git diff --git a/docs/classes/ThreadWorker.html b/docs/classes/ThreadWorker.html index 1a4d9c91..4b9f9702 100644 --- a/docs/classes/ThreadWorker.html +++ b/docs/classes/ThreadWorker.html @@ -1,4 +1,4 @@ -ThreadWorker | poolifier
+ThreadWorker | poolifier
-
+
  • poolifier
    • @@ -30,21 +30,21 @@ but the minimum number of workers will be guaranteed.

    Type Parameters

    • -

      Data = unknown

      +

      Data = unknown

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

    • -

      Response = unknown

      +

      Response = unknown

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

    Hierarchy

      -
    • AbstractWorker<MessagePort, Data, Response> +
    • AbstractWorker<MessagePort, Data, Response>
      • ThreadWorker
    +
  • Defined in src/worker/thread-worker.ts:21
@@ -52,37 +52,38 @@ but the minimum number of workers will be guaranteed.

Constructors

-
constructor +
constructor

Properties

-
aliveInterval? -lastTaskTimestamp -mainWorker -opts +
aliveInterval? +isMain +lastTaskTimestamp +mainWorker +opts

Methods

-
asyncId -bind -checkAlive -emitDestroy -getMainWorker -handleError -messageListener -run -runAsync -runInAsyncScope -sendToMainWorker -triggerAsyncId -bind +
asyncId +bind +checkAlive +emitDestroy +getMainWorker +handleError +messageListener +run +runAsync +runInAsyncScope +sendToMainWorker +triggerAsyncId +bind

Constructors

-
+

constructor

-
    - +
      +

    • Constructs a new poolifier thread worker.

      @@ -90,87 +91,84 @@ but the minimum number of workers will be guaranteed.

      Type Parameters

      • -

        Data = unknown

        • +

        Data = unknown

      • -

        Response = unknown

+

Response = unknown

Parameters

  • -
    fn: ((data: Data) => Response)
    +
    fn: WorkerFunction<Data, Response>

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

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

        Parameters

        -
          -
        • -
          data: Data
        -

        Returns Response

    • +
  • -
    opts: WorkerOptions = {}
    +
    opts: WorkerOptions = {}

    Options for the worker.

    • -

    Returns ThreadWorker<Data, Response>

    Properties

    -
    +

    Protected Optional Readonly aliveInterval

    -
    aliveInterval?: Timeout
    -

    Handler Id of the aliveInterval worker alive check.

    +
    aliveInterval?: Timeout
    +

    Handler id of the aliveInterval worker alive check.

    +
    +
    +

    Protected Readonly isMain

    +
    isMain: boolean
    +

    Whether this is the main worker or not.

    -
    +
  • Defined in src/worker/abstract-worker.ts:48
    • +

    Protected lastTaskTimestamp

    -
    lastTaskTimestamp: number
    +
    lastTaskTimestamp: number

    Timestamp of the last task processed by this worker.

    -
    +
  • Defined in src/worker/abstract-worker.ts:32
    • +

    Protected mainWorker

    -
    mainWorker: undefined | null | MessagePort
    +
    mainWorker: undefined | null | MessagePort

    Reference to main worker.

    -
    -

    Readonly opts

    -
    opts: WorkerOptions
    +
  • Defined in src/worker/abstract-worker.ts:50
    • +
    +

    Protected Readonly opts

    +
    opts: WorkerOptions = ...

    Options for the worker.

    +
  • Defined in src/worker/abstract-worker.ts:51

    • Methods

    -
    +

    asyncId

    -
      - +
        +

      • Returns

        The unique asyncId assigned to the resource.

        Returns number

    -
    +

    bind

    -
      - +
        +

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

        The returned function will have an asyncResource property referencing @@ -182,33 +180,33 @@ the AsyncResource to which the function is bound.

        Type Parameters

        • -

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

    +

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

    Parameters

    • -
      fn: Func
      +
      fn: Func

      The function to bind to the current AsyncResource.

    -

    Returns Func & {
        asyncResource: AsyncResource;
    }

    -
    +

    Protected checkAlive

    -
    -
    +
  • Defined in src/worker/abstract-worker.ts:156
    • +

    emitDestroy

    -
      - +
        +

      • 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 @@ -217,27 +215,27 @@ never be called.

        Returns

        A reference to asyncResource.

        -

        Returns ThreadWorker<Data, Response>

    -
    +

    Protected getMainWorker

    -
      - +
    -
    +
  • Defined in src/worker/abstract-worker.ts:139
    • +

    Protected handleError

    -
      - +
        +

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

        @@ -247,44 +245,39 @@ never be called.

        Parameters

        • -
          e: string | Error
          +
          e: string | Error

          The error raised by the worker.

        Returns string

    -
    +
  • Defined in src/worker/abstract-worker.ts:171
    • +

    Protected messageListener

    -
      - +
        +
      • +

        Worker message listener.

        +

        Parameters

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

              Parameters

              -
                +
                message: MessageValue<Data, MessagePort>
                +

                Message received.

                +
              • -
                data: Data
              -

              Returns Response

        +
        fn: WorkerFunction<Data, Response>
        +

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

        +

    Returns void

    -
    +
  • Defined in src/worker/abstract-worker.ts:89
    • +

    Protected run

    -
      - +
        +

      • Runs the given function synchronously.

        @@ -292,32 +285,21 @@ never be called.

        Parameters

        • -
          fn: ((data?: Data) => Response)
          +
          fn: WorkerSyncFunction<Data, Response>

          Function that will be executed.

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

              Parameters

              -
                -
              • -
                Optional data: Data
              -

              Returns Response

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

    Input data for the given function.

    • Returns void

    -
    +
  • Defined in src/worker/abstract-worker.ts:181
    • +

    Protected runAsync

    -
    -
    +
  • Defined in src/worker/abstract-worker.ts:208
    • +

    runInAsyncScope

    -
    +

    Result

    Parameters

    +

    Returns Result

  • -
    Optional thisArg: This
    +
    Optional thisArg: This

    The receiver to be used for the function call.

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

    Optional arguments to pass to the function.

    • -

    Returns Result

    +

    triggerAsyncId

    -
    -
    +

    Static bind

    -
      - +
        +

      • Binds the given function to the current execution context.

        The returned function will have an asyncResource property referencing @@ -441,30 +414,31 @@ the AsyncResource to which the function is bound.

        Type Parameters

        • -

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

          • +

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

        • -

          ThisArg

    +

    ThisArg

    Parameters

    -

    Returns Func & {
        asyncResource: AsyncResource;
    }