X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedClusterPool.html;h=4ff1d599a9573eee9d3ba0857aa9ac6251e1f41e;hb=b29abb6fcd1592fdf3cafac282dfdae6800f6a10;hp=04b8ec5a340d4637163f81f0653fecbf17a874cd;hpb=48c6ba05d56af984567ff531fde69cb6d9f9a0fb;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index 04b8ec5a..4ff1d599 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -1,4 +1,4 @@ -FixedClusterPool | poolifier - v2.7.3
+FixedClusterPool | poolifier - v3.0.2
  • Preparing search index...
    • -
  • The search index is not available
poolifier - v2.7.3
+
  • The search index is not available
    • poolifier - v3.0.2
    @@ -45,7 +45,7 @@ +
  • Defined in src/pools/cluster/fixed.ts:33
    • @@ -92,6 +92,7 @@ destroyWorkerNode enableTasksQueue execute +flagWorkerNodeAsNotReady flushTasksQueue getWorkerInfo hasTaskFunction @@ -111,7 +112,7 @@ setWorkerChoiceStrategyOptions setupHook start -workerListener +workerMessageListener

    Constructors

    @@ -151,12 +152,12 @@
    +
  • Defined in src/pools/cluster/fixed.ts:44

    • Properties

    Optional emitter

    -
    emitter?: __module | EventEmitterAsyncResource
    +
    emitter?: 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:

    @@ -173,7 +174,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:74

    • Protected Readonly filePath

    filePath: string
    @@ -182,7 +183,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:129

    • Protected Optional Readonly max

    max?: number
    @@ -191,7 +192,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:79

    • Protected Readonly numberOfWorkers

    numberOfWorkers: number
    @@ -200,7 +201,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:128

    • Protected Readonly opts

    opts: ClusterPoolOptions = {}
    @@ -209,7 +210,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/cluster/fixed.ts:47

    • Protected promiseResponseMap

    promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
    @@ -223,7 +224,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:88

    • Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -232,7 +233,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:94

    • Readonly Internal workerNodes

    workerNodes: IWorkerNode<Worker, Data>[] = []
    @@ -241,7 +242,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:71

    • Accessors

    @@ -256,7 +257,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/cluster/fixed.ts:140

    • Protected full

      @@ -269,7 +270,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:662

    • info

      @@ -281,7 +282,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:272

    • Protected maxSize

      @@ -293,7 +294,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:485

    • Protected minSize

      @@ -305,7 +306,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:478

    • Private ready

      @@ -317,7 +318,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:430

    • Protected type

      @@ -330,7 +331,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/cluster/fixed.ts:130

    • Private utilization

      @@ -343,7 +344,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:447

    • Protected worker

      @@ -355,7 +356,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/cluster/fixed.ts:135

    • Methods

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

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

    • Protected afterTaskExecutionHook

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

    • Protected afterWorkerNodeSetup

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

    • Protected beforeTaskExecutionHook

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

    • Protected createAndSetupDynamicWorkerNode

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

    • Protected createAndSetupWorkerNode

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

    • Protected createWorker

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

    • Protected deregisterWorkerMessageListener

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

    • destroy

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

    • Protected destroyWorkerNode

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

    • enableTasksQueue

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

    • execute

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

    Protected flagWorkerNodeAsNotReady

    +

    Protected flushTasksQueue

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

    • Protected getWorkerInfo

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

    • hasTaskFunction

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

    • hasWorkerNodeBackPressure

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

    • Protected internalBusy

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

    • Protected isMain

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

    • listTaskFunctionNames

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

    • Protected registerOnceWorkerMessageListener

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

    • Protected registerWorkerMessageListener

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

    • removeTaskFunction

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

    • Protected sendKillMessageToWorker

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

    • Protected sendStartupMessageToWorker

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

    • Protected sendToWorker

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

    • setDefaultTaskFunction

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

    • setTasksQueueOptions

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Protected setupHook

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

    • start

    -
    -

    Protected workerListener

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

    Protected workerMessageListener

      - +
    • -

      This method is the listener registered for each worker message.

      -
      -

      Returns ((message) => void)

      The listener function to execute when a message is received from a worker.

      - -
        -
      • -
          -
        • (message): void
          • -
        • -

          This method is the listener registered for each worker message.

          +

          This method is the message listener registered on each worker.

          Parameters

          -

          Returns void

          The listener function to execute when a message is received from a worker.

          - -
      +

      Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1519
    • @@ -1055,10 +1059,10 @@ Can be overridden.

    Member Visibility

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

    • Theme

    @@ -1095,6 +1099,7 @@ Can be overridden.

  • destroyWorkerNode
  • enableTasksQueue
  • execute
    • +
  • flagWorkerNodeAsNotReady
  • flushTasksQueue
  • getWorkerInfo
  • hasTaskFunction
    • @@ -1114,9 +1119,9 @@ Can be overridden.

  • setWorkerChoiceStrategyOptions
  • setupHook
  • start
    • -
  • workerListener
    • +
  • workerMessageListener
    • -

    Generated using TypeDoc

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