X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=7806afafcb178b8bbc6d42415b006abc25d90b0a;hb=44b3657c414ad850ef46d6b7c13a48ab3130cb32;hp=51fda18c1a4652e54b40f9dfbc94118aebd80073;hpb=71056a0ac555e096c1428d6341ef45c7980a6332;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index 51fda18c..7806afaf 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -49,7 +49,7 @@ +
  • Defined in src/pools/abstract-pool.ts:45
    • @@ -92,7 +92,8 @@ checkValidTasksQueueOptions checkValidWorkerChoiceStrategy checkValidWorkerChoiceStrategyOptions -chooseWorkerNode +chooseWorkerNode +createAndSetupDynamicWorker createAndSetupWorker createWorker dequeueTask @@ -104,7 +105,9 @@ executeTask flushTasksQueue flushTasksQueues +getTaskStatistics getWorkerNodeKey +getWorkerUsage internalBusy isMain pushWorkerNode @@ -114,14 +117,15 @@ setTasksQueueOptions setWorkerChoiceStrategy setWorkerChoiceStrategyOptions -setWorkerNode setWorkerNodeTasksUsage setWorkerStatistics setupHook +shallCreateDynamicWorker tasksQueueSize -updateEluTasksUsage -updateRunTimeTasksUsage -updateWaitTimeTasksUsage +updateEluWorkerUsage +updateRunTimeWorkerUsage +updateTaskStatisticsWorkerUsage +updateWaitTimeWorkerUsage workerListener
    @@ -163,7 +167,7 @@

    Returns AbstractPool<Worker, Data, Response>

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

    • Properties

    @@ -181,7 +185,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:54

    • Protected Readonly filePath

    filePath: string
    @@ -189,7 +193,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:87

    • Protected Readonly numberOfWorkers

    numberOfWorkers: number
    @@ -197,7 +201,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:86

    • Protected Readonly opts

    opts: PoolOptions<Worker>
    @@ -205,7 +209,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:88

    • Protected promiseResponseMap

    promiseResponseMap: Map<string, PromiseResponseWrapper<Worker, Response>> = ...
    @@ -218,16 +222,15 @@
    +
  • Defined in src/pools/abstract-pool.ts:64

    • Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>

    Worker choice strategy context referencing a worker choice algorithm implementation.

    -

    Default to a round robin algorithm.

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

    • Readonly workerNodes

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

    • Accessors

    @@ -250,7 +253,7 @@

    Returns boolean

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

    • Protected full

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

    • info

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

    • Protected Abstract maxSize

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

    • Protected Abstract minSize

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

    • Protected Abstract type

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

    • Protected Abstract worker

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

    • Methods

    @@ -339,14 +342,14 @@ Can be overridden.

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

    The received message.

    • Returns void

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

    • Protected Abstract afterWorkerSetup

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

    • Protected beforeTaskExecutionHook

    Returns void

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

    • Private buildTasksQueueOptions

    Returns TasksQueueOptions

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

    • Private checkAndEmitEvents

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

    • Private checkFilePath

    Returns void

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

    • Private checkNumberOfWorkers

    Returns void

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

    • Private checkPoolOptions

    Returns void

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

    • Private checkValidTasksQueueOptions

    Returns void

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

    • Private checkValidWorkerChoiceStrategy

    Returns void

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

    • Private checkValidWorkerChoiceStrategyOptions

    Returns void

    -
    -

    Protected chooseWorkerNode

    -
    +
    +

    Private chooseWorkerNode

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

    Protected createAndSetupDynamicWorker

    +

    Protected createAndSetupWorker

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

    • Protected Abstract createWorker

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

    • Private dequeueTask

    Returns undefined | Task<Data>

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

    • destroy

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

    • Protected Abstract destroyWorker

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

    • enableTasksQueue

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

    • Private enqueueTask

    Returns number

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

    • execute

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

    • Private executeTask

    Returns void

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

    • Private flushTasksQueue

    Returns void

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

    • Private flushTasksQueues

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

    Private getTaskStatistics

    +

    Private getWorkerNodeKey

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

    Private getWorkerUsage

    +

    Protected internalBusy

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

    • Protected Abstract isMain

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

    • Private pushWorkerNode

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

    • Protected Abstract registerWorkerMessageListener

    Returns void

    Returns void

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

    • Private removeWorkerNode

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

    • Protected Abstract sendToWorker

    Returns void

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

    • setTasksQueueOptions

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

    -
    -

    Private setWorkerNode

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

    • Private setWorkerNodeTasksUsage

    Returns void

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

    • Private setWorkerStatistics

    Returns void

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

    • Protected setupHook

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

    Private shallCreateDynamicWorker

    +

    Private tasksQueueSize

    Returns number

    -
    -

    Private updateEluTasksUsage

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

    Private updateEluWorkerUsage

    +
    +
    +

    Private updateRunTimeWorkerUsage

    Returns void

    -
    -

    Private updateRunTimeTasksUsage

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

    Private updateTaskStatisticsWorkerUsage

    Returns void

    -
    -

    Private updateWaitTimeTasksUsage

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

    Private updateWaitTimeWorkerUsage

    Returns void

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

    • Protected workerListener

    Returns void

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

    +
  • Defined in src/pools/abstract-pool.ts:741
    • @@ -1088,7 +1132,8 @@ Can be overridden

  • checkValidTasksQueueOptions
  • checkValidWorkerChoiceStrategy
  • checkValidWorkerChoiceStrategyOptions
    • -
  • chooseWorkerNode
    • +
  • chooseWorkerNode
    • +
  • createAndSetupDynamicWorker
  • createAndSetupWorker
  • createWorker
  • dequeueTask
    • @@ -1100,7 +1145,9 @@ Can be overridden

  • executeTask
  • flushTasksQueue
  • flushTasksQueues
    • +
  • getTaskStatistics
  • getWorkerNodeKey
    • +
  • getWorkerUsage
  • internalBusy
  • isMain
  • pushWorkerNode
    • @@ -1110,14 +1157,15 @@ Can be overridden

  • setTasksQueueOptions
  • setWorkerChoiceStrategy
  • setWorkerChoiceStrategyOptions
    • -
  • setWorkerNode
  • setWorkerNodeTasksUsage
  • setWorkerStatistics
  • setupHook
    • +
  • shallCreateDynamicWorker
  • tasksQueueSize
    • -
  • updateEluTasksUsage
    • -
  • updateRunTimeTasksUsage
    • -
  • updateWaitTimeTasksUsage
    • +
  • updateEluWorkerUsage
    • +
  • updateRunTimeWorkerUsage
    • +
  • updateTaskStatisticsWorkerUsage
    • +
  • updateWaitTimeWorkerUsage
  • workerListener