X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=984c1c21c2da8ba185da4297fe494a7610100b85;hb=5c30b9d94384214b24f11ea7e68a54efaa6795b7;hp=9de28f0cfe4a3cb12fe5a6a8e64bc4609040dd88;hpb=52f4e8137eab5d72c663eb9ae9289c08d804e559;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index 9de28f0c..984c1c21 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -1,4 +1,4 @@ -AbstractPool | poolifier - v2.6.12
+AbstractPool | poolifier - v2.6.19
  • Preparing search index...
    • -
  • The search index is not available
poolifier - v2.6.12
+
  • The search index is not available
    • poolifier - v2.6.19
    @@ -49,7 +49,7 @@
    • IPool<Worker, Data, Response>
    +
  • Defined in src/pools/abstract-pool.ts:55
    • @@ -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 @@ -113,15 +114,16 @@ flushTasksQueues getWorkerById getWorkerInfo -getWorkerNodeKey +getWorkerInfoByWorker +getWorkerNodeKey handleTaskExecutionResponse -handleWorkerReadyMessage +handleWorkerReadyResponse internalBusy isMain -pushWorkerNode redistributeQueuedTasks -registerWorkerMessageListener +registerWorkerMessageListener removeWorkerNode +sendStartupMessageToWorker sendToWorker setTasksQueueOptions setWorkerChoiceStrategy @@ -129,6 +131,7 @@ setWorkerStatistics setupHook shallCreateDynamicWorker +startPool tasksQueueSize updateEluWorkerUsage updateRunTimeWorkerUsage @@ -175,7 +178,7 @@

    Returns AbstractPool<Worker, Data, Response>

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

    • Properties

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

    • Protected Readonly filePath

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

    • Protected Readonly numberOfWorkers

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

    • Protected Readonly opts

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

    • Protected promiseResponseMap

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

    • Private Readonly startTimestamp

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

    Private Readonly starting

    +
    starting: boolean
    +

    Whether the pool is starting or not.

    +
    +

    Protected workerChoiceStrategyContext

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

    • Readonly workerNodes

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

    • Accessors

    @@ -270,7 +281,7 @@

    Returns boolean

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

    • Protected full

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

    • info

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

    • Protected Abstract maxSize

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

    • Protected Abstract minSize

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

    • Private ready

    -
    -

    Private starting

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

    • Protected Abstract type

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

    • Private utilization

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

    • Protected Abstract worker

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

    • 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:717

    • Protected afterWorkerSetup

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

    • Protected beforeTaskExecutionHook

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

    • Private buildTasksQueueOptions

    Returns TasksQueueOptions

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

    • Private checkAndEmitEvents

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

    • Protected checkDynamicPoolSize

    Returns void

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

    • Private checkFilePath

    Returns void

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

    • 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:502

    • Private checkNumberOfWorkers

    Returns void

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

    • Private checkPoolOptions

    Returns void

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

    • Private checkValidTasksQueueOptions

    Returns void

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

    • Private checkValidWorkerChoiceStrategy

    Returns void

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

    • Private checkValidWorkerChoiceStrategyOptions

    Returns void

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

    • Private chooseWorkerNode

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

    • Protected createAndSetupDynamicWorker

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

    • Protected createAndSetupWorker

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

    • Protected Abstract createWorker

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

    • Private dequeueTask

    Returns undefined | Task<Data>

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

    • destroy

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

    • Protected Abstract destroyWorker

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

    • enableTasksQueue

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

    • Private enqueueTask

    Returns number

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

    • execute

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

    • Private executeTask

    +

    Returns void

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

    • Private flushTasksQueue

    Returns void

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

    • Private flushTasksQueues

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

    • Private getWorkerById

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

    • Private getWorkerInfo

    -

    Returns WorkerInfo

    +

    Returns WorkerInfo

    The worker information.

    +
    -
    -

    Private getWorkerNodeKey

    -
    +
    +

    Protected getWorkerInfoByWorker

    +
    +
    +

    Protected getWorkerNodeKey

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

    • Private handleTaskExecutionResponse

    Returns void

    -
    -

    Private handleWorkerReadyMessage

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

    Private handleWorkerReadyResponse

    Returns void

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

    • Protected internalBusy

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

    • Protected Abstract isMain

    -
    -

    Private pushWorkerNode

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

    • Private redistributeQueuedTasks

    Returns void

    -
    -

    Private registerWorkerMessageListener

    -
    +
    +

    Protected Abstract registerWorkerMessageListener

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

    • Private removeWorkerNode

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

    Protected Abstract sendStartupMessageToWorker

    +

    Protected Abstract sendToWorker

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

    • setTasksQueueOptions

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Private setWorkerStatistics

    Returns void

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

    • Protected setupHook

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

    • Private shallCreateDynamicWorker

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

    Private startPool

    +

    Private tasksQueueSize

    Returns number

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

    • Private updateEluWorkerUsage

    Returns void

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

    • Private updateRunTimeWorkerUsage

    Returns void

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

    • Private updateTaskStatisticsWorkerUsage

    Returns void

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

    • Private updateWaitTimeWorkerUsage

    Returns void

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

    • Protected workerListener

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

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

  • maxSize
  • minSize
  • ready
    • -
  • starting
  • type
  • utilization
  • worker
    • +
  • addWorkerNode
  • afterTaskExecutionHook
  • afterWorkerSetup
  • beforeTaskExecutionHook
    • @@ -1254,15 +1322,16 @@ Can be overridden.

  • flushTasksQueues
  • getWorkerById
  • getWorkerInfo
    • -
  • getWorkerNodeKey
    • +
  • getWorkerInfoByWorker
    • +
  • getWorkerNodeKey
  • handleTaskExecutionResponse
    • -
  • handleWorkerReadyMessage
    • +
  • handleWorkerReadyResponse
  • internalBusy
  • isMain
    • -
  • pushWorkerNode
  • redistributeQueuedTasks
    • -
  • registerWorkerMessageListener
    • +
  • registerWorkerMessageListener
  • removeWorkerNode
    • +
  • sendStartupMessageToWorker
  • sendToWorker
  • setTasksQueueOptions
  • setWorkerChoiceStrategy
    • @@ -1270,6 +1339,7 @@ Can be overridden.

  • setWorkerStatistics
  • setupHook
  • shallCreateDynamicWorker
    • +
  • startPool
  • tasksQueueSize
  • updateEluWorkerUsage
  • updateRunTimeWorkerUsage
    • @@ -1277,7 +1347,7 @@ Can be overridden.

  • updateWaitTimeWorkerUsage
  • workerListener
    • -