X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FThreadWorker.html;h=62198283e49923fb181a0cf522035b8304ea8afc;hb=73d8141b526469f4fce46da956280f2b9146accb;hp=6f5157405ca971c90572fd68903018e8a4a5aedd;hpb=cfc6e8df4c903b63514c46cb67b3f5e24079d3ce;p=poolifier.git diff --git a/docs/classes/ThreadWorker.html b/docs/classes/ThreadWorker.html index 6f515740..62198283 100644 --- a/docs/classes/ThreadWorker.html +++ b/docs/classes/ThreadWorker.html @@ -1,4 +1,4 @@ -ThreadWorker | poolifier
+ThreadWorker | poolifier
-
+
  • poolifier
    • @@ -26,25 +26,25 @@ but the minimum number of workers will be guaranteed.

    Since

    0.0.1

-
+

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:25
    • @@ -52,272 +52,231 @@ but the minimum number of workers will be guaranteed.

    Constructors

    -
    constructor +
    constructor

    Properties

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

    Methods

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

    Constructors

    -
    +

    constructor

    -
      - +
        +

      • Constructs a new poolifier thread worker.

        -
        +

        Type Parameters

        -
          +
          • -

            Data = unknown

            • +

            Data = unknown

          • -

            Response = unknown

        +

        Response = unknown

    Parameters

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

      • +
      taskFunctions: WorkerFunction<Data, Response> | TaskFunctions<Data, Response>
      +

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

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

      Options for the worker.

    -

    Returns ThreadWorker<Data, Response>

    +
  • Defined in src/worker/thread-worker.ts:35

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

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

    Protected Readonly isMain

    +
    isMain: boolean
    +

    Whether this is the main worker or not.

    +
    +

    Protected lastTaskTimestamp

    -
    lastTaskTimestamp: number
    +
    lastTaskTimestamp: number

    Timestamp of the last task processed by this worker.

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

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

    Protected Readonly opts

    +
    opts: WorkerOptions = ...

    Options for the worker.

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

    Protected taskFunctions

    +
    taskFunctions: Map<string, WorkerFunction<Data, Response>>
    +

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

    +

    Methods

    -
    +

    asyncId

    -
      - +
        +
      • -
        -

        Returns

        The unique asyncId assigned to the resource.

        -
        -

        Returns number

    -
    +
  • Defined in node_modules/.pnpm/@types+node@20.1.0/node_modules/@types/node/async_hooks.d.ts:312
    • +

    bind

    -
      - +
        +

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

        +

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

    Parameters

    • -
      fn: Func
      +
      fn: Func

      The function to bind to the current AsyncResource.

    -

    Returns Func & {
        asyncResource: AsyncResource;
    }

    -
    +
  • Defined in node_modules/.pnpm/@types+node@20.1.0/node_modules/@types/node/async_hooks.d.ts:287
    • +

    Protected checkAlive

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

    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 the resource is left to be collected by the GC then the destroy hooks will never be called.

        - -

        Returns

        A reference to asyncResource.

        -

        Returns ThreadWorker<Data, Response>

    -
    +
  • Defined in node_modules/.pnpm/@types+node@20.1.0/node_modules/@types/node/async_hooks.d.ts:308
    • +

    Protected getMainWorker

    -
      - +
        +

      • Returns the main worker.

        - -

        Returns

        Reference to the main worker.

        -

        Returns MessagePort

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

    Protected handleError

    -
      - +
        +

      • 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
          +
          e: string | Error

          The error raised by the worker.

        -

        Returns string

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

    Protected messageListener

    -
      - -
    • -
      -

      Parameters

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

            Parameters

            -
              -
            • -
              data: Data
            -

            Returns Response

      -

      Returns void

    -
    -

    Protected run

    -
      - +
        +
      • -

        Runs the given function synchronously.

        +

        Worker message listener.

        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.

          +
          message: MessageValue<Data, MessagePort>
          +

          Message received.

        Returns void

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

    Protected runAsync

    -
      - +
        +

      • Runs the given function asynchronously.

        @@ -325,32 +284,21 @@ never be called.

        Parameters

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

          Function that will be executed.

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

              Parameters

              -
                -
              • -
                Optional data: Data
              -

              Returns Promise<Response>

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

    Input data for the given function.

    • Returns void

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

    runInAsyncScope

    -
      - +
        +

      • Call the provided function with the provided arguments in the execution context of the async resource. This will establish the context, trigger the AsyncHooks @@ -359,112 +307,134 @@ then restore the original execution context.

        Since

        v9.6.0

        -
        +

        Type Parameters

        -
          +
          • -

            This

            • +

            This

          • -

            Result

        +

        Result

    Parameters

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

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

      • -
          -
        • (this: This, ...args: any[]): Result
          • +
            +
          • (this, ...args): Result

          • Parameters

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

            Returns Result

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

    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

    +
    +

    Protected runSync

    +
    +

    Protected sendToMainWorker

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

    triggerAsyncId

    -
    -
    +
  • Defined in node_modules/.pnpm/@types+node@20.1.0/node_modules/@types/node/async_hooks.d.ts:317
    • +

    Static bind

    -

    Parameters

    -

    Returns Func & {
        asyncResource: AsyncResource;
    }

    +
    +
    -

    Settings

     +

    Settings

    Member Visibility

    @@ -474,36 +444,77 @@ the AsyncResource to which the function is bound.

    • -

    Theme

    -
    +
    +

    On This Page
    - -
    +
  • constructor
    • +
  • aliveInterval
    • +
  • isMain
    • +
  • lastTaskTimestamp
    • +
  • mainWorker
    • +
  • opts
    • +
  • taskFunctions
    • +
  • asyncId
    • +
  • bind
    • +
  • checkAlive
    • +
  • emitDestroy
    • +
  • getMainWorker
    • +
  • handleError
    • +
  • messageListener
    • +
  • runAsync
    • +
  • runInAsyncScope
    • +
  • runSync
    • +
  • sendToMainWorker
    • +
  • triggerAsyncId
    • +
  • bind
    • +
    +
    +

    Generated using TypeDoc

    -
    \ No newline at end of file +
    \ No newline at end of file