X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=905e085b6ed963eb2e2a81ee9ea6fc6774756b6f;hb=5543cb1ca8011b99a67fcd5fd3a7a5c2b1c4a85e;hp=2fe2f7cd195f2bbd6499945eb63d4dad225ffc0c;hpb=a25c335d7e5573a171fc96c445cb6092852b2c4a;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index 2fe2f7cd..905e085b 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -1,13 +1,13 @@ -AbstractPool | poolifier - v2.6.30
+AbstractPool | poolifier - v2.7.1
-
+
  • The search index is not available
  • poolifier - v2.7.1 +
    @@ -49,32 +49,34 @@
    • IPool<Worker, Data, Response>
    +
  • Defined in src/pools/abstract-pool.ts:64
  • - +

    Constructors

    -

    Properties

    -

    Accessors

    -
    busy +
    busy full info maxSize @@ -86,7 +88,8 @@

    Methods

    -
    addWorkerNode +
    addTaskFunction +addWorkerNode afterTaskExecutionHook afterWorkerNodeSetup beforeTaskExecutionHook @@ -94,19 +97,17 @@ checkAndEmitDynamicWorkerCreationEvents checkAndEmitTaskExecutionEvents checkAndEmitTaskQueuingEvents -checkDynamicPoolSize -checkFilePath checkMessageWorkerId checkNumberOfWorkers checkPoolOptions -checkValidTasksQueueOptions -checkValidWorkerChoiceStrategy checkValidWorkerChoiceStrategyOptions chooseWorkerNode createAndSetupDynamicWorkerNode createAndSetupWorkerNode createWorker +deleteTaskFunctionWorkerUsages dequeueTask +deregisterWorkerMessageListener destroy destroyWorkerNode enableTasksQueue @@ -121,35 +122,50 @@ handleTaskExecutionResponse handleWorkerReadyResponse hasBackPressure +hasTaskFunction hasWorkerNodeBackPressure internalBusy isMain -listTaskFunctions +listTaskFunctionNames redistributeQueuedTasks +registerOnceWorkerMessageListener registerWorkerMessageListener +removeTaskFunction removeWorkerNode sendKillMessageToWorker sendStartupMessageToWorker sendStatisticsMessageToWorker +sendTaskFunctionOperationToWorker +sendTaskFunctionOperationToWorkers sendToWorker +setDefaultTaskFunction +setTaskStealing setTasksQueueOptions +setTasksQueueSize +setTasksStealingOnBackPressure setWorkerChoiceStrategy setWorkerChoiceStrategyOptions setupHook shallCreateDynamicWorker +shallExecuteTask shallUpdateTaskFunctionWorkerUsage -startPool +start +taskStealingOnEmptyQueue tasksQueueSize +tasksStealingOnBackPressure +unsetTaskStealing +unsetTasksStealingOnBackPressure updateEluWorkerUsage updateRunTimeWorkerUsage updateTaskStatisticsWorkerUsage +updateTaskStolenStatisticsWorkerUsage updateWaitTimeWorkerUsage workerListener

    Constructors

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

    @@ -195,18 +211,18 @@

    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 >= pool maximum size^2).
    • +
    • 'backPressure': Emitted when all worker nodes have back pressure (i.e. their tasks queue is full: queue size >= maximum queue size).
    +
  • Defined in src/pools/abstract-pool.ts:73
  • filePath: string
    @@ -214,7 +230,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:128
  • max?: number
    @@ -222,7 +238,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:97
  • numberOfWorkers: number
    @@ -230,7 +246,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:127
  • opts: PoolOptions<Worker>
    @@ -238,11 +254,11 @@
    +
  • Defined in src/pools/abstract-pool.ts:129
  • 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.
    • @@ -251,7 +267,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:82
  • startTimestamp: number
    @@ -259,15 +275,35 @@
    +
  • Defined in src/pools/abstract-pool.ts:117
  • +
    + +
    started: boolean
    +

    Whether the pool is started or not.

    +
    +
    - +
    starting: boolean

    Whether the pool is starting or not.

    +
  • Defined in src/pools/abstract-pool.ts:113
  • +
    + +
    taskFunctions: Map<string, TaskFunction<Data, Response>>
    +

    The task functions added at runtime map:

    + +
    +
    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -275,7 +311,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:88
  • workerNodes: IWorkerNode<Worker, Data>[] = []
    @@ -284,7 +320,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:70
  • Accessors

    @@ -298,7 +334,7 @@

    Returns boolean

    +
  • Defined in src/pools/abstract-pool.ts:654
  • +
  • Defined in src/pools/abstract-pool.ts:645
  • +
  • Defined in src/pools/abstract-pool.ts:265
  • +
  • Defined in src/pools/abstract-pool.ts:478
  • +
  • Defined in src/pools/abstract-pool.ts:471
  • +
  • Defined in src/pools/abstract-pool.ts:423
  • +
  • Defined in src/pools/abstract-pool.ts:461
  • +
  • Defined in src/pools/abstract-pool.ts:440
  • +
  • Defined in src/pools/abstract-pool.ts:466
  • Methods

    +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:1587
  • +
  • Defined in src/pools/abstract-pool.ts:1026
  • +
  • Defined in src/pools/abstract-pool.ts:1337
  • +
  • Defined in src/pools/abstract-pool.ts:996
  • Returns TasksQueueOptions

    +
  • Defined in src/pools/abstract-pool.ts:594
  • +
  • Defined in src/pools/abstract-pool.ts:1562
  • +
  • Defined in src/pools/abstract-pool.ts:1550
  • -
    - -
    -
    - -
    +
  • Defined in src/pools/abstract-pool.ts:1556
  • +
  • Defined in src/pools/abstract-pool.ts:488
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:170
  • Returns void

    -
    - -
    -
    - -
    +
  • Defined in src/pools/abstract-pool.ts:188
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:217
  • +
  • Defined in src/pools/abstract-pool.ts:1153
  • +
  • Defined in src/pools/abstract-pool.ts:1243
  • +
  • Defined in src/pools/abstract-pool.ts:1199
  • +
  • Defined in src/pools/abstract-pool.ts:1192
  • +
    + +

    Returns undefined | Task<Data>

    +
  • Defined in src/pools/abstract-pool.ts:1652
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:934
  • +
  • Defined in src/pools/abstract-pool.ts:972
  • +
  • Defined in src/pools/abstract-pool.ts:559
  • Returns number

    +
  • Defined in src/pools/abstract-pool.ts:1646
  • +
  • Defined in src/pools/abstract-pool.ts:864
  • +
  • Defined in src/pools/abstract-pool.ts:1640
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1660
  • +
  • Defined in src/pools/abstract-pool.ts:1670
  • +
  • Defined in src/pools/abstract-pool.ts:1576
  • +
  • Defined in src/pools/abstract-pool.ts:507
  • +
  • Defined in src/pools/abstract-pool.ts:519
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1522
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1506
  • +
  • Defined in src/pools/abstract-pool.ts:1625
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:1618
  • +
  • Defined in src/pools/abstract-pool.ts:661
  • -
    - +
  • Defined in src/pools/abstract-pool.ts:987
  • +
    +
    +
  • Defined in src/pools/abstract-pool.ts:829
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1380
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:1298
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:1609
  • Returns Promise<void>

    +
  • Defined in src/pools/abstract-pool.ts:944
  • +
  • Defined in src/pools/abstract-pool.ts:1361
  • +
  • Defined in src/pools/abstract-pool.ts:1368
  • +
    + +
    +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:1181
  • +
    + +
    +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:573
  • +
    + +
    +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:526
  • +
  • Defined in src/pools/abstract-pool.ts:545
  • +
  • Defined in src/pools/abstract-pool.ts:980
  • +
  • Defined in src/pools/abstract-pool.ts:1170
  • +
    + +
    -
    - +
  • Defined in src/pools/abstract-pool.ts:1059
  • +
    + +
    +
    +
    +
  • Defined in src/pools/abstract-pool.ts:1420
  • Returns number

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

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1113
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1086
  • Returns void

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

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1100
  • +
  • Defined in src/pools/abstract-pool.ts:1488
  • @@ -1394,7 +1692,9 @@ Can be overridden.

  • opts
  • promiseResponseMap
  • startTimestamp
  • +
  • started
  • starting
  • +
  • taskFunctions
  • workerChoiceStrategyContext
  • workerNodes
  • busy
  • @@ -1406,6 +1706,7 @@ Can be overridden.

  • type
  • utilization
  • worker
  • +
  • addTaskFunction
  • addWorkerNode
  • afterTaskExecutionHook
  • afterWorkerNodeSetup
  • @@ -1414,19 +1715,17 @@ Can be overridden.

  • checkAndEmitDynamicWorkerCreationEvents
  • checkAndEmitTaskExecutionEvents
  • checkAndEmitTaskQueuingEvents
  • -
  • checkDynamicPoolSize
  • -
  • checkFilePath
  • checkMessageWorkerId
  • checkNumberOfWorkers
  • checkPoolOptions
  • -
  • checkValidTasksQueueOptions
  • -
  • checkValidWorkerChoiceStrategy
  • checkValidWorkerChoiceStrategyOptions
  • chooseWorkerNode
  • createAndSetupDynamicWorkerNode
  • createAndSetupWorkerNode
  • createWorker
  • +
  • deleteTaskFunctionWorkerUsages
  • dequeueTask
  • +
  • deregisterWorkerMessageListener
  • destroy
  • destroyWorkerNode
  • enableTasksQueue
  • @@ -1441,93 +1740,70 @@ Can be overridden.

  • handleTaskExecutionResponse
  • handleWorkerReadyResponse
  • hasBackPressure
  • +
  • hasTaskFunction
  • hasWorkerNodeBackPressure
  • internalBusy
  • isMain
  • -
  • listTaskFunctions
  • +
  • listTaskFunctionNames
  • redistributeQueuedTasks
  • +
  • registerOnceWorkerMessageListener
  • registerWorkerMessageListener
  • +
  • removeTaskFunction
  • removeWorkerNode
  • sendKillMessageToWorker
  • sendStartupMessageToWorker
  • sendStatisticsMessageToWorker
  • +
  • sendTaskFunctionOperationToWorker
  • +
  • sendTaskFunctionOperationToWorkers
  • sendToWorker
  • +
  • setDefaultTaskFunction
  • +
  • setTaskStealing
  • setTasksQueueOptions
  • +
  • setTasksQueueSize
  • +
  • setTasksStealingOnBackPressure
  • setWorkerChoiceStrategy
  • setWorkerChoiceStrategyOptions
  • setupHook
  • shallCreateDynamicWorker
  • +
  • shallExecuteTask
  • shallUpdateTaskFunctionWorkerUsage
  • -
  • startPool
  • +
  • start
  • +
  • taskStealingOnEmptyQueue
  • tasksQueueSize
  • +
  • tasksStealingOnBackPressure
  • +
  • unsetTaskStealing
  • +
  • unsetTasksStealingOnBackPressure
  • updateEluWorkerUsage
  • updateRunTimeWorkerUsage
  • updateTaskStatisticsWorkerUsage
  • +
  • updateTaskStolenStatisticsWorkerUsage
  • updateWaitTimeWorkerUsage
  • workerListener
  • +
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    +
    \ No newline at end of file