X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=47a0a827782a198519d53d82dfc98c9862be0784;hb=ef9f489c870680b9a754ab8e5b142b3f042a9ebb;hp=8fe5465a5779a9b05f3f4b5f14d45f5c6722595d;hpb=c2d2417cb80d8c14637fe6a19d58bcf5ce18ae98;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index 8fe5465a..47a0a827 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -1,4 +1,4 @@ -AbstractPool | poolifier - v2.6.9
+AbstractPool | poolifier - v2.6.12
  • Preparing search index...
    • -
  • The search index is not available
poolifier - v2.6.9
+
  • 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:53
    • @@ -77,6 +77,8 @@ info maxSize minSize +ready +starting type utilization worker @@ -88,7 +90,9 @@ beforeTaskExecutionHook buildTasksQueueOptions checkAndEmitEvents +checkDynamicPoolSize checkFilePath +checkMessageWorkerId checkNumberOfWorkers checkPoolOptions checkValidTasksQueueOptions @@ -111,7 +115,7 @@ getWorkerInfo getWorkerNodeKey handleTaskExecutionResponse -handleWorkerStartedMessage +handleWorkerReadyMessage internalBusy isMain pushWorkerNode @@ -171,7 +175,7 @@

    Returns AbstractPool<Worker, Data, Response>

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

    • Properties

    @@ -180,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.
    @@ -189,7 +194,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:62

    • Protected Readonly filePath

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

    • Protected Readonly numberOfWorkers

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

    • Protected Readonly opts

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

    • Protected promiseResponseMap

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

    • Private Readonly startTimestamp

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

    • Protected workerChoiceStrategyContext

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

    • Readonly workerNodes

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

    • Accessors

    @@ -265,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

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

    • Protected Abstract worker

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

    • Methods

    @@ -373,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

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

    • Private getWorkerInfo

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

    • Private getWorkerNodeKey

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

    • Private handleTaskExecutionResponse

    Returns void

    -
    -

    Private handleWorkerStartedMessage

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

    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

    Returns void

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

    • 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

    +
  • 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

    +
  • 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
    • @@ -1172,6 +1221,8 @@ Can be overridden.

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

  • beforeTaskExecutionHook
  • buildTasksQueueOptions
  • checkAndEmitEvents
    • +
  • checkDynamicPoolSize
  • checkFilePath
    • +
  • checkMessageWorkerId
  • checkNumberOfWorkers
  • checkPoolOptions
  • checkValidTasksQueueOptions
    • @@ -1203,7 +1256,7 @@ Can be overridden.

  • getWorkerInfo
  • getWorkerNodeKey
  • handleTaskExecutionResponse
    • -
  • handleWorkerStartedMessage
    • +
  • handleWorkerReadyMessage
  • internalBusy
  • isMain
  • pushWorkerNode
    • @@ -1224,7 +1277,7 @@ Can be overridden.

  • updateWaitTimeWorkerUsage
  • workerListener
    • -