X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FClusterWorker.html;h=b28355977ded6eeb9de3c98eb45246d7a74eb4e0;hb=70353024c44987c467dadcec306c699ce4ae1f06;hp=22aa4f651f6c505681afce52e086ca223cf43bdc;hpb=402f08b7b31c721d9780c795e5e34a8998bc88aa;p=poolifier.git diff --git a/docs/classes/ClusterWorker.html b/docs/classes/ClusterWorker.html index 22aa4f65..b2835597 100644 --- a/docs/classes/ClusterWorker.html +++ b/docs/classes/ClusterWorker.html @@ -1,4 +1,4 @@ -ClusterWorker | poolifier
+ClusterWorker | poolifier
  • Preparing search index...
  • -
  • The search index is not available
poolifier
+
  • The search index is not available
  • poolifier
    -
    +
    • poolifier
    • @@ -26,25 +26,25 @@ but the minimum number of workers will be guaranteed.

      Since

      2.0.0

    -
    +

    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 worker. This can only be serializable data.

    Hierarchy

      -
    • AbstractWorker<Worker, Data, Response> +
    • AbstractWorker<Worker, Data, Response>
      • ClusterWorker
    +
  • Defined in src/worker/cluster-worker.ts:25
  • @@ -52,266 +52,231 @@ but the minimum number of workers will be guaranteed.

    Constructors

    -
    +
    -
      - +
        +
      • Constructs a new poolifier cluster 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 = {}
      +
      opts: WorkerOptions = {}

      Options for the worker.

    -

    Returns ClusterWorker<Data, Response>

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

    -
    +
    -
    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
  • +
    + +
    isMain: boolean
    +

    Whether this is the main worker or not.

    +
    +
    -
    lastTaskTimestamp: number
    +
    lastTaskTimestamp: number

    Timestamp of the last task processed by this worker.

    -
    +
  • Defined in src/worker/abstract-worker.ts:38
  • +
    -
    mainWorker: undefined | null | Worker
    -
    - - +
  • Defined in src/worker/abstract-worker.ts:58
  • +
    + +
    opts: WorkerOptions = ...

    Options for the worker.

    +
  • Defined in src/worker/abstract-worker.ts:59
  • +
    + +
    taskFunctions: Map<string, WorkerFunction<Data, Response>>
    +

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

    +

    Methods

    -
    +
    -
      - +
        +
      • -
        -

        Returns

        The unique asyncId assigned to the resource.

        -
        -

        Returns number

    -
    +
  • Defined in node_modules/.pnpm/@types+node@20.2.5/node_modules/@types/node/async_hooks.d.ts:306
  • +
    -
      - +
        +
      • 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.2.5/node_modules/@types/node/async_hooks.d.ts:283
  • +
    -
    -
    +
  • Defined in src/worker/abstract-worker.ts:179
  • +
    -
      - +
        +
      • 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 ClusterWorker<Data, Response>

    -
    +
  • Defined in node_modules/.pnpm/@types+node@20.2.5/node_modules/@types/node/async_hooks.d.ts:302
  • +
    -
      - +
    -
    +
  • Defined in src/worker/abstract-worker.ts:162
  • +
    -
      - +
        +
      • -
        -

        Inherit Doc

        +

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

        +

        Parameters

        • -
          e: string | Error
        -

        Returns string

    +

    Returns string

    Message of the error.

    + -
    +
  • Defined in src/worker/cluster-worker.ts:56
  • +
    -
      - +
        +
      • -
        -

        Parameters

        -
          -
        • -
          value: MessageValue<Data, Worker>
        • -
        • -
          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.

        +

        Worker message listener.

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

            • -
              Optional data: Data
            -

            Returns Response

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

        Input data for the given function.

        +
        message: MessageValue<Data, Worker>
        +

        Message received.

      Returns void

    -
    +
  • Defined in src/worker/abstract-worker.ts:138
  • +
    -
      - +
        +
      • Runs the given function asynchronously.

        @@ -319,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:233
  • +
    -

    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

    +
    + +
    +
    -
    -
    +
  • Defined in src/worker/cluster-worker.ts:51
  • +
    -
    -
    +
  • Defined in node_modules/.pnpm/@types+node@20.2.5/node_modules/@types/node/async_hooks.d.ts:311
  • +
    -

    Parameters

    -

    Returns Func & {
        asyncResource: AsyncResource;
    }

    +
    +
    +
    +

    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