X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=60e3c607794b436d8df80a4558cc8b5d41771dd4;hb=1b27b0580ef80da95449c262682015a6da19e226;hp=4b469d03a7ae33122becb18eed01d6440d4797da;hpb=fc09c6dc8cec5398209e3cd8e192b851603e6311;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index 4b469d03..60e3c607 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -1,4 +1,4 @@ -AbstractPool | poolifier - v3.0.2
+AbstractPool | poolifier - v3.0.5
  • Preparing search index...
    • -
  • The search index is not available
poolifier - v3.0.2
+
  • The search index is not available
    • poolifier - v3.0.5
    @@ -49,7 +49,7 @@
    • IPool<Worker, Data, Response>
    +
  • Defined in src/pools/abstract-pool.ts:66
    • @@ -203,7 +203,7 @@

    Returns AbstractPool<Worker, Data, Response>

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

    • Properties

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

    • Protected Readonly filePath

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

    • Protected Optional Readonly max

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

    • Protected Readonly numberOfWorkers

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

    • Protected Readonly opts

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

    • Protected promiseResponseMap

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

    • Private Readonly startTimestamp

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

    • Private started

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

    • Private starting

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

    • Private Readonly taskFunctions

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

    • Protected workerChoiceStrategyContext

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

    • Readonly Internal workerNodes

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

    • Accessors

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

    Returns boolean

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

    • Protected full

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

    • info

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

    • Protected maxSize

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

    • Protected minSize

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

    • Private ready

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

    • Protected Abstract type

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

      Returns "fixed" | "dynamic"

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

    • Private utilization

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

    • Protected Abstract worker

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

      Returns "thread" | "cluster"

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

    • Methods

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

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

    • Private addWorkerNode

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

    • Protected afterTaskExecutionHook

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

    • Protected afterWorkerNodeSetup

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

    • Protected beforeTaskExecutionHook

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

    • Private buildTasksQueueOptions

    Returns TasksQueueOptions

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

    • Private checkAndEmitDynamicWorkerCreationEvents

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

    • Private checkAndEmitTaskExecutionEvents

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

    • Private checkAndEmitTaskQueuingEvents

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

    • Private checkMessageWorkerId

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

    • Private checkNumberOfWorkers

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

      numberOfWorkers: number

    Returns void

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

    • Private checkPoolOptions

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

      opts: PoolOptions<Worker>

    Returns void

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

    • Private checkValidWorkerChoiceStrategyOptions

    Returns void

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

    • Private chooseWorkerNode

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

    • Protected createAndSetupDynamicWorkerNode

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

    • Protected createAndSetupWorkerNode

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

    • Protected Abstract createWorker

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

    • Private deleteTaskFunctionWorkerUsages

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

      name: string

    Returns void

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

    • Private dequeueTask

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

      workerNodeKey: number

    Returns undefined | Task<Data>

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

    • Protected Abstract deregisterWorkerMessageListener

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

    • destroy

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

    • Protected Abstract destroyWorkerNode

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

    • enableTasksQueue

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

    • Private enqueueTask

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

      task: Task<Data>

    Returns number

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

    • execute

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

    • Private executeTask

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

    • Protected flagWorkerNodeAsNotReady

      @@ -905,7 +905,7 @@ Can be overridden.

      workerNodeKey: number

    Returns void

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

    • Protected flushTasksQueue

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

      workerNodeKey: number

    Returns void

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

    • Private flushTasksQueues

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

    • Protected getWorkerInfo

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

    • Private getWorkerNodeKeyByWorker

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

    • Private getWorkerNodeKeyByWorkerId

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

    • Private Readonly handleBackPressureEvent

      @@ -996,10 +996,10 @@ Can be overridden.

      Parameters

      • -
        event: CustomEvent<WorkerNodeEventDetail>
      +
      event: CustomEvent<WorkerNodeEventDetail>

    Returns void

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

    • Private Readonly handleEmptyQueueEvent

      @@ -1009,10 +1009,10 @@ Can be overridden.

      Parameters

      • -
        event: CustomEvent<WorkerNodeEventDetail>
      +
      event: CustomEvent<WorkerNodeEventDetail>

    Returns void

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

    • Private handleTaskExecutionResponse

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

      message: MessageValue<Response, unknown>

    Returns void

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

    • Private handleWorkerReadyResponse

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

      message: MessageValue<Response, unknown>

    Returns void

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

    • Private hasBackPressure

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

    • hasTaskFunction

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

    • hasWorkerNodeBackPressure

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

    • Private initializeEventEmitter

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

    • Protected internalBusy

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

    • Protected Abstract isMain

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

    • listTaskFunctionNames

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

    • Private redistributeQueuedTasks

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

      workerNodeKey: number

    Returns void

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

    • Protected Abstract registerOnceWorkerMessageListener

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

    • Protected Abstract registerWorkerMessageListener

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

    • removeTaskFunction

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

    • Private removeWorkerNode

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

    • Protected sendKillMessageToWorker

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

      workerNodeKey: number

    Returns Promise<void>

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

    • Protected Abstract sendStartupMessageToWorker

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

    • Private sendStatisticsMessageToWorker

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

    • Private sendTaskFunctionOperationToWorker

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

      message: MessageValue<Data, unknown>

    Returns Promise<boolean>

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

    • Private sendTaskFunctionOperationToWorkers

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

      message: MessageValue<Data, unknown>

    Returns Promise<boolean>

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

    • Protected Abstract sendToWorker

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

    • setDefaultTaskFunction

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

    • Private setTaskStealing

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

    • setTasksQueueOptions

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

    • Private setTasksQueueSize

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

      size: number

    Returns void

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

    • Private setTasksStealingOnBackPressure

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Protected setupHook

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

    • Private shallCreateDynamicWorker

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

    • Private shallExecuteTask

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

      workerNodeKey: number

    Returns boolean

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

    • Private shallUpdateTaskFunctionWorkerUsage

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

    • start

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

    • Private tasksQueueSize

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

      workerNodeKey: number

    Returns number

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

    • Private unsetTaskStealing

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

    • Private unsetTasksStealingOnBackPressure

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

    • Private updateEluWorkerUsage

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

      message: MessageValue<Response, unknown>

    Returns void

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

    • Private updateRunTimeWorkerUsage

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

      message: MessageValue<Response, unknown>

    Returns void

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

    • Private updateTaskStatisticsWorkerUsage

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

      message: MessageValue<Response, unknown>

    Returns void

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

    • Private updateTaskStolenStatisticsWorkerUsage

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

      taskName: string

    Returns void

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

    • Private updateWaitTimeWorkerUsage

      @@ -1661,7 +1661,7 @@ Can be overridden.

      task: Task<Data>

    Returns void

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

    • Protected workerMessageListener

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

  • updateWaitTimeWorkerUsage
  • workerMessageListener
    • -