X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FThreadWorker.html;h=6cc2dc1074c153dc7db1dd8ee5b69aa1bbe1d01b;hb=b6fea09e6a8174e664770741943cf08445066e2b;hp=4b9f97027359c76adcd0f97879a17d9d3ec9693d;hpb=2946f23da560702e3f3631887e1eeb88777bd47d;p=poolifier.git diff --git a/docs/classes/ThreadWorker.html b/docs/classes/ThreadWorker.html index 4b9f9702..6cc2dc10 100644 --- a/docs/classes/ThreadWorker.html +++ b/docs/classes/ThreadWorker.html @@ -1,13 +1,13 @@ -ThreadWorker | poolifier
+ThreadWorker | poolifier - v2.6.42
-
+
  • The search index is not available
  • poolifier - v2.6.42 +
    @@ -21,22 +21,25 @@ it will send a termination request to its main thread.

    If you use a DynamicThreadPool the extra workers that were created will be terminated, but the minimum number of workers will be guaranteed.

    +
    +
    +

    Author

    Alessandro Pio Ardizio

    -

    Author

    Alessandro Pio Ardizio

    - -

    Since

    0.0.1

    +

    Since

    0.0.1

    -
    +

    Type Parameters

    -
      +
      • Data = unknown

        -

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

        -
      • +

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

        -
    +

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

    +
    +

    Hierarchy

      @@ -44,52 +47,66 @@ but the minimum number of workers will be guaranteed.

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

    Constructors

    - +
      - +
    • Constructs a new poolifier thread worker.

      -
      +

      Type Parameters

      -
        +
        • Data = unknown

        • @@ -98,87 +115,154 @@ but the minimum number of workers will be guaranteed.

          Parameters

          • -
            fn: WorkerFunction<Data, Response>
            -

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

            -
          • +
            taskFunctions: TaskFunction<Data, Response> | TaskFunctions<Data, Response>
            +

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

            +
            +
          • opts: WorkerOptions = {}

            Options for the worker.

            -
    -

    Returns ThreadWorker<Data, Response>

    +
    +

    Returns ThreadWorker<Data, Response>

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

    -
    - -
    aliveInterval?: Timeout
    -

    Handler id of the aliveInterval worker alive check.

    -
    - +
    isMain: boolean

    Whether this is the main worker or not.

    -
    +
  • Defined in src/worker/abstract-worker.ts:85
  • - +
    lastTaskTimestamp: number

    Timestamp of the last task processed by this worker.

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

    Reference to main worker.

    -
    +
  • Defined in src/worker/abstract-worker.ts:65
  • - -
    opts: WorkerOptions = ...
    + +
    opts: WorkerOptions = DEFAULT_WORKER_OPTIONS

    Options for the worker.

    -
    +
  • Defined in src/worker/abstract-worker.ts:88
  • +
    + +
    port: MessagePort
    +

    Message port used to communicate with the main 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.

    +
    +
    +
    +

    Accessors

    +
    + +

    Methods

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

    Returns Func & {
        asyncResource: AsyncResource;
    }

    -
    - - +

    Returns Func

    +
    +

    Since

    v14.8.0, v12.19.0

    +
    +
  • Defined in node_modules/.pnpm/@types+node@20.5.9/node_modules/@types/node/async_hooks.d.ts:283
  • - +
    +
  • Defined in node_modules/.pnpm/@types+node@20.5.9/node_modules/@types/node/async_hooks.d.ts:302
  • - +
    -
    - -
    +
    + + -

    Returns string

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

    Returns void

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

    Returns void

    +
    +

    Throws

    https://nodejs.org/api/errors.html#class-error If the task function is not found.

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

    Returns void

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

    Returns void

    +
  • Defined in src/worker/thread-worker.ts:91
  • +
    + +
    - +
    +
  • Defined in node_modules/.pnpm/@types+node@20.5.9/node_modules/@types/node/async_hooks.d.ts:311
  • - +
    -

    On This Page

    +

    On This Page

    +
  • constructor
  • +
  • activeInterval
  • +
  • isMain
  • +
  • lastTaskTimestamp
  • +
  • opts
  • +
  • port
  • +
  • statistics
  • +
  • taskFunctions
  • +
  • id
  • +
  • addTaskFunction
  • +
  • asyncId
  • +
  • bind
  • +
  • emitDestroy
  • +
  • getMainWorker
  • +
  • handleError
  • +
  • handleKillMessage
  • +
  • handleReadyMessage
  • +
  • hasTaskFunction
  • +
  • listTaskFunctions
  • +
  • messageListener
  • +
  • removeTaskFunction
  • +
  • run
  • +
  • runAsync
  • +
  • runInAsyncScope
  • +
  • runSync
  • +
  • sendTaskFunctionsListToMainWorker
  • +
  • sendToMainWorker
  • +
  • setDefaultTaskFunction
  • +
  • triggerAsyncId
  • +
  • bind
  • +
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    +
    \ No newline at end of file