X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=bfa752b016c70c08f6c19489ac441859b48808f9;hb=d5d8ef5b0645ff2e43010f981a768c48cd559854;hp=d511387dbbebd301fc246fdb7819922b9de6bd6a;hpb=f45a3823ad04902b4c446c7c7de55ca183041953;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index d511387d..bfa752b0 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:46
    • @@ -92,7 +92,8 @@ checkValidTasksQueueOptions checkValidWorkerChoiceStrategy checkValidWorkerChoiceStrategyOptions -chooseWorkerNode +chooseWorkerNode +createAndSetupDynamicWorker createAndSetupWorker createWorker dequeueTask @@ -105,23 +106,26 @@ flushTasksQueue flushTasksQueues getWorkerNodeKey +getWorkerUsage 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
    @@ -163,7 +167,7 @@

    Returns AbstractPool<Worker, Data, Response>

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

    • Properties

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

    • Protected Readonly filePath

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

    • Protected Readonly numberOfWorkers

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

    • Protected Readonly opts

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

    • Protected promiseResponseMap

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

    • 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:73

    • Readonly workerNodes

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

    • Accessors

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

    Returns boolean

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

    • Protected full

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

    • info

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

    • Protected Abstract maxSize

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

    • Protected Abstract minSize

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

    • Protected Abstract type

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

    • Protected Abstract worker

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

    • Methods

    @@ -339,21 +342,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:506
    • -

    Protected Abstract afterWorkerSetup

    +

    Protected afterWorkerSetup

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

    • Protected beforeTaskExecutionHook

    Returns void

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

    • Private buildTasksQueueOptions

    Returns TasksQueueOptions

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

    • Private checkAndEmitEvents

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

    • Private checkFilePath

    Returns void

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

    • Private checkNumberOfWorkers

    Returns void

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

    • Private checkPoolOptions

    Returns void

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

    • Private checkValidTasksQueueOptions

    Returns void

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

    • Private checkValidWorkerChoiceStrategy

    Returns void

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

    • Private checkValidWorkerChoiceStrategyOptions

    Returns void

    -
    -

    Protected chooseWorkerNode

    -
    +
    +

    Private chooseWorkerNode

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

    Protected createAndSetupDynamicWorker

    +

    Protected createAndSetupWorker

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

    • Protected Abstract createWorker

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

    • Private dequeueTask

    Returns undefined | Task<Data>

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

    • destroy

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

    • Protected Abstract destroyWorker

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

    • enableTasksQueue

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

    • Private enqueueTask

    Returns number

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

    • execute

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

    • Private executeTask

    Returns void

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

    • Private flushTasksQueue

    Returns void

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

    • Private flushTasksQueues

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

    • Private getWorkerNodeKey

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

    Private getWorkerUsage

    +

    Protected internalBusy

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

    • Protected Abstract isMain

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

    • Private pushWorkerNode

    -
    -

    Protected Abstract registerWorkerMessageListener

    -
    +
    +

    Private registerWorkerMessageListener

    +

    Returns void

    Returns void

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

    • Private removeWorkerNode

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

    • Protected Abstract sendToWorker

    Returns void

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

    • setTasksQueueOptions

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

    -
    -

    Private setWorkerNode

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

    • Private setWorkerNodeTasksUsage

    Returns void

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

    • Private setWorkerStatistics

    Returns void

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

    • Protected setupHook

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

    Private shallCreateDynamicWorker

    +
    +
    +

    Private tasksMaxQueueSize

    +

    Private tasksQueueSize

    Returns number

    -
    -

    Private updateEluTasksUsage

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

    Private updateEluWorkerUsage

    Returns void

    -
    -

    Private updateRunTimeTasksUsage

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

    Private updateRunTimeWorkerUsage

    Returns void

    -
    -

    Private updateWaitTimeTasksUsage

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

    Private updateTaskStatisticsWorkerUsage

    +

    Returns void

    +
    +

    Private updateWaitTimeWorkerUsage

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

    • Protected workerListener

    Returns void

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

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

  • checkValidTasksQueueOptions
  • checkValidWorkerChoiceStrategy
  • checkValidWorkerChoiceStrategyOptions
    • -
  • chooseWorkerNode
    • +
  • chooseWorkerNode
    • +
  • createAndSetupDynamicWorker
  • createAndSetupWorker
  • createWorker
  • dequeueTask
    • @@ -1101,23 +1146,26 @@ Can be overridden

  • flushTasksQueue
  • flushTasksQueues
  • getWorkerNodeKey
    • +
  • getWorkerUsage
  • 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