X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=0fbaae35c5292e27c894015d86e3dca4f3c753e8;hb=1ab50fe5ad0b27a13a48047f9414d4138d43a5cd;hp=4a399b49991b2af364cf7c25c8cc38b57d69c1d4;hpb=2c94c3a5da9d6b4a0ac992386907d8a406ee38f7;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index 4a399b49..0fbaae35 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -45,7 +45,7 @@ +
  • Defined in src/pools/abstract-pool.ts:38
    • @@ -58,9 +58,9 @@

    Properties

    emitter? -filePath -numberOfWorkers -opts +filePath +numberOfWorkers +opts promiseResponseMap workerChoiceStrategyContext workerNodes @@ -69,10 +69,11 @@

    Accessors

    busy full -numberOfQueuedTasks -numberOfRunningTasks -size -type +info +maxSize +minSize +type +worker

    Methods

    @@ -113,6 +114,8 @@ setWorkerNodeTasksUsage setupHook tasksQueueSize +updateRunTimeTasksUsage +updateWaitTimeTasksUsage workerListener
    @@ -150,7 +153,7 @@

    Returns AbstractPool<Worker, Data, Response>

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

    • Properties

    @@ -161,32 +164,34 @@
    -
    -

    Readonly filePath

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

    Protected Readonly filePath

    filePath: string

    Path to the worker file.

    -
    -

    Readonly numberOfWorkers

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

    Protected Readonly numberOfWorkers

    numberOfWorkers: number

    Number of workers that this pool should manage.

    -
    -

    Readonly opts

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

    Protected Readonly opts

    opts: PoolOptions<Worker>

    Options for the pool.

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

    • Protected promiseResponseMap

    promiseResponseMap: Map<string, PromiseResponseWrapper<Worker, Response>> = ...
    @@ -198,7 +203,7 @@

    When we receive a message from the worker, we get a map entry with the promise resolve/reject bound to the message id.

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

    • Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -206,7 +211,7 @@

    Default to a round robin algorithm.

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

    • Readonly workerNodes

    workerNodes: WorkerNode<Worker, Data>[] = []
    @@ -214,7 +219,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:44

    • Accessors

    @@ -227,9 +232,9 @@

    Returns boolean

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

    Protected Abstract full

    +

    Protected full

    -
    -

    Private numberOfQueuedTasks

    -
    +
    +

    info

    +
    -
    -

    Private numberOfRunningTasks

    -
    +
    +

    Protected Abstract maxSize

    +
    -
    -

    Abstract size

    -
    +
    +

    Protected Abstract minSize

    +
    -
    -

    Abstract type

    -
    +
    +

    Protected Abstract type

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

    Protected Abstract worker

    +

    Methods

    @@ -305,7 +319,7 @@ Can be overridden.

    Returns void

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

    • Protected Abstract afterWorkerSetup

    Returns void

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

    • Protected beforeTaskExecutionHook

    Returns void

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

    • Private buildTasksQueueOptions

    Returns TasksQueueOptions

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

    • Private checkAndEmitEvents

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

    • Private checkFilePath

    Returns void

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

    • Private checkNumberOfWorkers

    Returns void

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

    • Private checkPoolOptions

    Returns void

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

    • Private checkValidTasksQueueOptions

    Returns void

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

    • Private checkValidWorkerChoiceStrategy

    Returns void

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

    • Private checkValidWorkerChoiceStrategyOptions

    Returns void

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

    • Protected chooseWorkerNode

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

    • Protected createAndSetupWorker

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

    • Protected Abstract createWorker

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

    • Private dequeueTask

    Returns undefined | Task<Data>

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

    • destroy

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

    • Protected Abstract destroyWorker

    Returns void | Promise<void>

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

    • enableTasksQueue

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

    • Private enqueueTask

    Returns number

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

    • execute

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

    • Private executeTask

    Returns void

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

    • Private flushTasksQueue

    Returns void

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

    • Private flushTasksQueues

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

    • Private getWorkerNodeKey

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

    • Protected internalBusy

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

    • Protected Abstract isMain

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

    • Private pushWorkerNode

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

    • Protected Abstract registerWorkerMessageListener

    Returns void

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

    • Private removeWorkerNode

    Returns void

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

    • Protected Abstract sendToWorker

    Returns void

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

    • setTasksQueueOptions

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Private setWorkerNode

    Returns void

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

    • Private setWorkerNodeTasksUsage

    Returns void

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

    • Protected setupHook

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

    • Private tasksQueueSize

    Returns number

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

    Private updateRunTimeTasksUsage

    +
    +
    +

    Private updateWaitTimeTasksUsage

    +

    Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:629
    • @@ -918,18 +962,19 @@ Can be overridden

    +
  • PoolTypes
    • +
  • WorkerChoiceStrategies
    • +
  • WorkerTypes

    • Generated using TypeDoc

    \ No newline at end of file