X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=dd00795b10401f16601b371247deeb36ccabdda3;hb=369d0a5139123c2b62260d5793b36097479b23a2;hp=c6bf43baf88ac70a2be1d8227bf86ad1f2d9a5f8;hpb=c4dfd49dbde2f3af0adc4a33d582b1c653f859b5;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index c6bf43ba..dd00795b 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -1,4 +1,4 @@ -AbstractPool | poolifier
+AbstractPool | poolifier - v2.6.8
  • Preparing search index...
    • -
  • The search index is not available
poolifier
+
  • The search index is not available
    • poolifier - v2.6.8
    @@ -49,7 +49,7 @@
    • IPool<Worker, Data, Response>
    +
  • Defined in src/pools/abstract-pool.ts:51
    • @@ -66,6 +66,7 @@ numberOfWorkers opts promiseResponseMap +startTimestamp workerChoiceStrategyContext workerNodes
    @@ -77,6 +78,7 @@ maxSize minSize type +utilization worker
    @@ -105,11 +107,18 @@ executeTask flushTasksQueue flushTasksQueues +getInitialWorkerInfo +getInitialWorkerUsage +getWorkerById +getWorkerId +getWorkerInfo getWorkerNodeKey -getWorkerUsage +handleTaskExecutionResponse +handleWorkerStartedMessage internalBusy isMain pushWorkerNode +redistributeQueuedTasks registerWorkerMessageListener removeWorkerNode sendToWorker @@ -167,7 +176,7 @@

    Returns AbstractPool<Worker, Data, Response>

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

    • Properties

    @@ -185,7 +194,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:60

    • Protected Readonly filePath

    filePath: string
    @@ -193,7 +202,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:98

    • Protected Readonly numberOfWorkers

    numberOfWorkers: number
    @@ -201,7 +210,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:97

    • Protected Readonly opts

    opts: PoolOptions<Worker>
    @@ -209,7 +218,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:99

    • Protected promiseResponseMap

    promiseResponseMap: Map<string, PromiseResponseWrapper<Worker, Response>> = ...
    @@ -222,7 +231,15 @@
    +
  • Defined in src/pools/abstract-pool.ts:70
    • +
    +

    Private Readonly startTimestamp

    +
    startTimestamp: number
    +

    The start timestamp of the pool.

    +
    +

    Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -230,7 +247,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:78

    • Readonly workerNodes

    workerNodes: WorkerNode<Worker, Data>[] = []
    @@ -239,7 +256,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:57

    • Accessors

    @@ -253,7 +270,7 @@

    Returns boolean

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

    • Protected full

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

    • info

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

    • Protected Abstract maxSize

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

    • Protected Abstract minSize

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

    • Protected Abstract type

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

    Private utilization

    +

    Protected Abstract worker

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

    • Methods

    @@ -349,7 +378,7 @@ Can be overridden.

    Returns void

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

    • Protected afterWorkerSetup

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

    • Protected beforeTaskExecutionHook

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

    • Private buildTasksQueueOptions

    Returns TasksQueueOptions

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

    • Private checkAndEmitEvents

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

    • Private checkFilePath

    Returns void

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

    • Private checkNumberOfWorkers

    Returns void

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

    • Private checkPoolOptions

    Returns void

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

    • Private checkValidTasksQueueOptions

    Returns void

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

    • Private checkValidWorkerChoiceStrategy

    Returns void

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

    • Private checkValidWorkerChoiceStrategyOptions

    Returns void

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

    • Private chooseWorkerNode

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

    • Protected createAndSetupDynamicWorker

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

    • Protected createAndSetupWorker

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

    • Protected Abstract createWorker

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

    • Private dequeueTask

    Returns undefined | Task<Data>

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

    • destroy

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

    • Protected Abstract destroyWorker

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

    • enableTasksQueue

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

    • Private enqueueTask

    Returns number

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

    • execute

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

    • Private executeTask

    Returns void

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

    • Private flushTasksQueue

    Returns void

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

    • Private flushTasksQueues

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

    Private getInitialWorkerInfo

    +
    +
    +

    Private getInitialWorkerUsage

    +
    +
    +

    Private getWorkerById

    +
    +
    +

    Private getWorkerId

    +
    +
    +

    Private getWorkerInfo

    +

    Private getWorkerNodeKey

    -
    -

    Private getWorkerUsage

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

    Private handleTaskExecutionResponse

    +

    Returns void

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

    Private handleWorkerStartedMessage

    +

    Protected internalBusy

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

    • Protected Abstract isMain

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

    • Private pushWorkerNode

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

    Private redistributeQueuedTasks

    +

    Private registerWorkerMessageListener

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

    • Private removeWorkerNode

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

    • Protected Abstract sendToWorker

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

    • setTasksQueueOptions

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Private setWorkerNodeTasksUsage

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

    • Private setWorkerStatistics

    Returns void

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

    • Protected setupHook

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

    • Private shallCreateDynamicWorker

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

    • Private tasksMaxQueueSize

    Returns number

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

    • Private tasksQueueSize

    Returns number

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

    • Private updateEluWorkerUsage

    Returns void

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

    • Private updateRunTimeWorkerUsage

    Returns void

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

    • Private updateTaskStatisticsWorkerUsage

    Returns void

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

    • Private updateWaitTimeWorkerUsage

    Returns void

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:974
    • @@ -1112,6 +1252,7 @@ Can be overridden.

  • numberOfWorkers
  • opts
  • promiseResponseMap
    • +
  • startTimestamp
  • workerChoiceStrategyContext
  • workerNodes
  • busy
    • @@ -1120,6 +1261,7 @@ Can be overridden.

  • maxSize
  • minSize
  • type
    • +
  • utilization
  • worker
  • afterTaskExecutionHook
  • afterWorkerSetup
    • @@ -1145,11 +1287,18 @@ Can be overridden.

  • executeTask
  • flushTasksQueue
  • flushTasksQueues
    • +
  • getInitialWorkerInfo
    • +
  • getInitialWorkerUsage
    • +
  • getWorkerById
    • +
  • getWorkerId
    • +
  • getWorkerInfo
  • getWorkerNodeKey
    • -
  • getWorkerUsage
    • +
  • handleTaskExecutionResponse
    • +
  • handleWorkerStartedMessage
  • internalBusy
  • isMain
  • pushWorkerNode
    • +
  • redistributeQueuedTasks
  • registerWorkerMessageListener
  • removeWorkerNode
  • sendToWorker
    • @@ -1168,7 +1317,7 @@ Can be overridden.

  • updateWaitTimeWorkerUsage
  • workerListener
    • -