X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=c7e8d6be55d94a4688dfb99cbfdfef74f3ad3f0f;hb=ac2cb9e206b5e67cc52124eb334507f5dce230d5;hp=51fda18c1a4652e54b40f9dfbc94118aebd80073;hpb=71056a0ac555e096c1428d6341ef45c7980a6332;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index 51fda18c..c7e8d6be 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -29,12 +29,12 @@

  • Data = unknown

    -

    Type of data sent to the worker. This can only be serializable data.

    +

    Type of data sent to the worker. This can only be structured-cloneable data.

  • Response = unknown

    -

    Type of execution response. This can only be serializable data.

    +

    Type of execution response. This can only be structured-cloneable data.

    • @@ -49,7 +49,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:49
    • @@ -66,6 +66,7 @@ numberOfWorkers opts promiseResponseMap +startTimestamp workerChoiceStrategyContext workerNodes
    @@ -76,7 +77,9 @@ info maxSize minSize +runTime type +utilization worker
    @@ -92,7 +95,8 @@ checkValidTasksQueueOptions checkValidWorkerChoiceStrategy checkValidWorkerChoiceStrategyOptions -chooseWorkerNode +chooseWorkerNode +createAndSetupDynamicWorker createAndSetupWorker createWorker dequeueTask @@ -104,24 +108,31 @@ executeTask flushTasksQueue flushTasksQueues +getWorkerById +getWorkerId getWorkerNodeKey +getWorkerUsage +handleTaskExecutionResponse +handleWorkerStartedMessage internalBusy isMain pushWorkerNode -registerWorkerMessageListener +registerWorkerMessageListener removeWorkerNode sendToWorker setTasksQueueOptions setWorkerChoiceStrategy setWorkerChoiceStrategyOptions -setWorkerNode setWorkerNodeTasksUsage setWorkerStatistics setupHook +shallCreateDynamicWorker +tasksMaxQueueSize tasksQueueSize -updateEluTasksUsage -updateRunTimeTasksUsage -updateWaitTimeTasksUsage +updateEluWorkerUsage +updateRunTimeWorkerUsage +updateTaskStatisticsWorkerUsage +updateWaitTimeWorkerUsage workerListener
    @@ -137,7 +148,7 @@

    Type Parameters

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

    • Properties

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

    • Protected Readonly filePath

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

    • Protected Readonly numberOfWorkers

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

    • Protected Readonly opts

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

    • Protected promiseResponseMap

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

    Private Readonly startTimestamp

    +
    startTimestamp: number
    +

    The start timestamp of the pool.

    +
    +

    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:76

    • Readonly workerNodes

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

    • Accessors

    @@ -250,7 +268,7 @@

    Returns boolean

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

    • Protected full

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

    • info

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

    • Protected Abstract maxSize

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

    • Protected Abstract minSize

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

    Private runTime

    +

    Protected Abstract type

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

    Private utilization

    +

    Protected Abstract worker

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

    • Methods

    @@ -339,21 +381,21 @@ Can be overridden.

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

    The received message.

    • Returns void

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

    Protected Abstract afterWorkerSetup

    +

    Protected afterWorkerSetup

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

    • Protected beforeTaskExecutionHook

    Returns void

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

    • Private buildTasksQueueOptions

    Returns TasksQueueOptions

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

    • Private checkAndEmitEvents

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

    • Private checkFilePath

    Returns void

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

    • Private checkNumberOfWorkers

    Returns void

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

    • Private checkPoolOptions

    Returns void

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

    • Private checkValidTasksQueueOptions

    Returns void

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

    • Private checkValidWorkerChoiceStrategy

    Returns void

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

    • Private checkValidWorkerChoiceStrategyOptions

    Returns void

    -
    -

    Protected chooseWorkerNode

    -
    +
    +

    Private chooseWorkerNode

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

    Protected createAndSetupDynamicWorker

    +

    Protected createAndSetupWorker

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

    • Protected Abstract createWorker

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

    • Private dequeueTask

    Returns undefined | Task<Data>

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

    • destroy

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

    • Protected Abstract destroyWorker

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

    • enableTasksQueue

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

    • Private enqueueTask

    Returns number

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

    • execute

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

    • Private executeTask

    Returns void

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

    • Private flushTasksQueue

    Returns void

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

    • Private flushTasksQueues

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

    Private getWorkerById

    +
    +
    +

    Private getWorkerId

    +

    Private getWorkerNodeKey

    -

    Returns number

    The worker node key if the worker is found in the pool worker nodes, -1 otherwise.

    +

    Returns number

    The worker node key if found in the pool worker nodes, -1 otherwise.

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

    Private getWorkerUsage

    +
    +
    +

    Private handleTaskExecutionResponse

    +
    +
    +

    Private handleWorkerStartedMessage

    +

    Protected internalBusy

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

    • Protected Abstract isMain

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

    • Private pushWorkerNode

    -
    -

    Protected Abstract registerWorkerMessageListener

    -
    +
    +

    Private registerWorkerMessageListener

    +

    Returns void

    Returns void

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

    • Private removeWorkerNode

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

    • Protected Abstract sendToWorker

    Returns void

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

    • setTasksQueueOptions

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

    -
    -

    Private setWorkerNode

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

    • Private setWorkerNodeTasksUsage

    Returns void

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

    • Private setWorkerStatistics

    Returns void

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

    • Protected setupHook

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

    Private shallCreateDynamicWorker

    +
    +
    +

    Private tasksMaxQueueSize

    +

    Private tasksQueueSize

    Returns number

    -
    -

    Private updateEluTasksUsage

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

    Private updateEluWorkerUsage

    +
    +
    +

    Private updateRunTimeWorkerUsage

    Returns void

    -
    -

    Private updateRunTimeTasksUsage

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

    Private updateTaskStatisticsWorkerUsage

    Returns void

    -
    -

    Private updateWaitTimeTasksUsage

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

    Private updateWaitTimeWorkerUsage

    Returns void

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

    • Protected workerListener

    Returns void

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

    +
  • Defined in src/pools/abstract-pool.ts:815
    • @@ -1068,6 +1217,7 @@ Can be overridden

  • numberOfWorkers
  • opts
  • promiseResponseMap
    • +
  • startTimestamp
  • workerChoiceStrategyContext
  • workerNodes
  • busy
    • @@ -1075,7 +1225,9 @@ Can be overridden

  • info
  • maxSize
  • minSize
    • +
  • runTime
  • type
    • +
  • utilization
  • worker
  • afterTaskExecutionHook
  • afterWorkerSetup
    • @@ -1088,7 +1240,8 @@ Can be overridden

  • checkValidTasksQueueOptions
  • checkValidWorkerChoiceStrategy
  • checkValidWorkerChoiceStrategyOptions
    • -
  • chooseWorkerNode
    • +
  • chooseWorkerNode
    • +
  • createAndSetupDynamicWorker
  • createAndSetupWorker
  • createWorker
  • dequeueTask
    • @@ -1100,24 +1253,31 @@ Can be overridden

  • executeTask
  • flushTasksQueue
  • flushTasksQueues
    • +
  • getWorkerById
    • +
  • getWorkerId
  • getWorkerNodeKey
    • +
  • getWorkerUsage
    • +
  • handleTaskExecutionResponse
    • +
  • handleWorkerStartedMessage
  • internalBusy
  • isMain
  • pushWorkerNode
    • -
  • registerWorkerMessageListener
    • +
  • registerWorkerMessageListener
  • removeWorkerNode
  • sendToWorker
  • setTasksQueueOptions
  • setWorkerChoiceStrategy
  • setWorkerChoiceStrategyOptions
    • -
  • setWorkerNode
  • setWorkerNodeTasksUsage
  • setWorkerStatistics
  • setupHook
    • +
  • shallCreateDynamicWorker
    • +
  • tasksMaxQueueSize
  • tasksQueueSize
    • -
  • updateEluTasksUsage
    • -
  • updateRunTimeTasksUsage
    • -
  • updateWaitTimeTasksUsage
    • +
  • updateEluWorkerUsage
    • +
  • updateRunTimeWorkerUsage
    • +
  • updateTaskStatisticsWorkerUsage
    • +
  • updateWaitTimeWorkerUsage
  • workerListener
    • +
  • WorkerTypes
    • +
  • availableParallelism

    • Generated using TypeDoc

    \ No newline at end of file