X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FClusterWorker.html;h=b91ff4f3228a8ed8093eca4fda5e06de78bcaf30;hb=800480935c90f3847c389dd5dbfca11760e78675;hp=3a9a473cacbd623a973466bed1203856fccde754;hpb=f33c2d55c063a50c0025bf707fa4faf7a5e25f6e;p=poolifier.git diff --git a/docs/classes/ClusterWorker.html b/docs/classes/ClusterWorker.html index 3a9a473c..11bba61f 100644 --- a/docs/classes/ClusterWorker.html +++ b/docs/classes/ClusterWorker.html @@ -1,13 +1,13 @@ -ClusterWorker | poolifier - v2.6.12
+ClusterWorker | poolifier - v3.0.1
-
+
  • The search index is not available
  • poolifier - v3.0.1 +
    @@ -47,55 +47,58 @@ but the minimum number of workers will be guaranteed.

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

    Constructors

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

    -
    - -
    aliveInterval?: Timeout
    -

    Handler id of the aliveInterval worker alive check.

    +
    + +
    activeInterval?: Timeout
    +

    Handler id of the activeInterval worker activity check.

    +
  • Defined in src/worker/abstract-worker.ts:79
  • isMain: boolean
    @@ -145,7 +148,7 @@ but the minimum number of workers will be guaranteed.

    +
  • Defined in src/worker/abstract-worker.ts:91
  • lastTaskTimestamp: number
    @@ -154,25 +157,16 @@ but the minimum number of workers will be guaranteed.

    -
    - -
    mainWorker: Worker
    -

    Reference to main worker.

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

    Options for the worker.

    +
  • Defined in src/worker/abstract-worker.ts:94
  • statistics: WorkerStatistics
    @@ -181,16 +175,16 @@ but the minimum number of workers will be guaranteed.

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

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

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

    @@ -204,13 +198,13 @@ but the minimum number of workers will be guaranteed.

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

      - +
    • Adds a task function to the worker. If a task function with the same name already exists, it is replaced.

      @@ -224,22 +218,16 @@ If a task function with the same name already exists, it is replaced.

    • -
      fn: WorkerFunction<Data, Response>
      +
      fn: TaskFunction<Data, Response>

      The task function to add.

    -

    Returns boolean

    Whether the task function was added or not.

    - -
    -

    Throws

    https://nodejs.org/api/errors.html#class-typeerror If the name parameter is not a string.

    +

    Returns TaskFunctionOperationResult

    Whether the task function was added or not.

    -

    Throws

    https://nodejs.org/api/errors.html#class-error If the name parameter is the default task function reserved name.

    - -

    Throws

    https://nodejs.org/api/errors.html#class-typeerror If the fn parameter is not a function.

    -
      @@ -250,7 +238,7 @@ If a task function with the same name already exists, it is replaced.

    +
  • Defined in node_modules/.pnpm/@types+node@20.8.6/node_modules/@types/node/async_hooks.d.ts:315
    • @@ -277,7 +265,7 @@ If a task function with the same name already exists, it is replaced.

    +
  • Defined in node_modules/.pnpm/@types+node@20.8.6/node_modules/@types/node/async_hooks.d.ts:288
  • +
  • Defined in node_modules/.pnpm/@types+node@20.8.6/node_modules/@types/node/async_hooks.d.ts:311
  • Returns Worker

    Reference to the main worker.

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

    Returns boolean

    Whether the worker has a task function with the given name or not.

    +

    Returns TaskFunctionOperationResult

    Whether the worker has a task function with the given name or not.

    -
    -

    Throws

    https://nodejs.org/api/errors.html#class-typeerror If the name parameter is not a string.

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

    Returns boolean

    Whether the task function existed and was removed or not.

    - -
    -

    Throws

    https://nodejs.org/api/errors.html#class-typeerror If the name parameter is not a string.

    - -

    Throws

    https://nodejs.org/api/errors.html#class-error If the name parameter is the default task function reserved name.

    +

    Returns TaskFunctionOperationResult

    Whether the task function existed and was removed or not.

    -

    Throws

    https://nodejs.org/api/errors.html#class-error If the name parameter is the task function used as default task function.

    -
    +
  • Defined in src/worker/abstract-worker.ts:214
  • 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:494
  • +
  • Defined in src/worker/abstract-worker.ts:555
  • +
  • Defined in node_modules/.pnpm/@types+node@20.8.6/node_modules/@types/node/async_hooks.d.ts:299
  • +
  • Defined in src/worker/abstract-worker.ts:521
  • +
    + +
    +
  • Defined in src/worker/cluster-worker.ts:68
  • -

    Returns boolean

    Whether the default task function was set or not.

    - -
    -

    Throws

    https://nodejs.org/api/errors.html#class-typeerror If the name parameter is not a string.

    +

    Returns TaskFunctionOperationResult

    Whether the default task function was set or not.

    -

    Throws

    https://nodejs.org/api/errors.html#class-error If the name parameter is the default task function reserved name.

    - -

    Throws

    https://nodejs.org/api/errors.html#class-error If the name parameter is a non-existing task function.

    -
    +
  • Defined in src/worker/abstract-worker.ts:270
  • -
    - -
    +
  • Defined in node_modules/.pnpm/@types+node@20.8.6/node_modules/@types/node/async_hooks.d.ts:319
  • +
  • Defined in node_modules/.pnpm/@types+node@20.8.6/node_modules/@types/node/async_hooks.d.ts:278
  • +
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    +
    \ No newline at end of file