X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=b715f58252fedfcb65551a488c2456133f908429;hb=04cb7adbacc7fb0d1b76db6122f86c52e33d136d;hp=b2f7708126032076cac10faa516f6af64c3c4b2b;hpb=5497d426557f576e3ee314619f83b71685acc6bc;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index b2f77081..b715f582 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -1,4 +1,4 @@ -AbstractPool | poolifier
+AbstractPool | poolifier - v2.6.10
  • Preparing search index...
    • -
  • The search index is not available
poolifier
+
  • The search index is not available
    • poolifier - v2.6.10
    @@ -49,7 +49,7 @@
    • IPool<Worker, Data, Response>
    +
  • Defined in src/pools/abstract-pool.ts:49
    • @@ -77,7 +77,8 @@ info maxSize minSize -runTime +ready +starting type utilization worker @@ -89,7 +90,9 @@ beforeTaskExecutionHook buildTasksQueueOptions checkAndEmitEvents +checkDynamicPoolSize checkFilePath +checkMessageWorkerId checkNumberOfWorkers checkPoolOptions checkValidTasksQueueOptions @@ -109,25 +112,23 @@ flushTasksQueue flushTasksQueues getWorkerById -getWorkerId +getWorkerInfo getWorkerNodeKey -getWorkerUsage handleTaskExecutionResponse -handleWorkerStartedMessage +handleWorkerReadyMessage internalBusy isMain pushWorkerNode +redistributeQueuedTasks registerWorkerMessageListener removeWorkerNode sendToWorker setTasksQueueOptions setWorkerChoiceStrategy setWorkerChoiceStrategyOptions -setWorkerNodeTasksUsage setWorkerStatistics setupHook shallCreateDynamicWorker -tasksMaxQueueSize tasksQueueSize updateEluWorkerUsage updateRunTimeWorkerUsage @@ -174,7 +175,7 @@

    Returns AbstractPool<Worker, Data, Response>

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

    • Properties

    @@ -183,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 maximum 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.
    @@ -192,7 +194,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:58

    • Protected Readonly filePath

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

    • Protected Readonly numberOfWorkers

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

    • Protected Readonly opts

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

    • Protected promiseResponseMap

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

    • Private Readonly startTimestamp

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

    • Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -245,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

    @@ -268,7 +270,7 @@

    Returns boolean

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

    • Protected full

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

    • info

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

    • Protected Abstract maxSize

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

    • Protected Abstract minSize

    -
    -

    Private runTime

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

    Private ready

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

    Private starting

    +

    Protected Abstract type

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

    • Private utilization

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

    • Protected Abstract worker

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

    • Methods

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

    Returns void

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

    • Protected afterWorkerSetup

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

    • Protected beforeTaskExecutionHook

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

    • Private buildTasksQueueOptions

    Returns TasksQueueOptions

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

    • Private checkAndEmitEvents

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

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

    • Private checkValidTasksQueueOptions

    Returns void

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

    • Private checkValidWorkerChoiceStrategy

    Returns void

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

    • Private checkValidWorkerChoiceStrategyOptions

    Returns void

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

    • Private chooseWorkerNode

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

    • Protected createAndSetupDynamicWorker

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

    • Protected createAndSetupWorker

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

    • Protected Abstract createWorker

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

    • Private dequeueTask

    Returns undefined | Task<Data>

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

    • destroy

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

    • Protected Abstract destroyWorker

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

    • enableTasksQueue

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

    • Private enqueueTask

    Returns number

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

    • execute

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

    • Private executeTask

    Returns void

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

    • Private flushTasksQueue

    Returns void

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

    • Private flushTasksQueues

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

    • Private getWorkerById

    -
    -

    Private getWorkerId

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

    Private getWorkerInfo

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

    • Private getWorkerNodeKey

    -
    -

    Private getWorkerUsage

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

    • Private handleTaskExecutionResponse

    Returns void

    -
    -

    Private handleWorkerStartedMessage

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

    Private handleWorkerReadyMessage

    Returns void

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

    • Protected internalBusy

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

    • Protected Abstract isMain

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

    • Private pushWorkerNode

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

    Private redistributeQueuedTasks

    +

    Private registerWorkerMessageListener

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

    • Private removeWorkerNode

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

    • Protected Abstract sendToWorker

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

    • setTasksQueueOptions

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

    -
    -

    Private setWorkerNodeTasksUsage

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

    • Private setWorkerStatistics

    Returns void

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

    • Protected setupHook

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

    • Private shallCreateDynamicWorker

    -
    -

    Private tasksMaxQueueSize

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

    • Private tasksQueueSize

    Returns number

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

    • Private updateEluWorkerUsage

    Returns void

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

    • Private updateRunTimeWorkerUsage

    Returns void

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

    • Private updateTaskStatisticsWorkerUsage

    Returns void

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

    • Private updateWaitTimeWorkerUsage

    Returns void

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:1021
    • @@ -1225,7 +1221,8 @@ Can be overridden.

  • info
  • maxSize
  • minSize
    • -
  • runTime
    • +
  • ready
    • +
  • starting
  • type
  • utilization
  • worker
    • @@ -1234,7 +1231,9 @@ Can be overridden.

  • beforeTaskExecutionHook
  • buildTasksQueueOptions
  • checkAndEmitEvents
    • +
  • checkDynamicPoolSize
  • checkFilePath
    • +
  • checkMessageWorkerId
  • checkNumberOfWorkers
  • checkPoolOptions
  • checkValidTasksQueueOptions
    • @@ -1254,25 +1253,23 @@ Can be overridden.

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

  • updateWaitTimeWorkerUsage
  • workerListener
    • -