X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FClusterWorker.html;h=bf8598c189326fdb8ff09df9cb5bb05dd8596f70;hb=b667be1103b9362ae29d094de05f812468464d4f;hp=8dea95ee7683cb407a4b51654609ed78464f414a;hpb=15e4d8f3cafe9f7412913b0e440921e813bdf3cd;p=poolifier.git diff --git a/docs/classes/ClusterWorker.html b/docs/classes/ClusterWorker.html index 8dea95ee..bf8598c1 100644 --- a/docs/classes/ClusterWorker.html +++ b/docs/classes/ClusterWorker.html @@ -1,4 +1,4 @@ -ClusterWorker | poolifier
+ClusterWorker | poolifier - v2.6.8
  • Preparing search index...
  • -
  • The search index is not available
poolifier
+
  • The search index is not available
  • poolifier - v2.6.8
    @@ -21,22 +21,25 @@ it will send a termination request to its main worker.

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

    +
    +
    +

    Author

    Christopher Quadflieg

    -

    Author

    Christopher Quadflieg

    - -

    Since

    2.0.0

    +

    Since

    2.0.0

    -
    +

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

        -
    +

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

    +
    +

    Hierarchy

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

      • ClusterWorker
    +
  • Defined in src/worker/cluster-worker.ts:21
  • @@ -52,44 +55,50 @@ but the minimum number of workers will be guaranteed.

    Constructors

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

      -
      +

      Type Parameters

      -
        +
        • Data = unknown

        • @@ -98,87 +107,122 @@ 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: WorkerFunction<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>

    Properties

    - +
    aliveInterval?: Timeout

    Handler id of the aliveInterval worker alive check.

    -
    +
  • Defined in src/worker/abstract-worker.ts:58
  • - +
    isMain: boolean

    Whether this is the main worker or not.

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

    Timestamp of the last task processed by this worker.

    -
    +
  • Defined in src/worker/abstract-worker.ts:50
  • - -
    mainWorker: undefined | null | Worker
    + +
    mainWorker: Worker

    Reference to main worker.

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

    Options for the worker.

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

    Performance statistics computation requirements.

    +
    +
    +
    + +
    taskFunctions: Map<string, WorkerFunction<Data, Response>>
    +

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

    +
    +
    +
    +

    Accessors

    +
    + +

    Methods

    - +
      - +
    • -
      -

      Returns

      The unique asyncId assigned to the resource.

      -
      -

      Returns number

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

    Returns Func & {
        asyncResource: AsyncResource;
    }

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

    Returns string

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

    Returns void

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

    Returns void

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

    Returns void

    +
  • Defined in src/worker/cluster-worker.ts:52
  • - +
    +
  • Defined in node_modules/.pnpm/@types+node@20.4.0/node_modules/@types/node/async_hooks.d.ts:311
  • - +
    +
  • constructor
  • +
  • aliveInterval
  • +
  • isMain
  • +
  • lastTaskTimestamp
  • +
  • mainWorker
  • +
  • opts
  • +
  • statistics
  • +
  • taskFunctions
  • +
  • id
  • +
  • asyncId
  • +
  • bind
  • +
  • checkAlive
  • +
  • emitDestroy
  • +
  • getMainWorker
  • +
  • handleError
  • +
  • messageListener
  • +
  • runAsync
  • +
  • runInAsyncScope
  • +
  • runSync
  • +
  • sendToMainWorker
  • +
  • triggerAsyncId
  • +
  • bind
  • +
  • AbstractPool
  • +
  • AbstractWorker
  • +
  • CircularArray
  • +
  • ClusterWorker
  • +
  • DynamicClusterPool
  • +
  • DynamicThreadPool
  • +
  • FixedClusterPool
  • +
  • FixedThreadPool
  • +
  • PoolEmitter
  • +
  • Queue
  • +
  • ThreadWorker
  • +
  • WorkerChoiceStrategyContext
  • +
  • ClusterPoolOptions
  • +
  • EventLoopUtilizationMeasurementStatistics
  • +
  • IPool
  • +
  • IWorker
  • +
  • IWorkerChoiceStrategy
  • +
  • MeasurementOptions
  • +
  • MeasurementStatistics
  • +
  • MeasurementStatisticsRequirements
  • +
  • MessageValue
  • +
  • PoolInfo
  • +
  • PoolOptions
  • +
  • PromiseResponseWrapper
  • +
  • StrategyPolicy
  • +
  • Task
  • +
  • TaskError
  • +
  • TaskPerformance
  • +
  • TaskStatistics
  • +
  • TaskStatisticsRequirements
  • +
  • TasksQueueOptions
  • +
  • ThreadPoolOptions
  • +
  • WorkerChoiceStrategyOptions
  • +
  • WorkerInfo
  • +
  • WorkerNode
  • +
  • WorkerOptions
  • +
  • WorkerStatistics
  • +
  • WorkerUsage
  • +
  • ErrorHandler
  • +
  • ExitHandler
  • +
  • KillBehavior
  • +
  • Measurement
  • +
  • MessageHandler
  • +
  • OnlineHandler
  • +
  • PoolEvent
  • +
  • PoolType
  • +
  • TaskFunctions
  • +
  • WorkerAsyncFunction
  • +
  • WorkerChoiceStrategy
  • +
  • WorkerFunction
  • +
  • WorkerSyncFunction
  • +
  • WorkerType
  • +
  • KillBehaviors
  • +
  • Measurements
  • +
  • PoolEvents
  • +
  • PoolTypes
  • +
  • WorkerChoiceStrategies
  • +
  • WorkerTypes
  • +
  • availableParallelism
  • Generated using TypeDoc

    \ No newline at end of file