X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=4f501d6f503d1bdab4b5ab50ca3e7d2d989f409e;hb=db9af90629dcc65a13984858d0b4d8e1618f524c;hp=30969c24eba5305e5ab3a9f7431500638caca2a7;hpb=447eca603b96bc46303dfa16f3048b68ae576b0c;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index 30969c24..4f501d6f 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -1,4 +1,4 @@ -AbstractPool | poolifier - v2.7.0
+AbstractPool | poolifier - v3.0.4
  • Preparing search index...
  • -
  • The search index is not available
poolifier - v2.7.0
+
  • The search index is not available
  • poolifier - v3.0.4
    @@ -49,7 +49,7 @@
    • IPool<Worker, Data, Response>
    +
  • Defined in src/pools/abstract-pool.ts:65
  • @@ -97,13 +97,9 @@ checkAndEmitDynamicWorkerCreationEvents checkAndEmitTaskExecutionEvents checkAndEmitTaskQueuingEvents -checkDynamicPoolSize -checkFilePath checkMessageWorkerId checkNumberOfWorkers checkPoolOptions -checkValidTasksQueueOptions -checkValidWorkerChoiceStrategy checkValidWorkerChoiceStrategyOptions chooseWorkerNode createAndSetupDynamicWorkerNode @@ -111,26 +107,32 @@ createWorker deleteTaskFunctionWorkerUsages dequeueTask +deregisterWorkerMessageListener destroy destroyWorkerNode enableTasksQueue enqueueTask execute executeTask +flagWorkerNodeAsNotReady flushTasksQueue flushTasksQueues getWorkerInfo getWorkerNodeKeyByWorker getWorkerNodeKeyByWorkerId +handleBackPressureEvent +handleEmptyQueueEvent handleTaskExecutionResponse handleWorkerReadyResponse hasBackPressure hasTaskFunction hasWorkerNodeBackPressure +initializeEventEmitter internalBusy isMain listTaskFunctionNames redistributeQueuedTasks +registerOnceWorkerMessageListener registerWorkerMessageListener removeTaskFunction removeWorkerNode @@ -152,9 +154,7 @@ shallExecuteTask shallUpdateTaskFunctionWorkerUsage start -taskStealingOnEmptyQueue tasksQueueSize -tasksStealingOnBackPressure unsetTaskStealing unsetTasksStealingOnBackPressure updateEluWorkerUsage @@ -162,7 +162,7 @@ updateTaskStatisticsWorkerUsage updateTaskStolenStatisticsWorkerUsage updateWaitTimeWorkerUsage -workerListener +workerMessageListener

    Constructors

    @@ -203,13 +203,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.
    • @@ -224,7 +225,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:74
  • filePath: string
    @@ -232,7 +233,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:129
  • max?: number
    @@ -240,7 +241,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:79
  • numberOfWorkers: number
    @@ -248,7 +249,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:128
  • opts: PoolOptions<Worker>
    @@ -256,7 +257,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:130
  • promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
    @@ -269,7 +270,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:88
  • startTimestamp: number
    @@ -277,7 +278,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:118
  • started: boolean
    @@ -285,7 +286,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:110
  • starting: boolean
    @@ -293,7 +294,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:114
  • taskFunctions: Map<string, TaskFunction<Data, Response>>
    @@ -305,7 +306,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:105
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -313,7 +314,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:94
  • workerNodes: IWorkerNode<Worker, Data>[] = []
    @@ -322,7 +323,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:71
  • Accessors

    @@ -336,7 +337,7 @@

    Returns boolean

    +
  • Defined in src/pools/abstract-pool.ts:668
  • +
  • Defined in src/pools/abstract-pool.ts:659
  • +
  • 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

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

    +
  • Defined in src/pools/abstract-pool.ts:804
  • +
  • Defined in src/pools/abstract-pool.ts:1613
  • +
  • Defined in src/pools/abstract-pool.ts:1041
  • +
  • Defined in src/pools/abstract-pool.ts:1354
  • +
  • Defined in src/pools/abstract-pool.ts:1011
  • Returns TasksQueueOptions

    +
  • Defined in src/pools/abstract-pool.ts:598
  • +
  • Defined in src/pools/abstract-pool.ts:1588
  • +
  • Defined in src/pools/abstract-pool.ts:1576
  • -
    - -
    -
    - -
    +
  • Defined in src/pools/abstract-pool.ts:1582
  • +
  • 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:1168
  • +
  • Defined in src/pools/abstract-pool.ts:1258
  • +
  • Defined in src/pools/abstract-pool.ts:1214
  • +
  • Defined in src/pools/abstract-pool.ts:1207
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:863
  • Returns undefined | Task<Data>

    +
  • Defined in src/pools/abstract-pool.ts:1682
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:948
  • +
  • Defined in src/pools/abstract-pool.ts:987
  • +
  • Defined in src/pools/abstract-pool.ts:563
  • Returns number

    +
  • Defined in src/pools/abstract-pool.ts:1676
  • +
  • Defined in src/pools/abstract-pool.ts:878
  • +
  • Defined in src/pools/abstract-pool.ts:1670
  • +
    + +

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1690
  • +
  • Defined in src/pools/abstract-pool.ts:1700
  • +
  • Defined in src/pools/abstract-pool.ts:1602
  • +
  • Defined in src/pools/abstract-pool.ts:511
  • +
  • Defined in src/pools/abstract-pool.ts:523
  • +
    + +
    +
    + +

    Returns void

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

    +
  • Defined in src/pools/abstract-pool.ts:1532
  • +
  • Defined in src/pools/abstract-pool.ts:1655
  • +
  • Defined in src/pools/abstract-pool.ts:791
  • +
  • Defined in src/pools/abstract-pool.ts:1648
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:675
  • +
  • Defined in src/pools/abstract-pool.ts:1002
  • +
  • Defined in src/pools/abstract-pool.ts:843
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1404
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:1315
  • +
  • Defined in src/pools/abstract-pool.ts:827
  • +
  • Defined in src/pools/abstract-pool.ts:1635
  • Returns Promise<void>

    +
  • Defined in src/pools/abstract-pool.ts:959
  • +
  • Defined in src/pools/abstract-pool.ts:1385
  • +
  • Defined in src/pools/abstract-pool.ts:1392
  • Returns Promise<boolean>

    +
  • Defined in src/pools/abstract-pool.ts:694
  • Returns Promise<boolean>

    +
  • Defined in src/pools/abstract-pool.ts:735
  • +
  • Defined in src/pools/abstract-pool.ts:1196
  • +
  • Defined in src/pools/abstract-pool.ts:856
  • +
  • Defined in src/pools/abstract-pool.ts:618
  • +
  • Defined in src/pools/abstract-pool.ts:577
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:612
  • +
  • Defined in src/pools/abstract-pool.ts:636
  • +
  • Defined in src/pools/abstract-pool.ts:530
  • +
  • Defined in src/pools/abstract-pool.ts:549
  • +
  • Defined in src/pools/abstract-pool.ts:995
  • +
  • Defined in src/pools/abstract-pool.ts:1185
  • Returns boolean

    +
  • Defined in src/pools/abstract-pool.ts:869
  • +
  • Defined in src/pools/abstract-pool.ts:1074
  • -
    - -
    +
  • Defined in src/pools/abstract-pool.ts:932
  • Returns number

    -
    - -
    +
  • Defined in src/pools/abstract-pool.ts:1686
  • +
  • Defined in src/pools/abstract-pool.ts:627
  • +
  • Defined in src/pools/abstract-pool.ts:645
  • Returns void

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

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

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

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

    -
    - +
  • Defined in src/pools/abstract-pool.ts:1115
  • +
    +
    +
  • Defined in src/pools/abstract-pool.ts:1516
  • @@ -1691,13 +1728,9 @@ Can be overridden.

  • checkAndEmitDynamicWorkerCreationEvents
  • checkAndEmitTaskExecutionEvents
  • checkAndEmitTaskQueuingEvents
  • -
  • checkDynamicPoolSize
  • -
  • checkFilePath
  • checkMessageWorkerId
  • checkNumberOfWorkers
  • checkPoolOptions
  • -
  • checkValidTasksQueueOptions
  • -
  • checkValidWorkerChoiceStrategy
  • checkValidWorkerChoiceStrategyOptions
  • chooseWorkerNode
  • createAndSetupDynamicWorkerNode
  • @@ -1705,26 +1738,32 @@ Can be overridden.

  • createWorker
  • deleteTaskFunctionWorkerUsages
  • dequeueTask
  • +
  • deregisterWorkerMessageListener
  • destroy
  • destroyWorkerNode
  • enableTasksQueue
  • enqueueTask
  • execute
  • executeTask
  • +
  • flagWorkerNodeAsNotReady
  • flushTasksQueue
  • flushTasksQueues
  • getWorkerInfo
  • getWorkerNodeKeyByWorker
  • getWorkerNodeKeyByWorkerId
  • +
  • handleBackPressureEvent
  • +
  • handleEmptyQueueEvent
  • handleTaskExecutionResponse
  • handleWorkerReadyResponse
  • hasBackPressure
  • hasTaskFunction
  • hasWorkerNodeBackPressure
  • +
  • initializeEventEmitter
  • internalBusy
  • isMain
  • listTaskFunctionNames
  • redistributeQueuedTasks
  • +
  • registerOnceWorkerMessageListener
  • registerWorkerMessageListener
  • removeTaskFunction
  • removeWorkerNode
  • @@ -1746,9 +1785,7 @@ Can be overridden.

  • shallExecuteTask
  • shallUpdateTaskFunctionWorkerUsage
  • start
  • -
  • taskStealingOnEmptyQueue
  • tasksQueueSize
  • -
  • tasksStealingOnBackPressure
  • unsetTaskStealing
  • unsetTasksStealingOnBackPressure
  • updateEluWorkerUsage
  • @@ -1756,9 +1793,9 @@ Can be overridden.

  • updateTaskStatisticsWorkerUsage
  • updateTaskStolenStatisticsWorkerUsage
  • updateWaitTimeWorkerUsage
  • -
  • workerListener
  • +
  • workerMessageListener
  • Generated using TypeDoc

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