X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedClusterPool.html;h=dff66fdd08f442f39ad5e998942b04b4375a0253;hb=9d96ba4ea0e2e4b06216657cb1641551b59f58ee;hp=98f5c30d4c20f78c2b940cc01118016592505737;hpb=447eca603b96bc46303dfa16f3048b68ae576b0c;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index 98f5c30d..dff66fdd 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -1,4 +1,4 @@ -FixedClusterPool | poolifier - v2.7.0
+FixedClusterPool | poolifier - v2.7.4
  • Preparing search index...
    • -
  • The search index is not available
poolifier - v2.7.0
+
  • The search index is not available
    • poolifier - v2.7.4
    @@ -45,7 +45,7 @@ +
  • Defined in src/pools/cluster/fixed.ts:33
    • @@ -84,10 +84,10 @@ afterTaskExecutionHook afterWorkerNodeSetup beforeTaskExecutionHook -checkDynamicPoolSize createAndSetupDynamicWorkerNode createAndSetupWorkerNode createWorker +deregisterWorkerMessageListener destroy destroyWorkerNode enableTasksQueue @@ -99,6 +99,7 @@ internalBusy isMain listTaskFunctionNames +registerOnceWorkerMessageListener registerWorkerMessageListener removeTaskFunction sendKillMessageToWorker @@ -150,13 +151,14 @@
    +
  • Defined in src/pools/cluster/fixed.ts:44

    • Properties

    -

    Optional Readonly emitter

    -
    emitter?: PoolEmitter
    -

    Emitter on which events can be listened to.

    +

    Optional emitter

    +
    emitter?: __module | EventEmitterAsyncResource
    +

    Event emitter integrated with async resource on which events can be listened to. +The async tracking tooling identifier is poolifier:<PoolType>-<WorkerType>-pool.

    Events that can currently be listened to:

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

    • Protected Readonly filePath

    filePath: string
    @@ -180,7 +182,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:128

    • Protected Optional Readonly max

    max?: number
    @@ -189,7 +191,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:97

    • Protected Readonly numberOfWorkers

    numberOfWorkers: number
    @@ -198,7 +200,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:127

    • Protected Readonly opts

    opts: ClusterPoolOptions = {}
    @@ -207,7 +209,7 @@
    +
  • Defined in src/pools/cluster/fixed.ts:47

    • Protected promiseResponseMap

    promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
    @@ -221,7 +223,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:82

    • Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -230,7 +232,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:88

    • Readonly Internal workerNodes

    workerNodes: IWorkerNode<Worker, Data>[] = []
    @@ -239,7 +241,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:70

    • Accessors

    @@ -254,7 +256,7 @@
    +
  • Defined in src/pools/cluster/fixed.ts:139

    • Protected full

    +
  • Defined in src/pools/abstract-pool.ts:651

    • info

    +
  • Defined in src/pools/abstract-pool.ts:271

    • Protected maxSize

    +
  • Defined in src/pools/abstract-pool.ts:484

    • Protected minSize

    +
  • Defined in src/pools/abstract-pool.ts:477

    • Private ready

    +
  • Defined in src/pools/abstract-pool.ts:429

    • Protected type

    +
  • Defined in src/pools/cluster/fixed.ts:129

    • Private utilization

    +
  • Defined in src/pools/abstract-pool.ts:446

    • Protected worker

    +
  • Defined in src/pools/cluster/fixed.ts:134

    • Methods

    @@ -386,7 +388,7 @@ If a task function with the same name already exists, it will be overwritten.

    +
  • Defined in src/pools/abstract-pool.ts:796

    • Protected afterTaskExecutionHook

    +
  • Defined in src/pools/abstract-pool.ts:1035

    • Protected afterWorkerNodeSetup

    +
  • Defined in src/pools/abstract-pool.ts:1346

    • Protected beforeTaskExecutionHook

    -
    -

    Protected checkDynamicPoolSize

    -
    +
  • Defined in src/pools/abstract-pool.ts:1005

    • Protected createAndSetupDynamicWorkerNode

    +
  • Defined in src/pools/abstract-pool.ts:1252

    • Protected createAndSetupWorkerNode

    +
  • Defined in src/pools/abstract-pool.ts:1208

    • Protected createWorker

    +
  • Defined in src/pools/cluster/fixed.ts:124
    • +
    +

    Protected deregisterWorkerMessageListener

    +
      + +
    • +

      Deregisters a listener callback on the worker given its worker node key.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        Message

      +
      +

      Parameters

      +
        +
      • +
        workerNodeKey: number
        +

        The worker node key.

        +
        +
        • +
      • +
        listener: ((message) => void)
        +

        The message listener callback.

        +
        +
        +
          +
        • +
            +
          • (message): void
            • +
          • +
            +

            Parameters

            +
            +

            Returns void

      +

      Returns void

      +

    destroy

    +
  • Defined in src/pools/abstract-pool.ts:940

    • Protected destroyWorkerNode

    +
  • Defined in src/pools/cluster/fixed.ts:63

    • enableTasksQueue

    +
  • Defined in src/pools/abstract-pool.ts:565

    • execute

    +
  • Defined in src/pools/abstract-pool.ts:870

    • Protected flushTasksQueue

    +
  • Defined in src/pools/abstract-pool.ts:1669

    • Protected getWorkerInfo

    +
  • Defined in src/pools/abstract-pool.ts:1585

    • hasTaskFunction

    +
  • Defined in src/pools/abstract-pool.ts:783

    • hasWorkerNodeBackPressure

    +
  • Defined in src/pools/abstract-pool.ts:1627

    • Protected internalBusy

    +
  • Defined in src/pools/abstract-pool.ts:667

    • Protected isMain

    +
  • Defined in src/pools/cluster/fixed.ts:58

    • listTaskFunctionNames

    +
  • Defined in src/pools/abstract-pool.ts:835
    • +
    +

    Protected registerOnceWorkerMessageListener

    +
      + +
    • +

      Registers once a listener callback on the worker given its worker node key.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        Message

      +
      +

      Parameters

      +
        +
      • +
        workerNodeKey: number
        +

        The worker node key.

        +
        +
        • +
      • +
        listener: ((message) => void)
        +

        The message listener callback.

        +
        +
        +
          +
        • +
            +
          • (message): void
            • +
          • +
            +

            Parameters

            +
            +

            Returns void

      +

      Returns void

      +

    Protected registerWorkerMessageListener

    +
  • Defined in src/pools/cluster/fixed.ts:100

    • removeTaskFunction

    +
  • Defined in src/pools/abstract-pool.ts:819

    • Protected sendKillMessageToWorker

    +
  • Defined in src/pools/abstract-pool.ts:953

    • Protected sendStartupMessageToWorker

    +
  • Defined in src/pools/cluster/fixed.ts:93

    • Protected sendToWorker

    +
  • Defined in src/pools/cluster/fixed.ts:82

    • setDefaultTaskFunction

    +
  • Defined in src/pools/abstract-pool.ts:848

    • setTasksQueueOptions

    +
  • Defined in src/pools/abstract-pool.ts:579

    • setWorkerChoiceStrategy

    +
  • Defined in src/pools/abstract-pool.ts:532

    • setWorkerChoiceStrategyOptions

    +
  • Defined in src/pools/abstract-pool.ts:551

    • Protected setupHook

    +
  • Defined in src/pools/cluster/fixed.ts:53

    • start

    +
  • Defined in src/pools/abstract-pool.ts:924

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:1497
    • @@ -1019,10 +1087,10 @@ Can be overridden.

  • afterTaskExecutionHook
  • afterWorkerNodeSetup
  • beforeTaskExecutionHook
    • -
  • checkDynamicPoolSize
  • createAndSetupDynamicWorkerNode
  • createAndSetupWorkerNode
  • createWorker
    • +
  • deregisterWorkerMessageListener
  • destroy
  • destroyWorkerNode
  • enableTasksQueue
    • @@ -1034,6 +1102,7 @@ Can be overridden.

  • internalBusy
  • isMain
  • listTaskFunctionNames
    • +
  • registerOnceWorkerMessageListener
  • registerWorkerMessageListener
  • removeTaskFunction
  • sendKillMessageToWorker
    • @@ -1047,7 +1116,7 @@ Can be overridden.

  • start
  • workerListener
    • -

    Generated using TypeDoc