X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=bbe344d91c32e9322c387af0a2be333376e07d1f;hb=f38f85c043864b68ea519f6bdf94821c356195f1;hp=9283ff10c255dab55704f19a246c87e8453cabac;hpb=a97f9c80aa49c6152547fb6fa8de4b0f089c2353;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index 9283ff10..bbe344d9 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -1,4 +1,4 @@ -AbstractPool | poolifier
+AbstractPool | poolifier - v2.6.12
  • Preparing search index...
    • -
  • The search index is not available
poolifier
+
  • The search index is not available
    • poolifier - v2.6.12
    @@ -49,7 +49,7 @@
    • IPool<Worker, Data, Response>
    +
  • Defined in src/pools/abstract-pool.ts:49
    • @@ -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:94

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

    • Protected Readonly filePath

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

    • Protected Readonly numberOfWorkers

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

    • Protected Readonly opts

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

    • Protected promiseResponseMap

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

    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:76

    • Readonly workerNodes

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

    Pool worker nodes.

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

    • Accessors

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

    Returns boolean

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

    • Protected full

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

    • info

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

    • Protected Abstract maxSize

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

    • Protected Abstract minSize

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

    Private ready

    +
    +
    +

    Private starting

    +

    Protected Abstract type

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

    Private utilization

    +

    Protected Abstract worker

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

    • Methods

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

    Returns void

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

    • Protected afterWorkerSetup

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

    • Protected beforeTaskExecutionHook

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

    • Private buildTasksQueueOptions

    Returns TasksQueueOptions

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

    • Private checkAndEmitEvents

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

    Protected checkDynamicPoolSize

    +

    Private checkFilePath

    Returns void

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

    Private checkMessageWorkerId

    +

    Private checkNumberOfWorkers

    Returns void

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

    • Private checkPoolOptions

    Returns void

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

    • Private checkValidTasksQueueOptions

    Returns void

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

    • Private checkValidWorkerChoiceStrategy

    Returns void

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

    • Private checkValidWorkerChoiceStrategyOptions

    Returns void

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

    • Private chooseWorkerNode

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

    • Protected createAndSetupDynamicWorker

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

    • Protected createAndSetupWorker

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

    • Protected Abstract createWorker

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

    • Private dequeueTask

    Returns undefined | Task<Data>

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

    • destroy

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

    • Protected Abstract destroyWorker

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

    • enableTasksQueue

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

    • Private enqueueTask

    Returns number

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

    • execute

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

    • Private executeTask

    Returns void

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

    • Private flushTasksQueue

    Returns void

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

    • Private flushTasksQueues

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

    Private getWorkerById

    +
    +
    +

    Private getWorkerInfo

    +

    Private getWorkerNodeKey

    -
    -

    Private getWorkerUsage

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

    Private handleTaskExecutionResponse

    +
    +
    +

    Private handleWorkerReadyMessage

    +

    Returns void

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

    • Protected internalBusy

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

    • Protected Abstract isMain

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

    • Private pushWorkerNode

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

    Private redistributeQueuedTasks

    +

    Private registerWorkerMessageListener

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

    • Private removeWorkerNode

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

    • Protected Abstract sendToWorker

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

    • setTasksQueueOptions

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

    -
    -

    Private setWorkerNodeTasksUsage

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

    • Private setWorkerStatistics

    Returns void

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

    • Protected setupHook

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

    • Private shallCreateDynamicWorker

    -
    -

    Private tasksMaxQueueSize

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

    • Private tasksQueueSize

    Returns number

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

    • Private updateEluWorkerUsage

    Returns void

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

    • Private updateRunTimeWorkerUsage

    Returns void

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

    • Private updateTaskStatisticsWorkerUsage

    Returns void

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

    • Private updateWaitTimeWorkerUsage

    Returns void

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:1025
    • @@ -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
    • -