X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=4a702c21b1eeab59420a01ffa9169bf18e4916d7;hb=80520ca4c78c2a023bf78e96769317f7e1eeb6e5;hp=bbe344d91c32e9322c387af0a2be333376e07d1f;hpb=68da37cdc5b2d146b0f1b139092e6063dcdd16bb;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index bbe344d9..4a702c21 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -1,4 +1,4 @@ -AbstractPool | poolifier - v2.6.12
+AbstractPool | poolifier - v2.6.15
  • Preparing search index...
    • -
  • The search index is not available
poolifier - v2.6.12
+
  • The search index is not available
    • poolifier - v2.6.15
    @@ -49,7 +49,7 @@
    • IPool<Worker, Data, Response>
    +
  • Defined in src/pools/abstract-pool.ts:54
    • @@ -85,7 +85,8 @@

    Methods

    -
    afterTaskExecutionHook +
    addWorkerNode +afterTaskExecutionHook afterWorkerSetup beforeTaskExecutionHook buildTasksQueueOptions @@ -115,14 +116,14 @@ getWorkerInfo getWorkerNodeKey handleTaskExecutionResponse -handleWorkerReadyMessage +handleWorkerReadyResponse internalBusy isMain -pushWorkerNode redistributeQueuedTasks registerWorkerMessageListener removeWorkerNode sendToWorker +sendWorkerStartupMessage setTasksQueueOptions setWorkerChoiceStrategy setWorkerChoiceStrategyOptions @@ -175,7 +176,7 @@

    Returns AbstractPool<Worker, Data, Response>

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

    • Properties

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

    • Protected Readonly filePath

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

    • Protected Readonly numberOfWorkers

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

    • Protected Readonly opts

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

    • Protected promiseResponseMap

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

    • Private Readonly startTimestamp

    startTimestamp: number
    @@ -239,7 +240,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:90

    • Protected workerChoiceStrategyContext

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

    • Readonly workerNodes

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

    • Accessors

    @@ -270,7 +271,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:283

    • Protected Abstract maxSize

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

    • Protected Abstract minSize

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

    • Private ready

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

    • Private starting

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

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

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

    • Protected checkDynamicPoolSize

    Returns void

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

    • Private checkFilePath

    Returns void

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

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

    • Private checkPoolOptions

    Returns void

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

    • Private checkValidTasksQueueOptions

    Returns void

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

    • Private checkValidWorkerChoiceStrategy

    Returns void

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

    • Private checkValidWorkerChoiceStrategyOptions

    Returns void

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

    • Private chooseWorkerNode

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

    • Protected createAndSetupDynamicWorker

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

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

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

    • execute

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

    • Private executeTask

    +

    Returns void

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

    • Private flushTasksQueue

    Returns void

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

    • Private flushTasksQueues

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

    • Private getWorkerById

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

    • Private getWorkerInfo

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

    • Private getWorkerNodeKey

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

    • Private handleTaskExecutionResponse

    Returns void

    -
    -

    Private handleWorkerReadyMessage

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

    Private handleWorkerReadyResponse

    Returns void

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

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

    • Private registerWorkerMessageListener

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

    • Private removeWorkerNode

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

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

    • Protected setupHook

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

    • Private shallCreateDynamicWorker

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

    • Private tasksQueueSize

    Returns number

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

    • 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:1077
    • @@ -1226,6 +1254,7 @@ Can be overridden.

  • type
  • utilization
  • worker
    • +
  • addWorkerNode
  • afterTaskExecutionHook
  • afterWorkerSetup
  • beforeTaskExecutionHook
    • @@ -1256,14 +1285,14 @@ Can be overridden.

  • getWorkerInfo
  • getWorkerNodeKey
  • handleTaskExecutionResponse
    • -
  • handleWorkerReadyMessage
    • +
  • handleWorkerReadyResponse
  • internalBusy
  • isMain
    • -
  • pushWorkerNode
  • redistributeQueuedTasks
  • registerWorkerMessageListener
  • removeWorkerNode
  • sendToWorker
    • +
  • sendWorkerStartupMessage
  • setTasksQueueOptions
  • setWorkerChoiceStrategy
  • setWorkerChoiceStrategyOptions
    • @@ -1277,7 +1306,7 @@ Can be overridden.

  • updateWaitTimeWorkerUsage
  • workerListener
    • -