X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=69eed59d7a1c784bb810947a41f8721fc8bd9579;hb=b80e10df8405b314ca192edbc9a079dffcc6305b;hp=c6bf43baf88ac70a2be1d8227bf86ad1f2d9a5f8;hpb=6d6c7ed0c2c3c83cefae4d8cd5bc9393126bba70;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index c6bf43ba..69eed59d 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -1,4 +1,4 @@ -AbstractPool | poolifier
+AbstractPool | poolifier - v2.6.14
  • Preparing search index...
    • -
  • The search index is not available
poolifier
+
  • The search index is not available
    • poolifier - v2.6.14
    @@ -49,7 +49,7 @@
    • IPool<Worker, Data, Response>
    +
  • Defined in src/pools/abstract-pool.ts:53
    • @@ -66,6 +66,7 @@ numberOfWorkers opts promiseResponseMap +startTimestamp workerChoiceStrategyContext workerNodes
    @@ -76,7 +77,10 @@ info maxSize minSize +ready +starting type +utilization worker
    @@ -86,7 +90,9 @@ beforeTaskExecutionHook buildTasksQueueOptions checkAndEmitEvents +checkDynamicPoolSize checkFilePath +checkMessageWorkerId checkNumberOfWorkers checkPoolOptions checkValidTasksQueueOptions @@ -105,22 +111,24 @@ executeTask flushTasksQueue flushTasksQueues +getWorkerById +getWorkerInfo getWorkerNodeKey -getWorkerUsage +handleTaskExecutionResponse +handleWorkerReadyMessage internalBusy isMain pushWorkerNode +redistributeQueuedTasks registerWorkerMessageListener removeWorkerNode sendToWorker setTasksQueueOptions setWorkerChoiceStrategy setWorkerChoiceStrategyOptions -setWorkerNodeTasksUsage setWorkerStatistics setupHook shallCreateDynamicWorker -tasksMaxQueueSize tasksQueueSize updateEluWorkerUsage updateRunTimeWorkerUsage @@ -167,7 +175,7 @@

    Returns AbstractPool<Worker, Data, Response>

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

    • Properties

    @@ -176,8 +184,9 @@

    Emitter on which events can be listened to.

    Events that can currently be listened to:

      -
    • 'full': Emitted when the pool is dynamic and full.
      • -
    • 'busy': Emitted when the pool is busy.
      • +
    • 'full': Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.
      • +
    • 'ready': Emitted when the number of workers created in the pool has reached the minimum size expected and are ready.
      • +
    • 'busy': Emitted when the number of workers created in the pool has reached the maximum size expected and are executing at least one task.
    • 'error': Emitted when an uncaught error occurs.
    • 'taskError': Emitted when an error occurs while executing a task.
    @@ -185,7 +194,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:62

    • Protected Readonly filePath

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

    • Protected Readonly numberOfWorkers

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

    • Protected Readonly opts

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

    • Protected promiseResponseMap

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

    Private Readonly startTimestamp

    +
    startTimestamp: number
    +

    The start timestamp of the pool.

    +
    +

    Protected workerChoiceStrategyContext

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

    • Readonly workerNodes

    -
    workerNodes: WorkerNode<Worker, Data>[] = []
    +
    workerNodes: IWorkerNode<Worker, Data>[] = []

    Pool worker nodes.

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

    • Accessors

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

    Returns boolean

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

    • Protected full

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

    • info

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

    • Protected Abstract maxSize

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

    • Protected Abstract minSize

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

    Private ready

    +
    +
    +

    Private starting

    +

    Protected Abstract type

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

    Private utilization

    +

    Protected Abstract worker

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

    • Methods

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

    Returns void

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

    • Protected afterWorkerSetup

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

    • Protected beforeTaskExecutionHook

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

    • Private buildTasksQueueOptions

    Returns TasksQueueOptions

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

    • Private checkAndEmitEvents

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

    Protected checkDynamicPoolSize

    +

    Private checkFilePath

    Returns void

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

    Private checkMessageWorkerId

    +

    Private checkNumberOfWorkers

    Returns void

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

    • Private checkPoolOptions

    Returns void

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

    • Private checkValidTasksQueueOptions

    Returns void

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

    • Private checkValidWorkerChoiceStrategy

    Returns void

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

    • Private checkValidWorkerChoiceStrategyOptions

    Returns void

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

    • Private chooseWorkerNode

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

    • Protected createAndSetupDynamicWorker

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

    • Protected createAndSetupWorker

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

    • Protected Abstract createWorker

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

    • Private dequeueTask

    Returns undefined | Task<Data>

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

    • destroy

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

    • Protected Abstract destroyWorker

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

    • enableTasksQueue

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

    • Private enqueueTask

    Returns number

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

    • execute

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

    • Private executeTask

    Returns void

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

    • Private flushTasksQueue

    Returns void

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

    • Private flushTasksQueues

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

    Private getWorkerById

    +
    +
    +

    Private getWorkerInfo

    +

    Private getWorkerNodeKey

    -
    -

    Private getWorkerUsage

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

    Private handleTaskExecutionResponse

    +
    +
    +

    Private handleWorkerReadyMessage

    +

    Returns void

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

    • Protected internalBusy

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

    • Protected Abstract isMain

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

    • Private pushWorkerNode

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

    Private redistributeQueuedTasks

    +

    Private registerWorkerMessageListener

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

    • Private removeWorkerNode

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

    • Protected Abstract sendToWorker

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

    • setTasksQueueOptions

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

    -
    -

    Private setWorkerNodeTasksUsage

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

    • Private setWorkerStatistics

    Returns void

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

    • Protected setupHook

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

    • Private shallCreateDynamicWorker

    -
    -

    Private tasksMaxQueueSize

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

    • Private tasksQueueSize

    Returns number

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

    • Private updateEluWorkerUsage

    Returns void

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

    • Private updateRunTimeWorkerUsage

    Returns void

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

    • Private updateTaskStatisticsWorkerUsage

    Returns void

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

    • Private updateWaitTimeWorkerUsage

    Returns void

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

    • Protected workerListener

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

  • numberOfWorkers
  • opts
  • promiseResponseMap
    • +
  • startTimestamp
  • workerChoiceStrategyContext
  • workerNodes
  • busy
    • @@ -1119,14 +1221,19 @@ Can be overridden.

  • info
  • maxSize
  • minSize
    • +
  • ready
    • +
  • starting
  • type
    • +
  • utilization
  • worker
  • afterTaskExecutionHook
  • afterWorkerSetup
  • beforeTaskExecutionHook
  • buildTasksQueueOptions
  • checkAndEmitEvents
    • +
  • checkDynamicPoolSize
  • checkFilePath
    • +
  • checkMessageWorkerId
  • checkNumberOfWorkers
  • checkPoolOptions
  • checkValidTasksQueueOptions
    • @@ -1145,22 +1252,24 @@ Can be overridden.

  • executeTask
  • flushTasksQueue
  • flushTasksQueues
    • +
  • getWorkerById
    • +
  • getWorkerInfo
  • getWorkerNodeKey
    • -
  • getWorkerUsage
    • +
  • handleTaskExecutionResponse
    • +
  • handleWorkerReadyMessage
  • internalBusy
  • isMain
  • pushWorkerNode
    • +
  • redistributeQueuedTasks
  • registerWorkerMessageListener
  • removeWorkerNode
  • sendToWorker
  • setTasksQueueOptions
  • setWorkerChoiceStrategy
  • setWorkerChoiceStrategyOptions
    • -
  • setWorkerNodeTasksUsage
  • setWorkerStatistics
  • setupHook
  • shallCreateDynamicWorker
    • -
  • tasksMaxQueueSize
  • tasksQueueSize
  • updateEluWorkerUsage
  • updateRunTimeWorkerUsage
    • @@ -1168,7 +1277,7 @@ Can be overridden.

  • updateWaitTimeWorkerUsage
  • workerListener
    • -