X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=60e3c607794b436d8df80a4558cc8b5d41771dd4;hb=1b27b0580ef80da95449c262682015a6da19e226;hp=de299a1ed8daae3e780aedeaff4e484a83dbd7c0;hpb=2de80350c43436f87fca7de401d213c0d93fe208;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index de299a1e..60e3c607 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -1,4 +1,4 @@ -AbstractPool | poolifier - v2.6.45
+AbstractPool | poolifier - v3.0.5
  • Preparing search index...
  • -
  • The search index is not available
poolifier - v2.6.45
+
  • The search index is not available
  • poolifier - v3.0.5
    @@ -87,7 +88,8 @@

    Methods

    -
    addWorkerNode +
    addTaskFunction +addWorkerNode afterTaskExecutionHook afterWorkerNodeSetup beforeTaskExecutionHook @@ -95,44 +97,52 @@ checkAndEmitDynamicWorkerCreationEvents checkAndEmitTaskExecutionEvents checkAndEmitTaskQueuingEvents -checkDynamicPoolSize -checkFilePath checkMessageWorkerId checkNumberOfWorkers checkPoolOptions -checkValidTasksQueueOptions -checkValidWorkerChoiceStrategy checkValidWorkerChoiceStrategyOptions chooseWorkerNode createAndSetupDynamicWorkerNode createAndSetupWorkerNode 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 -listTaskFunctions +listTaskFunctionNames redistributeQueuedTasks +registerOnceWorkerMessageListener registerWorkerMessageListener +removeTaskFunction removeWorkerNode sendKillMessageToWorker sendStartupMessageToWorker sendStatisticsMessageToWorker +sendTaskFunctionOperationToWorker +sendTaskFunctionOperationToWorkers sendToWorker +setDefaultTaskFunction setTaskStealing setTasksQueueOptions setTasksQueueSize @@ -144,9 +154,7 @@ shallExecuteTask shallUpdateTaskFunctionWorkerUsage start -taskStealingOnEmptyQueue tasksQueueSize -tasksStealingOnBackPressure unsetTaskStealing unsetTasksStealingOnBackPressure updateEluWorkerUsage @@ -154,7 +162,7 @@ updateTaskStatisticsWorkerUsage updateTaskStolenStatisticsWorkerUsage updateWaitTimeWorkerUsage -workerListener +workerMessageListener

    Constructors

    @@ -195,13 +203,14 @@

    Returns AbstractPool<Worker, Data, Response>

    +
  • Defined in src/pools/abstract-pool.ts:128
  • 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.
    • @@ -216,7 +225,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:75
  • filePath: string
    @@ -224,7 +233,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:130
  • max?: number
    @@ -232,7 +241,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:80
  • numberOfWorkers: number
    @@ -240,7 +249,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:129
  • opts: PoolOptions<Worker>
    @@ -248,7 +257,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:131
  • promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
    @@ -261,7 +270,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:89
  • startTimestamp: number
    @@ -269,7 +278,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:119
  • started: boolean
    @@ -277,7 +286,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:111
  • starting: boolean
    @@ -285,7 +294,19 @@
    +
  • Defined in src/pools/abstract-pool.ts:115
  • +
    + +
    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>
    @@ -293,7 +314,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:95
  • workerNodes: IWorkerNode<Worker, Data>[] = []
    @@ -302,7 +323,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:72
  • Accessors

    @@ -316,7 +337,7 @@

    Returns boolean

    +
  • Defined in src/pools/abstract-pool.ts:669
  • +
  • Defined in src/pools/abstract-pool.ts:660
  • +
  • Defined in src/pools/abstract-pool.ts:273
  • +
  • Defined in src/pools/abstract-pool.ts:486
  • +
  • Defined in src/pools/abstract-pool.ts:479
  • +
  • Defined in src/pools/abstract-pool.ts:431
  • +
  • Defined in src/pools/abstract-pool.ts:469
  • +
  • Defined in src/pools/abstract-pool.ts:448
  • +
  • Defined in src/pools/abstract-pool.ts:474
  • Methods

    +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:1619
  • +
  • Defined in src/pools/abstract-pool.ts:1043
  • +
  • Defined in src/pools/abstract-pool.ts:1356
  • +
  • Defined in src/pools/abstract-pool.ts:1013
  • Returns TasksQueueOptions

    +
  • Defined in src/pools/abstract-pool.ts:599
  • +
  • Defined in src/pools/abstract-pool.ts:1594
  • +
  • Defined in src/pools/abstract-pool.ts:1582
  • -
    - -
    -
    - -
    +
  • Defined in src/pools/abstract-pool.ts:1588
  • +
  • Defined in src/pools/abstract-pool.ts:496
  • Returns void

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

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

    +
  • Defined in src/pools/abstract-pool.ts:219
  • +
  • Defined in src/pools/abstract-pool.ts:1170
  • +
  • Defined in src/pools/abstract-pool.ts:1260
  • +
  • Defined in src/pools/abstract-pool.ts:1216
  • +
  • Defined in src/pools/abstract-pool.ts:1209
  • +
    + +

    Returns undefined | Task<Data>

    +
  • Defined in src/pools/abstract-pool.ts:1688
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:949
  • +
  • Defined in src/pools/abstract-pool.ts:989
  • +
  • Defined in src/pools/abstract-pool.ts:564
  • Returns number

    +
  • Defined in src/pools/abstract-pool.ts:1682
  • +
  • Defined in src/pools/abstract-pool.ts:879
  • +
  • Defined in src/pools/abstract-pool.ts:1676
  • +
    + +

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1696
  • +
  • Defined in src/pools/abstract-pool.ts:1706
  • +
  • Defined in src/pools/abstract-pool.ts:1608
  • +
  • Defined in src/pools/abstract-pool.ts:512
  • +
  • Defined in src/pools/abstract-pool.ts:524
  • +
    + +
    +
    + +

    Returns void

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

    +
  • Defined in src/pools/abstract-pool.ts:1534
  • +
  • Defined in src/pools/abstract-pool.ts:1661
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:1654
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:676
  • -
    - +
  • Defined in src/pools/abstract-pool.ts:1004
  • +
    +
    +
  • Defined in src/pools/abstract-pool.ts:844
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1406
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:1317
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:1641
  • Returns Promise<void>

    +
  • Defined in src/pools/abstract-pool.ts:960
  • +
  • Defined in src/pools/abstract-pool.ts:1387
  • +
  • Defined in src/pools/abstract-pool.ts:1394
  • +
    + +
    +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:1198
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:619
  • +
  • Defined in src/pools/abstract-pool.ts:578
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:613
  • +
  • Defined in src/pools/abstract-pool.ts:637
  • +
  • Defined in src/pools/abstract-pool.ts:531
  • +
  • Defined in src/pools/abstract-pool.ts:550
  • +
  • Defined in src/pools/abstract-pool.ts:997
  • +
  • Defined in src/pools/abstract-pool.ts:1187
  • Returns boolean

    +
  • Defined in src/pools/abstract-pool.ts:870
  • +
  • Defined in src/pools/abstract-pool.ts:1076
  • -
    - -
    +
  • Defined in src/pools/abstract-pool.ts:933
  • Returns number

    -
    - -
    +
  • Defined in src/pools/abstract-pool.ts:1692
  • +
  • Defined in src/pools/abstract-pool.ts:628
  • +
  • Defined in src/pools/abstract-pool.ts:646
  • Returns void

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

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

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

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

    -
    - +
  • Defined in src/pools/abstract-pool.ts:1117
  • +
    +
    +
  • Defined in src/pools/abstract-pool.ts:1518
  • @@ -1517,6 +1707,7 @@ Can be overridden.

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

  • type
  • utilization
  • worker
  • +
  • addTaskFunction
  • addWorkerNode
  • afterTaskExecutionHook
  • afterWorkerNodeSetup
  • @@ -1536,44 +1728,52 @@ Can be overridden.

  • checkAndEmitDynamicWorkerCreationEvents
  • checkAndEmitTaskExecutionEvents
  • checkAndEmitTaskQueuingEvents
  • -
  • checkDynamicPoolSize
  • -
  • checkFilePath
  • checkMessageWorkerId
  • checkNumberOfWorkers
  • checkPoolOptions
  • -
  • checkValidTasksQueueOptions
  • -
  • checkValidWorkerChoiceStrategy
  • checkValidWorkerChoiceStrategyOptions
  • chooseWorkerNode
  • createAndSetupDynamicWorkerNode
  • createAndSetupWorkerNode
  • 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
  • -
  • listTaskFunctions
  • +
  • listTaskFunctionNames
  • redistributeQueuedTasks
  • +
  • registerOnceWorkerMessageListener
  • registerWorkerMessageListener
  • +
  • removeTaskFunction
  • removeWorkerNode
  • sendKillMessageToWorker
  • sendStartupMessageToWorker
  • sendStatisticsMessageToWorker
  • +
  • sendTaskFunctionOperationToWorker
  • +
  • sendTaskFunctionOperationToWorkers
  • sendToWorker
  • +
  • setDefaultTaskFunction
  • setTaskStealing
  • setTasksQueueOptions
  • setTasksQueueSize
  • @@ -1585,9 +1785,7 @@ Can be overridden.

  • shallExecuteTask
  • shallUpdateTaskFunctionWorkerUsage
  • start
  • -
  • taskStealingOnEmptyQueue
  • tasksQueueSize
  • -
  • tasksStealingOnBackPressure
  • unsetTaskStealing
  • unsetTasksStealingOnBackPressure
  • updateEluWorkerUsage
  • @@ -1595,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