X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=bbb0411cfc7d34ca0df13f48a05e18118c24dd02;hb=811dc01fd8bb1b23cc3e6e72f7fbc82cc8f473ae;hp=9d036250cfb4de01d165071d5ed05b94edc57204;hpb=749e1fa387ba832c85f789337b3c2e679331cb64;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index 9d036250..bbb0411c 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -45,7 +45,7 @@ +
  • Defined in src/pools/abstract-pool.ts:35
    • @@ -71,6 +71,7 @@ full numberOfQueuedTasks numberOfRunningTasks +size type
    @@ -85,6 +86,7 @@ checkPoolOptions checkValidTasksQueueOptions checkValidWorkerChoiceStrategy +checkValidWorkerChoiceStrategyOptions chooseWorkerNode createAndSetupWorker createWorker @@ -96,10 +98,8 @@ execute executeTask flushTasksQueue -flushTasksQueueByWorker flushTasksQueues getWorkerNodeKey -getWorkerTasksUsage internalBusy isMain pushWorkerNode @@ -113,6 +113,8 @@ setWorkerNodeTasksUsage setupHook tasksQueueSize +updateRunTimeTasksUsage +updateWaitTimeTasksUsage workerListener
    @@ -150,7 +152,7 @@

    Returns AbstractPool<Worker, Data, Response>

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

    • Properties

    @@ -165,28 +167,28 @@
    +
  • Defined in src/pools/abstract-pool.ts:44

    • Readonly filePath

    filePath: string

    Path to the worker file.

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

    • Readonly numberOfWorkers

    numberOfWorkers: number

    Number of workers that this pool should manage.

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

    • Readonly opts

    opts: PoolOptions<Worker>

    Options for the pool.

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

    • Protected promiseResponseMap

    promiseResponseMap: Map<string, PromiseResponseWrapper<Worker, Response>> = ...
    @@ -198,7 +200,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:54

    • Protected workerChoiceStrategyContext

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

    Default to a round robin algorithm.

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

    • Readonly workerNodes

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

    • Accessors

    @@ -227,7 +229,7 @@

    Returns boolean

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

    • Protected Abstract full

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

    • Private numberOfQueuedTasks

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

    • Private numberOfRunningTasks

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

    Abstract size

    +

    Abstract type

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

    • Methods

    @@ -289,12 +302,12 @@ Can be overridden.

    The worker.

  • -
    message: MessageValue<Response, unknown>
    +
    message: MessageValue<Response, Worker | MessagePort>

    The received message.

    • Returns void

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

    • Protected Abstract afterWorkerSetup

    Returns void

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

    • Protected beforeTaskExecutionHook

    Returns void

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

    • Private buildTasksQueueOptions

    Returns TasksQueueOptions

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

    • Private checkAndEmitEvents

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

    • Private checkFilePath

    Returns void

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

    • Private checkNumberOfWorkers

    Returns void

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

    • Private checkPoolOptions

    Returns void

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

    • Private checkValidTasksQueueOptions

    Returns void

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

    • Private checkValidWorkerChoiceStrategy

    +

    Returns void

    +
    +

    Private checkValidWorkerChoiceStrategyOptions

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

    • Protected chooseWorkerNode

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

    • Protected createAndSetupWorker

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

    • Protected Abstract createWorker

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

    • Private dequeueTask

    Returns undefined | Task<Data>

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

    • destroy

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

    • Protected Abstract destroyWorker

    Returns void | Promise<void>

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

    • enableTasksQueue

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

    • Private enqueueTask

    Returns number

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

    • execute

    Returns Promise<Response>

    Promise that will be fulfilled when the task is completed.

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

    • Private executeTask

    Returns void

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

    • Private flushTasksQueue

    Returns void

    -
    -

    Private flushTasksQueueByWorker

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

    • Private flushTasksQueues

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

    • Private getWorkerNodeKey

    -
    -

    Private getWorkerTasksUsage

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

    • Protected internalBusy

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

    • Protected Abstract isMain

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

    • Private pushWorkerNode

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

    • Protected Abstract registerWorkerMessageListener

    Returns void

    Returns void

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

    • Private removeWorkerNode

    Returns void

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

    • Protected Abstract sendToWorker

    Returns void

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

    • setTasksQueueOptions

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Private setWorkerNode

    Returns void

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

    • Private setWorkerNodeTasksUsage

    Returns void

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

    • Protected setupHook

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

    • Private tasksQueueSize

    Returns number

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

    Private updateRunTimeTasksUsage

    +
    +
    +

    Private updateWaitTimeTasksUsage

    +

    Protected workerListener

    Returns void

    The listener function to execute when a message is received from a worker.

    +
  • Defined in src/pools/abstract-pool.ts:583
    • @@ -933,6 +960,7 @@ Can be overridden

  • full
  • numberOfQueuedTasks
  • numberOfRunningTasks
    • +
  • size
  • type
  • afterTaskExecutionHook
  • afterWorkerSetup
    • @@ -944,6 +972,7 @@ Can be overridden

  • checkPoolOptions
  • checkValidTasksQueueOptions
  • checkValidWorkerChoiceStrategy
    • +
  • checkValidWorkerChoiceStrategyOptions
  • chooseWorkerNode
  • createAndSetupWorker
  • createWorker
    • @@ -955,10 +984,8 @@ Can be overridden

  • execute
  • executeTask
  • flushTasksQueue
    • -
  • flushTasksQueueByWorker
  • flushTasksQueues
  • getWorkerNodeKey
    • -
  • getWorkerTasksUsage
  • internalBusy
  • isMain
  • pushWorkerNode
    • @@ -972,6 +999,8 @@ Can be overridden

  • setWorkerNodeTasksUsage
  • setupHook
  • tasksQueueSize
    • +
  • updateRunTimeTasksUsage
    • +
  • updateWaitTimeTasksUsage
  • workerListener