X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FClusterWorker.html;h=a45936cecf4b6a3c56513993deb914286f34ecbe;hb=665702eef3ad8153279b344e0276687f7f50c10f;hp=b6d8cb5acad59756a7e71ab5d714255e88757832;hpb=b9da9d7e74c720f83482a09d1b883fc83d04f4ed;p=poolifier.git diff --git a/docs/classes/ClusterWorker.html b/docs/classes/ClusterWorker.html index b6d8cb5a..a45936ce 100644 --- a/docs/classes/ClusterWorker.html +++ b/docs/classes/ClusterWorker.html @@ -1,13 +1,13 @@ -ClusterWorker | poolifier - v2.6.37
+ClusterWorker | poolifier - v2.6.42
-
+
  • The search index is not available
    • poolifier - v2.6.42 +
    @@ -47,19 +47,19 @@ but the minimum number of workers will be guaranteed.

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

    Constructors

    -
    constructor +
    constructor

    Properties

    -
    activeInterval? +
    activeInterval? isMain lastTaskTimestamp opts @@ -68,11 +68,11 @@ but the minimum number of workers will be guaranteed.

    Accessors

    -
    id +
    id

    Methods

    -
    addTaskFunction +
    addTaskFunction asyncId bind emitDestroy @@ -97,7 +97,7 @@ but the minimum number of workers will be guaranteed.

    Constructors

    -

    constructor

    +

    constructor

    • @@ -116,16 +116,18 @@ but the minimum number of workers will be guaranteed.

    • 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 ClusterWorker<Data, Response>

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

    • Properties

    @@ -136,7 +138,7 @@ but the minimum number of workers will be guaranteed.

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

    • Protected Readonly isMain

    isMain: boolean
    @@ -145,7 +147,7 @@ but the minimum number of workers will be guaranteed.

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

    • Protected lastTaskTimestamp

    lastTaskTimestamp: number
    @@ -154,7 +156,7 @@ but the minimum number of workers will be guaranteed.

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

    • Protected opts

    opts: WorkerOptions = DEFAULT_WORKER_OPTIONS
    @@ -163,7 +165,7 @@ but the minimum number of workers will be guaranteed.

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

    • Protected statistics

    statistics: WorkerStatistics
    @@ -172,7 +174,7 @@ but the minimum number of workers will be guaranteed.

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

    • Protected taskFunctions

    taskFunctions: Map<string, TaskFunction<Data, Response>>
    @@ -181,7 +183,7 @@ but the minimum number of workers will be guaranteed.

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

    • Accessors

    @@ -195,7 +197,7 @@ but the minimum number of workers will be guaranteed.

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

    • Methods

    @@ -212,11 +214,13 @@ If a task function with the same name already exists, it is replaced.

  • name: string

    The name of the task function to add.

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

    The task function to add.

    -
    • + +

    Returns boolean

    Whether the task function was added or not.

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

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

    • asyncId

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

    • bind

    + +

    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

    • emitDestroy

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

    • Protected getMainWorker

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

    • Protected handleError

    + +

    Returns string

    The error message.

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

    • Protected handleKillMessage

    + +

    Returns void

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

    • Protected handleReadyMessage

    + +

    Returns void

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

    • hasTaskFunction

    + +

    Returns boolean

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

    @@ -374,7 +385,7 @@ never be called.

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

    • listTaskFunctions

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

    • Protected messageListener

    + +

    Returns void

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

    • removeTaskFunction

    + +

    Returns boolean

    Whether the task function existed and was removed or not.

    @@ -432,7 +445,7 @@ never be called.

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

    • Protected run

    + +

    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

    • Protected runAsync

    + +

    Returns void

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

    • runInAsyncScope

  • Optional thisArg: This

    The receiver to be used for the function call.

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

    Optional arguments to pass to the function.

    -
    Rest
    • + +

    Returns Result

    Since

    v9.6.0

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

    • Protected runSync

    + +

    Returns void

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

    • Protected sendTaskFunctionsListToMainWorker

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

    • Protected sendToMainWorker

    + +

    Returns void

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

    • setDefaultTaskFunction

    + +

    Returns boolean

    Whether the default task function was set or not.

    @@ -608,7 +631,7 @@ then restore the original execution context.

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

    • triggerAsyncId

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

    • Static bind

    +
    Optional thisArg: ThisArg

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

    Settings

     +

    Settings

    Member Visibility

      -
      • -
      • -
      • -
    +
    • +
    • +
    • +

    • Theme

    @@ -703,71 +728,30 @@ then restore the original execution context.

  • triggerAsyncId
  • bind
    • -
    +

    Generated using TypeDoc

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