X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FClusterWorker.html;h=11bba61fe4a6849f41c2451c8a00dd8edfb9bb71;hb=800480935c90f3847c389dd5dbfca11760e78675;hp=ab870f4e63bd8ab832109f02998828c7e3a3ed6e;hpb=00471704103b2a235432b950ddc5aec84a613e07;p=poolifier.git diff --git a/docs/classes/ClusterWorker.html b/docs/classes/ClusterWorker.html index ab870f4e..11bba61f 100644 --- a/docs/classes/ClusterWorker.html +++ b/docs/classes/ClusterWorker.html @@ -1,13 +1,13 @@ -ClusterWorker | poolifier - v2.6.30
+ClusterWorker | poolifier - v3.0.1
-
+
  • The search index is not available
    • poolifier - v3.0.1 +
    @@ -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 @@ -80,15 +80,16 @@ but the minimum number of workers will be guaranteed.

    handleError handleKillMessage handleReadyMessage +handleTaskFunctionOperationMessage hasTaskFunction -listTaskFunctions +listTaskFunctionNames messageListener removeTaskFunction run runAsync runInAsyncScope runSync -sendTaskFunctionsListToMainWorker +sendTaskFunctionNamesToMainWorker sendToMainWorker setDefaultTaskFunction triggerAsyncId @@ -97,7 +98,7 @@ but the minimum number of workers will be guaranteed.

    Constructors

    -

    constructor

    +

    constructor

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

    • Properties

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

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

    • Protected Readonly isMain

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

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

    • Protected lastTaskTimestamp

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

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

    • Protected opts

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

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

    • Protected statistics

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

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

    • Protected taskFunctions

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

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

    • Accessors

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

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

    • Methods

    addTaskFunction

      - +

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

      @@ -221,18 +222,12 @@ If a task function with the same name already exists, it is replaced.

      The task function to add.

    -

    Returns boolean

    Whether the task function was added or not.

    +

    Returns TaskFunctionOperationResult

    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 or an empty string.

    - -

    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.

    -

    asyncId

      @@ -243,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

    • bind

      @@ -270,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

    • emitDestroy

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

    • Protected getMainWorker

    Returns Worker

    Reference to the main worker.

    -

    Protected handleError

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

    • Protected handleKillMessage

    Returns void

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

    • Protected handleReadyMessage

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

    Protected handleTaskFunctionOperationMessage

    +

    hasTaskFunction

    -

    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 or an empty string.

    -
    -
    -

    listTaskFunctions

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

    listTaskFunctionNames

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

    • Protected messageListener

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

    • removeTaskFunction

    -

    Returns boolean

    Whether the task function existed and was removed or not.

    +

    Returns TaskFunctionOperationResult

    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 or an empty string.

    - -

    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 the task function used as default task function.

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

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

    • Protected runAsync

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

    • runInAsyncScope

    +
  • Defined in node_modules/.pnpm/@types+node@20.8.6/node_modules/@types/node/async_hooks.d.ts:299

    • Protected runSync

    -
    -

    Protected sendTaskFunctionsListToMainWorker

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

    Protected sendTaskFunctionNamesToMainWorker

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

    • Protected sendToMainWorker

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

    • setDefaultTaskFunction

    -

    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 or an empty 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 default task function was set or not.

    -

    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

    • triggerAsyncId

    +
  • Defined in node_modules/.pnpm/@types+node@20.8.6/node_modules/@types/node/async_hooks.d.ts:319

    • Static bind

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

    Settings

     +

    Settings

    Member Visibility

    @@ -712,82 +704,45 @@ then restore the original execution context.

  • handleError
  • handleKillMessage
  • handleReadyMessage
    • +
  • handleTaskFunctionOperationMessage
  • hasTaskFunction
    • -
  • listTaskFunctions
    • +
  • listTaskFunctionNames
  • messageListener
  • removeTaskFunction
  • run
  • runAsync
  • runInAsyncScope
  • runSync
    • -
  • sendTaskFunctionsListToMainWorker
    • +
  • sendTaskFunctionNamesToMainWorker
  • sendToMainWorker
  • setDefaultTaskFunction
  • triggerAsyncId
  • bind
    • -
    +
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    +
    \ No newline at end of file