X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=800d4a3cda8c167931058f5b209aa9f93238ebb6;hb=2826fc7a3ba7197b08fe5c352d8965b234f3abc5;hp=e0c7cbe38ba7dd7948f6bce03df14073ae1d6d60;hpb=67e8ef11907ab8ae70740d7c9f4d5d225ed8d522;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index e0c7cbe3..800d4a3c 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -1,4 +1,4 @@ -AbstractPool | poolifier - v2.6.12
+AbstractPool | poolifier - v2.6.17
  • Preparing search index...
    • -
  • The search index is not available
poolifier - v2.6.12
+
  • The search index is not available
    • poolifier - v2.6.17
    @@ -49,7 +49,7 @@
    • IPool<Worker, Data, Response>
    +
  • Defined in src/pools/abstract-pool.ts:54
    • @@ -67,6 +67,7 @@ opts promiseResponseMap startTimestamp +starting workerChoiceStrategyContext workerNodes
    @@ -78,14 +79,14 @@ maxSize minSize ready -starting type utilization worker

    Methods

    -
    afterTaskExecutionHook +
    addWorkerNode +afterTaskExecutionHook afterWorkerSetup beforeTaskExecutionHook buildTasksQueueOptions @@ -115,20 +116,21 @@ getWorkerInfo getWorkerNodeKey handleTaskExecutionResponse -handleWorkerReadyMessage +handleWorkerReadyResponse internalBusy isMain -pushWorkerNode redistributeQueuedTasks registerWorkerMessageListener removeWorkerNode sendToWorker +sendWorkerStartupMessage setTasksQueueOptions setWorkerChoiceStrategy setWorkerChoiceStrategyOptions setWorkerStatistics setupHook shallCreateDynamicWorker +startPool tasksQueueSize updateEluWorkerUsage updateRunTimeWorkerUsage @@ -175,7 +177,7 @@

    Returns AbstractPool<Worker, Data, Response>

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

    • Properties

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

    • Protected Readonly filePath

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

    • Protected Readonly numberOfWorkers

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

    • Protected Readonly opts

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

    • Protected promiseResponseMap

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

    • Private Readonly startTimestamp

    startTimestamp: number
    @@ -239,7 +241,15 @@
    +
  • Defined in src/pools/abstract-pool.ts:94
    • +
    +

    Private Readonly starting

    +
    starting: boolean
    +

    Whether the pool is starting or not.

    +
    +

    Protected workerChoiceStrategyContext

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

    • Readonly workerNodes

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

    • Accessors

    @@ -270,7 +280,7 @@

    Returns boolean

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

    • Protected full

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

    • info

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

    • Protected Abstract maxSize

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

    • Protected Abstract minSize

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

    • Private ready

    -
    -

    Private starting

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

    • Protected Abstract type

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

    • Private utilization

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

    • Protected Abstract worker

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

    • Methods

    +
    +

    Private addWorkerNode

    +
      + +
    • +

      Adds the given worker in the pool worker nodes.

      +
      +
      +

      Parameters

      +
        +
      • +
        worker: Worker
        +

        The worker.

        +
        +
      +

      Returns number

      The worker nodes length.

      + +

    Protected afterTaskExecutionHook

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

    • Protected afterWorkerSetup

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

    • Protected beforeTaskExecutionHook

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

    • Private buildTasksQueueOptions

    Returns TasksQueueOptions

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

    • Private checkAndEmitEvents

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

    • Protected checkDynamicPoolSize

    Returns void

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

    • Private checkFilePath

    Returns void

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

    • Private checkMessageWorkerId

    +

    Returns void

    +
    +

    Throws

    https://nodejs.org/api/errors.html#class-error If the worker id is invalid.

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

    • Private checkNumberOfWorkers

    Returns void

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

    • Private checkPoolOptions

    Returns void

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

    • Private checkValidTasksQueueOptions

    Returns void

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

    • Private checkValidWorkerChoiceStrategy

    Returns void

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

    • Private checkValidWorkerChoiceStrategyOptions

    Returns void

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

    • Private chooseWorkerNode

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

    • Protected createAndSetupDynamicWorker

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

    • Protected createAndSetupWorker

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

    • Protected Abstract createWorker

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

    • Private dequeueTask

    Returns undefined | Task<Data>

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

    • destroy

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

    • Protected Abstract destroyWorker

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

    • enableTasksQueue

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

    • Private enqueueTask

    Returns number

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

    • execute

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

    • Private executeTask

    +

    Returns void

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

    • Private flushTasksQueue

    Returns void

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

    • Private flushTasksQueues

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

    • Private getWorkerById

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

    • Private getWorkerInfo

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

    • Private getWorkerNodeKey

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

    • Private handleTaskExecutionResponse

    Returns void

    -
    -

    Private handleWorkerReadyMessage

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

    Private handleWorkerReadyResponse

    Returns void

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

    • Protected internalBusy

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

    • Protected Abstract isMain

    -
    -

    Private pushWorkerNode

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

    • Private redistributeQueuedTasks

    Returns void

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

    • Private registerWorkerMessageListener

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

    • Private removeWorkerNode

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

    • Protected Abstract sendToWorker

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

    Private sendWorkerStartupMessage

    +

    setTasksQueueOptions

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Private setWorkerStatistics

    Returns void

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

    • Protected setupHook

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

    • Private shallCreateDynamicWorker

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

    Private startPool

    +

    Private tasksQueueSize

    Returns number

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

    • Private updateEluWorkerUsage

    Returns void

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

    • Private updateRunTimeWorkerUsage

    Returns void

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

    • Private updateTaskStatisticsWorkerUsage

    Returns void

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

    • Private updateWaitTimeWorkerUsage

    Returns void

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:1075
    • @@ -1214,6 +1251,7 @@ Can be overridden.

  • opts
  • promiseResponseMap
  • startTimestamp
    • +
  • starting
  • workerChoiceStrategyContext
  • workerNodes
  • busy
    • @@ -1222,10 +1260,10 @@ Can be overridden.

  • maxSize
  • minSize
  • ready
    • -
  • starting
  • type
  • utilization
  • worker
    • +
  • addWorkerNode
  • afterTaskExecutionHook
  • afterWorkerSetup
  • beforeTaskExecutionHook
    • @@ -1256,20 +1294,21 @@ Can be overridden.

  • getWorkerInfo
  • getWorkerNodeKey
  • handleTaskExecutionResponse
    • -
  • handleWorkerReadyMessage
    • +
  • handleWorkerReadyResponse
  • internalBusy
  • isMain
    • -
  • pushWorkerNode
  • redistributeQueuedTasks
  • registerWorkerMessageListener
  • removeWorkerNode
  • sendToWorker
    • +
  • sendWorkerStartupMessage
  • setTasksQueueOptions
  • setWorkerChoiceStrategy
  • setWorkerChoiceStrategyOptions
  • setWorkerStatistics
  • setupHook
  • shallCreateDynamicWorker
    • +
  • startPool
  • tasksQueueSize
  • updateEluWorkerUsage
  • updateRunTimeWorkerUsage
    • @@ -1277,7 +1316,7 @@ Can be overridden.

  • updateWaitTimeWorkerUsage
  • workerListener
    • -