X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=072c9da05dae4cb0411cc9c601675033feef32ac;hb=dd7f9381792ec728f9cd87ef7a0df6b2893db77e;hp=e306ebe9c5021637043ffb8fb5f345c46cc09b4e;hpb=c4d8442aed5e5a9d6cde9f3bfd721be3033c1eef;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index e306ebe9..072c9da0 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -1,4 +1,4 @@ -AbstractPool | poolifier - v2.6.44
+AbstractPool | poolifier - v3.0.1
  • Preparing search index...
  • -
  • The search index is not available
poolifier - v2.6.44
+
  • The search index is not available
  • poolifier - v3.0.1
    @@ -87,7 +88,8 @@

    Methods

    -
    addWorkerNode +
    addTaskFunction +addWorkerNode afterTaskExecutionHook afterWorkerNodeSetup beforeTaskExecutionHook @@ -95,19 +97,17 @@ checkAndEmitDynamicWorkerCreationEvents checkAndEmitTaskExecutionEvents checkAndEmitTaskQueuingEvents -checkDynamicPoolSize -checkFilePath checkMessageWorkerId checkNumberOfWorkers checkPoolOptions -checkValidTasksQueueOptions -checkValidWorkerChoiceStrategy checkValidWorkerChoiceStrategyOptions chooseWorkerNode createAndSetupDynamicWorkerNode createAndSetupWorkerNode createWorker +deleteTaskFunctionWorkerUsages dequeueTask +deregisterWorkerMessageListener destroy destroyWorkerNode enableTasksQueue @@ -119,38 +119,49 @@ getWorkerInfo getWorkerNodeKeyByWorker getWorkerNodeKeyByWorkerId +handleBackPressureEvent +handleEmptyQueueEvent handleTaskExecutionResponse handleWorkerReadyResponse hasBackPressure +hasTaskFunction hasWorkerNodeBackPressure +initializeEventEmitter 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 -taskStealingOnEmptyQueue +start tasksQueueSize -tasksStealingOnBackPressure +unsetTaskStealing +unsetTasksStealingOnBackPressure updateEluWorkerUsage updateRunTimeWorkerUsage updateTaskStatisticsWorkerUsage updateTaskStolenStatisticsWorkerUsage updateWaitTimeWorkerUsage -workerListener +workerMessageListener

    Constructors

    @@ -191,13 +202,14 @@

    Returns AbstractPool<Worker, Data, Response>

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

    - -
    emitter?: PoolEmitter
    -

    Emitter on which events can be listened to.

    + +
    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:

    • 'ready': Emitted when the number of workers created in the pool has reached the minimum size expected and are ready.
    • @@ -212,7 +224,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:74
  • filePath: string
    @@ -220,7 +232,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:129
  • max?: number
    @@ -228,7 +240,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:79
  • numberOfWorkers: number
    @@ -236,7 +248,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:128
  • opts: PoolOptions<Worker>
    @@ -244,11 +256,11 @@
    +
  • Defined in src/pools/abstract-pool.ts:130
  • 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.
    • @@ -257,7 +269,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:88
  • startTimestamp: number
    @@ -265,7 +277,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:118
  • started: boolean
    @@ -273,15 +285,27 @@
    +
  • Defined in src/pools/abstract-pool.ts:110
  • - +
    starting: boolean

    Whether the pool is starting or not.

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

    The task functions added at runtime map:

    +
      +
    • key: The task function name.
    • +
    • value: The task function itself.
    • +
    +
    +
    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -289,7 +313,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:94
  • workerNodes: IWorkerNode<Worker, Data>[] = []
    @@ -298,7 +322,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:71
  • Accessors

    @@ -312,7 +336,7 @@

    Returns boolean

    +
  • Defined in src/pools/abstract-pool.ts:671
  • +
  • Defined in src/pools/abstract-pool.ts:662
  • +
  • Defined in src/pools/abstract-pool.ts:272
  • +
  • Defined in src/pools/abstract-pool.ts:485
  • +
  • Defined in src/pools/abstract-pool.ts:478
  • +
  • Defined in src/pools/abstract-pool.ts:430
  • +
  • Defined in src/pools/abstract-pool.ts:468
  • +
  • Defined in src/pools/abstract-pool.ts:447
  • +
  • Defined in src/pools/abstract-pool.ts:473
  • Methods

    +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:1614
  • +
  • Defined in src/pools/abstract-pool.ts:1044
  • +
  • Defined in src/pools/abstract-pool.ts:1355
  • +
  • Defined in src/pools/abstract-pool.ts:1014
  • Returns TasksQueueOptions

    +
  • Defined in src/pools/abstract-pool.ts:601
  • +
  • Defined in src/pools/abstract-pool.ts:1589
  • +
  • Defined in src/pools/abstract-pool.ts:1577
  • -
    - -
    -
    - -
    +
  • Defined in src/pools/abstract-pool.ts:1583
  • +
  • Defined in src/pools/abstract-pool.ts:495
  • Returns void

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

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

    +
  • Defined in src/pools/abstract-pool.ts:218
  • +
  • Defined in src/pools/abstract-pool.ts:1171
  • +
  • Defined in src/pools/abstract-pool.ts:1261
  • +
  • Defined in src/pools/abstract-pool.ts:1217
  • +
  • Defined in src/pools/abstract-pool.ts:1210
  • +
    + +

    Returns undefined | Task<Data>

    +
  • Defined in src/pools/abstract-pool.ts:1679
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:951
  • +
  • Defined in src/pools/abstract-pool.ts:990
  • +
  • Defined in src/pools/abstract-pool.ts:566
  • Returns number

    +
  • Defined in src/pools/abstract-pool.ts:1673
  • +
  • Defined in src/pools/abstract-pool.ts:881
  • +
  • Defined in src/pools/abstract-pool.ts:1667
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1687
  • +
  • Defined in src/pools/abstract-pool.ts:1697
  • +
  • Defined in src/pools/abstract-pool.ts:1603
  • +
  • Defined in src/pools/abstract-pool.ts:514
  • +
  • Defined in src/pools/abstract-pool.ts:526
  • +
    + +
    +
    + +

    Returns void

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

    +
  • Defined in src/pools/abstract-pool.ts:1533
  • +
  • Defined in src/pools/abstract-pool.ts:1652
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:1645
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:678
  • -
    - +
  • Defined in src/pools/abstract-pool.ts:1005
  • +
    +
    +
  • Defined in src/pools/abstract-pool.ts:846
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1405
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:1316
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:1636
  • Returns Promise<void>

    +
  • Defined in src/pools/abstract-pool.ts:962
  • +
  • Defined in src/pools/abstract-pool.ts:1386
  • +
  • Defined in src/pools/abstract-pool.ts:1393
  • +
    + +
    +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:1199
  • +
    + +
    +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:580
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:615
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:533
  • +
  • Defined in src/pools/abstract-pool.ts:552
  • +
  • Defined in src/pools/abstract-pool.ts:998
  • +
  • Defined in src/pools/abstract-pool.ts:1188
  • Returns boolean

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

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

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

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

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

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

    -
    - +
  • Defined in src/pools/abstract-pool.ts:1118
  • +
    +
    +
  • Defined in src/pools/abstract-pool.ts:1517
  • @@ -1477,6 +1693,7 @@ Can be overridden.

  • startTimestamp
  • started
  • starting
  • +
  • taskFunctions
  • workerChoiceStrategyContext
  • workerNodes
  • busy
  • @@ -1488,6 +1705,7 @@ Can be overridden.

  • type
  • utilization
  • worker
  • +
  • addTaskFunction
  • addWorkerNode
  • afterTaskExecutionHook
  • afterWorkerNodeSetup
  • @@ -1496,19 +1714,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
  • @@ -1520,40 +1736,51 @@ Can be overridden.

  • getWorkerInfo
  • getWorkerNodeKeyByWorker
  • getWorkerNodeKeyByWorkerId
  • +
  • handleBackPressureEvent
  • +
  • handleEmptyQueueEvent
  • handleTaskExecutionResponse
  • handleWorkerReadyResponse
  • hasBackPressure
  • +
  • hasTaskFunction
  • hasWorkerNodeBackPressure
  • +
  • initializeEventEmitter
  • 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
  • -
  • taskStealingOnEmptyQueue
  • +
  • start
  • tasksQueueSize
  • -
  • tasksStealingOnBackPressure
  • +
  • unsetTaskStealing
  • +
  • unsetTasksStealingOnBackPressure
  • updateEluWorkerUsage
  • updateRunTimeWorkerUsage
  • updateTaskStatisticsWorkerUsage
  • updateTaskStolenStatisticsWorkerUsage
  • updateWaitTimeWorkerUsage
  • -
  • workerListener
  • +
  • workerMessageListener
  • Generated using TypeDoc

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