X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=4f501d6f503d1bdab4b5ab50ca3e7d2d989f409e;hb=db9af90629dcc65a13984858d0b4d8e1618f524c;hp=13d1951e8eaac2067433f45d10fb1b694d24a741;hpb=aab0aa502b6d1ca1e2b480460d9cf5f34707c34c;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index 13d1951e..4f501d6f 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -1,4 +1,4 @@ -AbstractPool | poolifier - v2.7.4
+AbstractPool | poolifier - v3.0.4
  • Preparing search index...
    • -
  • The search index is not available
poolifier - v2.7.4
+
  • 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
    • @@ -114,11 +114,14 @@ enqueueTask execute executeTask +flagWorkerNodeAsNotReady flushTasksQueue flushTasksQueues getWorkerInfo getWorkerNodeKeyByWorker getWorkerNodeKeyByWorkerId +handleBackPressureEvent +handleEmptyQueueEvent handleTaskExecutionResponse handleWorkerReadyResponse hasBackPressure @@ -151,9 +154,7 @@ shallExecuteTask shallUpdateTaskFunctionWorkerUsage start -taskStealingOnEmptyQueue tasksQueueSize -tasksStealingOnBackPressure unsetTaskStealing unsetTasksStealingOnBackPressure updateEluWorkerUsage @@ -161,7 +162,7 @@ updateTaskStatisticsWorkerUsage updateTaskStolenStatisticsWorkerUsage updateWaitTimeWorkerUsage -workerListener +workerMessageListener

    Constructors

    @@ -202,12 +203,12 @@

    Returns AbstractPool<Worker, Data, Response>

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

    • Properties

    Optional emitter

    -
    emitter?: __module | EventEmitterAsyncResource
    +
    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:

    @@ -224,7 +225,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:74

    • Protected Readonly filePath

    filePath: string
    @@ -232,7 +233,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:129

    • Protected Optional Readonly max

    max?: number
    @@ -240,7 +241,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:79

    • Protected Readonly numberOfWorkers

    numberOfWorkers: number
    @@ -248,7 +249,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:128

    • Protected Readonly opts

    opts: PoolOptions<Worker>
    @@ -256,7 +257,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:130

    • Protected promiseResponseMap

    promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
    @@ -269,7 +270,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:88

    • Private Readonly startTimestamp

    startTimestamp: number
    @@ -277,7 +278,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:118

    • Private started

    started: boolean
    @@ -285,7 +286,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:110

    • Private starting

    starting: boolean
    @@ -293,7 +294,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:114

    • Private Readonly taskFunctions

    taskFunctions: Map<string, TaskFunction<Data, Response>>
    @@ -305,7 +306,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:105

    • Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -313,7 +314,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:94

    • Readonly Internal workerNodes

    workerNodes: IWorkerNode<Worker, Data>[] = []
    @@ -322,7 +323,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:71

    • Accessors

    @@ -336,7 +337,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo

    Returns boolean

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

    • Protected full

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

    • info

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

    • Protected maxSize

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

    • Protected minSize

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

    • Private ready

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

    • Protected Abstract type

      @@ -405,7 +406,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo

      Returns "fixed" | "dynamic"

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

    • Private utilization

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

    • Protected Abstract worker

      @@ -428,7 +429,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo

      Returns "thread" | "cluster"

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

    • Private addWorkerNode

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

    • Protected afterTaskExecutionHook

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

    • Protected afterWorkerNodeSetup

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

    • Protected beforeTaskExecutionHook

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

    • Private buildTasksQueueOptions

    Returns TasksQueueOptions

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

    • Private checkAndEmitDynamicWorkerCreationEvents

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

    • Private checkAndEmitTaskExecutionEvents

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

    • Private checkAndEmitTaskQueuingEvents

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

    • Private checkMessageWorkerId

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

    • Private checkNumberOfWorkers

      @@ -624,7 +625,7 @@ Can be overridden.

      numberOfWorkers: number

    Returns void

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

    • Private checkPoolOptions

      @@ -637,7 +638,7 @@ Can be overridden.

      opts: PoolOptions<Worker>

    Returns void

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

    • Private checkValidWorkerChoiceStrategyOptions

    Returns void

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

    • Private chooseWorkerNode

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

    • Protected createAndSetupDynamicWorkerNode

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

    • Protected createAndSetupWorkerNode

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

    • Protected Abstract createWorker

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

    • Private deleteTaskFunctionWorkerUsages

      @@ -712,7 +713,7 @@ Can be overridden.

      name: string

    Returns void

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

    • Private dequeueTask

      @@ -725,7 +726,7 @@ Can be overridden.

      workerNodeKey: number

    Returns undefined | Task<Data>

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

    • Protected Abstract deregisterWorkerMessageListener

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

    • destroy

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

    • Protected Abstract destroyWorkerNode

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

    • enableTasksQueue

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

    • Private enqueueTask

      @@ -836,7 +837,7 @@ Can be overridden.

      task: Task<Data>

    Returns number

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

    • execute

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

    • Private executeTask

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

    Protected flagWorkerNodeAsNotReady

    +

    Protected flushTasksQueue

      @@ -904,7 +918,7 @@ Can be overridden.

      workerNodeKey: number

    Returns void

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

    • Private flushTasksQueues

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

    • Protected getWorkerInfo

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

    • Private getWorkerNodeKeyByWorker

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

    • Private getWorkerNodeKeyByWorkerId

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

    Private Readonly handleBackPressureEvent

    +
    +
    +

    Private Readonly handleEmptyQueueEvent

    +

    Private handleTaskExecutionResponse

      @@ -985,7 +1025,7 @@ Can be overridden.

      message: MessageValue<Response, unknown>

    Returns void

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

    • Private handleWorkerReadyResponse

      @@ -998,7 +1038,7 @@ Can be overridden.

      message: MessageValue<Response, unknown>

    Returns void

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

    • Private hasBackPressure

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

    • hasTaskFunction

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

    • hasWorkerNodeBackPressure

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

    • Private initializeEventEmitter

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

    • Protected internalBusy

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

    • Protected Abstract isMain

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

    • listTaskFunctionNames

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

    • Private redistributeQueuedTasks

      @@ -1105,7 +1145,7 @@ Can be overridden.

      workerNodeKey: number

    Returns void

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

    • Protected Abstract registerOnceWorkerMessageListener

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

    • Protected Abstract registerWorkerMessageListener

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

    • removeTaskFunction

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

    • Private removeWorkerNode

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

    • Protected sendKillMessageToWorker

      @@ -1238,7 +1278,7 @@ Can be overridden.

      workerNodeKey: number

    Returns Promise<void>

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

    • Protected Abstract sendStartupMessageToWorker

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

    • Private sendStatisticsMessageToWorker

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

    • Private sendTaskFunctionOperationToWorker

      @@ -1291,7 +1331,7 @@ Can be overridden.

      message: MessageValue<Data, unknown>

    Returns Promise<boolean>

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

    • Private sendTaskFunctionOperationToWorkers

      @@ -1304,7 +1344,7 @@ Can be overridden.

      message: MessageValue<Data, unknown>

    Returns Promise<boolean>

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

    • Protected Abstract sendToWorker

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

    • setDefaultTaskFunction

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

    • Private setTaskStealing

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

    • setTasksQueueOptions

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

    • Private setTasksQueueSize

      @@ -1395,7 +1435,7 @@ Can be overridden.

      size: number

    Returns void

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

    • Private setTasksStealingOnBackPressure

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Protected setupHook

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

    • Private shallCreateDynamicWorker

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

    • Private shallExecuteTask

      @@ -1485,7 +1525,7 @@ Can be overridden.

      workerNodeKey: number

    Returns boolean

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

    • Private shallUpdateTaskFunctionWorkerUsage

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

    • start

    -
    -

    Private taskStealingOnEmptyQueue

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

    • Private tasksQueueSize

      @@ -1543,20 +1570,7 @@ Can be overridden.

      workerNodeKey: number

    Returns number

    -
    -

    Private tasksStealingOnBackPressure

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

    • Private unsetTaskStealing

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

    • Private unsetTasksStealingOnBackPressure

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

    • Private updateEluWorkerUsage

      @@ -1587,7 +1601,7 @@ Can be overridden.

      message: MessageValue<Response, unknown>

    Returns void

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

    • Private updateRunTimeWorkerUsage

      @@ -1602,7 +1616,7 @@ Can be overridden.

      message: MessageValue<Response, unknown>

    Returns void

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

    • Private updateTaskStatisticsWorkerUsage

      @@ -1617,7 +1631,7 @@ Can be overridden.

      message: MessageValue<Response, unknown>

    Returns void

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

    • Private updateTaskStolenStatisticsWorkerUsage

      @@ -1632,7 +1646,7 @@ Can be overridden.

      taskName: string

    Returns void

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

    • Private updateWaitTimeWorkerUsage

      @@ -1647,34 +1661,23 @@ Can be overridden.

      task: Task<Data>

    Returns void

    -
    -

    Protected workerListener

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

    Protected workerMessageListener

      - -
    • -

      This method is the listener registered for each worker message.

      -
      -

      Returns ((message) => void)

      The listener function to execute when a message is received from a worker.

      - -
        -
      • -
          -
        • (message): void
          • +
        • -

          This method is the listener registered for each worker message.

          +

          This method is the message listener registered on each worker.

          Parameters

          -

          Returns void

          The listener function to execute when a message is received from a worker.

          - -
      +

      Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1516
    • @@ -1684,10 +1687,10 @@ Can be overridden.

    Member Visibility

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

    • Theme

    @@ -1742,11 +1745,14 @@ Can be overridden.

  • enqueueTask
  • execute
  • executeTask
    • +
  • flagWorkerNodeAsNotReady
  • flushTasksQueue
  • flushTasksQueues
  • getWorkerInfo
  • getWorkerNodeKeyByWorker
  • getWorkerNodeKeyByWorkerId
    • +
  • handleBackPressureEvent
    • +
  • handleEmptyQueueEvent
  • handleTaskExecutionResponse
  • handleWorkerReadyResponse
  • hasBackPressure
    • @@ -1779,9 +1785,7 @@ Can be overridden.

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