X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=d7c1a3d61996c22fecaacad3ea76b8e772c1402f;hb=36df5bd40369d98d6ccb60400e66dce1aa980d54;hp=05e604785c9503029d889ba9864e940526f06451;hpb=658b9aa08266ed9a8ae3c0fc947d237fa2674f09;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index 05e60478..d7c1a3d6 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -1,4 +1,4 @@ -AbstractPool | poolifier - v2.6.9
+AbstractPool | poolifier - v2.6.15
  • Preparing search index...
    • -
  • The search index is not available
poolifier - v2.6.9
+
  • 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
    • @@ -67,6 +67,7 @@ opts promiseResponseMap startTimestamp +starting workerChoiceStrategyContext workerNodes
    @@ -77,18 +78,22 @@ info maxSize minSize +ready type utilization worker

    Methods

    -
    afterTaskExecutionHook +
    addWorkerNode +afterTaskExecutionHook afterWorkerSetup beforeTaskExecutionHook buildTasksQueueOptions checkAndEmitEvents +checkDynamicPoolSize checkFilePath +checkMessageWorkerId checkNumberOfWorkers checkPoolOptions checkValidTasksQueueOptions @@ -107,29 +112,24 @@ executeTask flushTasksQueue flushTasksQueues -getInitialWorkerInfo -getInitialWorkerUsage getWorkerById -getWorkerId getWorkerInfo getWorkerNodeKey handleTaskExecutionResponse -handleWorkerStartedMessage +handleWorkerReadyResponse internalBusy isMain -pushWorkerNode redistributeQueuedTasks registerWorkerMessageListener removeWorkerNode sendToWorker +sendWorkerStartupMessage setTasksQueueOptions setWorkerChoiceStrategy setWorkerChoiceStrategyOptions -setWorkerNodeTasksUsage setWorkerStatistics setupHook shallCreateDynamicWorker -tasksMaxQueueSize tasksQueueSize updateEluWorkerUsage updateRunTimeWorkerUsage @@ -176,7 +176,7 @@

    Returns AbstractPool<Worker, Data, Response>

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

    • Properties

    @@ -185,8 +185,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.
    @@ -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:105

    • Protected Readonly numberOfWorkers

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

    • Protected Readonly opts

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

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

    Private Readonly starting

    +
    starting: boolean
    +

    Whether the pool is starting or not.

    +
    +

    Protected workerChoiceStrategyContext

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

    • Readonly workerNodes

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

    Pool worker nodes.

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

    • Accessors

    @@ -270,7 +279,7 @@

    Returns boolean

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

    • Protected full

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

    • info

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

    • Protected Abstract maxSize

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

    • Protected Abstract minSize

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

    Private ready

    +

    Protected Abstract type

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

    • Private utilization

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

    • Protected Abstract worker

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

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

    • Protected afterWorkerSetup

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

    • Protected beforeTaskExecutionHook

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

    • Private buildTasksQueueOptions

    Returns TasksQueueOptions

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

    • Private checkAndEmitEvents

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

    Protected checkDynamicPoolSize

    +

    Private checkFilePath

    Returns void

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

    Private checkMessageWorkerId

    +

    Private checkNumberOfWorkers

    Returns void

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

    • Private checkPoolOptions

    Returns void

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

    • Private checkValidTasksQueueOptions

    Returns void

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

    • Private checkValidWorkerChoiceStrategy

    Returns void

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

    • Private checkValidWorkerChoiceStrategyOptions

    Returns void

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

    • Private chooseWorkerNode

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

    • Protected createAndSetupDynamicWorker

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

    • Protected createAndSetupWorker

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

    • Protected Abstract createWorker

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

    • Private dequeueTask

    Returns undefined | Task<Data>

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

    • destroy

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

    • Protected Abstract destroyWorker

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

    • enableTasksQueue

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

    • Private enqueueTask

    Returns number

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

    • execute

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

    • Private executeTask

    +

    Returns void

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

    • Private flushTasksQueue

    Returns void

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

    • Private flushTasksQueues

    -
    -

    Private getInitialWorkerInfo

    -
    -
    -

    Private getInitialWorkerUsage

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

    • Private getWorkerById

    -
    -

    Private getWorkerId

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

    • Private getWorkerInfo

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

    • Private getWorkerNodeKey

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

    • Private handleTaskExecutionResponse

    Returns void

    -
    -

    Private handleWorkerStartedMessage

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

    Private handleWorkerReadyResponse

    Returns void

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

    • Protected internalBusy

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

    • Protected Abstract isMain

    -
    -

    Private pushWorkerNode

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

    • Private redistributeQueuedTasks

    Returns void

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

    • Private registerWorkerMessageListener

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

    • Private removeWorkerNode

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

    • Protected Abstract sendToWorker

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

    Private sendWorkerStartupMessage

    +

    setTasksQueueOptions

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

    -
    -

    Private setWorkerNodeTasksUsage

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

    • Private setWorkerStatistics

    Returns void

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

    • Protected setupHook

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

    • Private shallCreateDynamicWorker

    -
    -

    Private tasksMaxQueueSize

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

    • Private tasksQueueSize

    Returns number

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

    • Private updateEluWorkerUsage

    Returns void

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

    • Private updateRunTimeWorkerUsage

    Returns void

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

    • Private updateTaskStatisticsWorkerUsage

    Returns void

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

    • Private updateWaitTimeWorkerUsage

    Returns void

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:1071
    • @@ -1253,6 +1242,7 @@ Can be overridden.

  • opts
  • promiseResponseMap
  • startTimestamp
    • +
  • starting
  • workerChoiceStrategyContext
  • workerNodes
  • busy
    • @@ -1260,15 +1250,19 @@ Can be overridden.

  • info
  • maxSize
  • minSize
    • +
  • ready
  • type
  • utilization
  • worker
    • +
  • addWorkerNode
  • afterTaskExecutionHook
  • afterWorkerSetup
  • beforeTaskExecutionHook
  • buildTasksQueueOptions
  • checkAndEmitEvents
    • +
  • checkDynamicPoolSize
  • checkFilePath
    • +
  • checkMessageWorkerId
  • checkNumberOfWorkers
  • checkPoolOptions
  • checkValidTasksQueueOptions
    • @@ -1287,29 +1281,24 @@ Can be overridden.

  • executeTask
  • flushTasksQueue
  • flushTasksQueues
    • -
  • getInitialWorkerInfo
    • -
  • getInitialWorkerUsage
  • getWorkerById
    • -
  • getWorkerId
  • getWorkerInfo
  • getWorkerNodeKey
  • handleTaskExecutionResponse
    • -
  • handleWorkerStartedMessage
    • +
  • handleWorkerReadyResponse
  • internalBusy
  • isMain
    • -
  • pushWorkerNode
  • redistributeQueuedTasks
  • registerWorkerMessageListener
  • removeWorkerNode
  • sendToWorker
    • +
  • sendWorkerStartupMessage
  • setTasksQueueOptions
  • setWorkerChoiceStrategy
  • setWorkerChoiceStrategyOptions
    • -
  • setWorkerNodeTasksUsage
  • setWorkerStatistics
  • setupHook
  • shallCreateDynamicWorker
    • -
  • tasksMaxQueueSize
  • tasksQueueSize
  • updateEluWorkerUsage
  • updateRunTimeWorkerUsage
    • @@ -1317,7 +1306,7 @@ Can be overridden.

  • updateWaitTimeWorkerUsage
  • workerListener
    • -