X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicClusterPool.html;h=11212b2005cb21a76266044a1d3316fcba230c16;hb=f7d15c1217381b306300beb7926b42fde93bc579;hp=5bbe0ff4edc5dc2d845e531f55e0390415945100;hpb=cfeb9528531b00167f2e849c8b96709769159598;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index 5bbe0ff4..11212b20 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -1,13 +1,13 @@ -DynamicClusterPool | poolifier - v2.6.32
+DynamicClusterPool | poolifier - v2.7.0
-
+
  • The search index is not available
    • poolifier - v2.7.0 +
    @@ -45,19 +45,19 @@ When the maximum number of workers is reached and workers are busy, an event is
    • DynamicClusterPool
    +
  • Defined in src/pools/cluster/dynamic.ts:15
    • - +

    Constructors

    -
    constructor +
    constructor

    Properties

    -
    emitter? +
    emitter? filePath max numberOfWorkers @@ -68,7 +68,7 @@ When the maximum number of workers is reached and workers are busy, an event is

    Accessors

    -
    busy +
    busy full info maxSize @@ -80,7 +80,8 @@ When the maximum number of workers is reached and workers are busy, an event is

    Methods

    -
    afterTaskExecutionHook +
    addTaskFunction +afterTaskExecutionHook afterWorkerNodeSetup beforeTaskExecutionHook checkDynamicPoolSize @@ -93,24 +94,28 @@ When the maximum number of workers is reached and workers are busy, an event is execute flushTasksQueue getWorkerInfo +hasTaskFunction hasWorkerNodeBackPressure internalBusy isMain -listTaskFunctions +listTaskFunctionNames registerWorkerMessageListener +removeTaskFunction sendKillMessageToWorker sendStartupMessageToWorker sendToWorker +setDefaultTaskFunction setTasksQueueOptions setWorkerChoiceStrategy setWorkerChoiceStrategyOptions setupHook +start workerListener

    Constructors

    -

    constructor

    +

    constructor

    +
  • Defined in src/pools/cluster/dynamic.ts:27

    • Properties

    @@ -160,9 +165,9 @@ When the maximum number of workers is reached and workers are busy, an event is

    Events that can currently be listened to:

    • 'ready': Emitted when the number of workers created in the pool has reached the minimum size expected and are ready.
      • -
    • 'busy': Emitted when the number of workers created in the pool has reached the maximum size expected and are executing at least one task.
      • +
    • 'busy': Emitted when the number of workers created in the pool has reached the maximum size expected and are executing concurrently their tasks quota.
    • 'full': Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.
      • -
    • 'destroy': Emitted when the pool is destroyed.
      • +
    • 'destroy': Emitted when the pool is destroyed.
    • 'error': Emitted when an uncaught error occurs.
    • 'taskError': Emitted when an error occurs while executing a task.
    • 'backPressure': Emitted when all worker nodes have back pressure (i.e. their tasks queue is full: queue size >= maximum queue size).
      • @@ -171,7 +176,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:69

    • Protected Readonly filePath

    filePath: string
    @@ -180,7 +185,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:124

    • Protected Readonly max

    max: number
    @@ -189,7 +194,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/cluster/dynamic.ts:29

    • Protected Readonly numberOfWorkers

    numberOfWorkers: number
    @@ -198,7 +203,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:123

    • Protected Readonly opts

    opts: ClusterPoolOptions = {}
    @@ -207,11 +212,11 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/cluster/fixed.ts:47

    • Protected promiseResponseMap

    promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
    -

    The task execution response promise map.

    +

    The task execution response promise map:

    • key: The message id of each submitted task.
    • value: An object that contains the worker, the execution response promise resolve and reject callbacks.
      • @@ -221,7 +226,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:78

    • Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -230,7 +235,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:84

    • Readonly Internal workerNodes

    workerNodes: IWorkerNode<Worker, Data>[] = []
    @@ -239,7 +244,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:66

    • Accessors

    @@ -254,7 +259,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/cluster/dynamic.ts:43

    • Protected full

      @@ -267,7 +272,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:732

    • info

      @@ -279,7 +284,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:352

    • Protected maxSize

      @@ -291,7 +296,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:565

    • Protected minSize

      @@ -303,7 +308,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:558

    • Private ready

      @@ -315,7 +320,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:510

    • Protected type

      @@ -328,7 +333,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/cluster/dynamic.ts:38

    • Private utilization

      @@ -341,7 +346,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:527

    • Protected worker

      @@ -353,9 +358,40 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/cluster/fixed.ts:118

    • Methods

    +
    +

    addTaskFunction

    +

    Protected afterTaskExecutionHook

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

    • Protected afterWorkerNodeSetup

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

    • Protected beforeTaskExecutionHook

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

    • Protected checkDynamicPoolSize

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

    • Protected createAndSetupDynamicWorkerNode

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

    • Protected createAndSetupWorkerNode

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

    • Protected createWorker

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

    • destroy

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

    • Protected destroyWorkerNode

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

    • enableTasksQueue

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

    • execute

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

    • Protected flushTasksQueue

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

    • Protected getWorkerInfo

      - +

    • Gets the worker information given its worker node key.

      @@ -601,12 +637,33 @@ Can be overridden.

      The worker node key.

    -

    Returns undefined | WorkerInfo

    The worker information.

    +

    Returns WorkerInfo

    The worker information.

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

    hasTaskFunction

    +
      + +
    • +

      Whether the specified task function exists in this pool.

      +
      +
      +

      Parameters

      +
        +
      • +
        name: string
        +

        The name of the task function.

        +
        +
      +

      Returns boolean

      true if the task function exists, false otherwise.

      + +

    hasWorkerNodeBackPressure

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

    • Protected internalBusy

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

    • Protected isMain

    -
    -

    listTaskFunctions

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

    listTaskFunctionNames

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

    • Protected registerWorkerMessageListener

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

    removeTaskFunction

    +
      + +
    • +

      Removes a task function from this pool.

      +
      +
      +

      Parameters

      +
        +
      • +
        name: string
        +

        The name of the task function.

        +
        +
      +

      Returns Promise<boolean>

      true if the task function was removed, false otherwise.

      + +

    Protected sendKillMessageToWorker

      - +

    • Parameters

      • -
        workerNodeKey: number
        • -
      • -
        workerId: number
      +
      workerNodeKey: number

    Returns Promise<void>

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

    • Protected sendStartupMessageToWorker

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

    • Protected sendToWorker

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

    setDefaultTaskFunction

    +

    setTasksQueueOptions

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Protected setupHook

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

    start

    +

    Protected workerListener

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

    Settings

     +

    Settings

    Member Visibility

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

    • Theme

    @@ -911,6 +1020,7 @@ Can be overridden.

  • type
  • utilization
  • worker
    • +
  • addTaskFunction
  • afterTaskExecutionHook
  • afterWorkerNodeSetup
  • beforeTaskExecutionHook
    • @@ -924,82 +1034,48 @@ Can be overridden.

  • execute
  • flushTasksQueue
  • getWorkerInfo
    • +
  • hasTaskFunction
  • hasWorkerNodeBackPressure
  • internalBusy
  • isMain
    • -
  • listTaskFunctions
    • +
  • listTaskFunctionNames
  • registerWorkerMessageListener
    • +
  • removeTaskFunction
  • sendKillMessageToWorker
  • sendStartupMessageToWorker
  • sendToWorker
    • +
  • setDefaultTaskFunction
  • setTasksQueueOptions
  • setWorkerChoiceStrategy
  • setWorkerChoiceStrategyOptions
  • setupHook
    • +
  • start
  • workerListener
    • -
    +
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    +
    \ No newline at end of file