X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=8d13cb40dbb9a8fc843deb4adab8c4e4846af6aa;hb=dab8c377b70fc962ec217f2aeb719842f9f94cd6;hp=df41d32e1ed196c8493a9e4b8c3805233829cecc;hpb=1e8c193fa4e519921b6db1b0d9d443cb15ecf12a;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index df41d32e..8d13cb40 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 @@ -150,7 +150,7 @@

    Returns AbstractPool<Worker, Data, Response>

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

    • Properties

    @@ -165,28 +165,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 +198,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 +206,7 @@

    Default to a round robin algorithm.

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

    • Readonly workerNodes

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

    • Accessors

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

    Returns boolean

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

    • Protected Abstract full

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

    • 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 +300,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:423

    • Protected Abstract afterWorkerSetup

    Returns void

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

    • Protected beforeTaskExecutionHook

    Returns void

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

    • Private buildTasksQueueOptions

    Returns TasksQueueOptions

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

    • Private checkAndEmitEvents

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

    • 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

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

    Private checkValidWorkerChoiceStrategyOptions

    +

    Protected chooseWorkerNode

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

    • Protected createAndSetupWorker

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

    • Protected Abstract createWorker

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

    • Private dequeueTask

    Returns undefined | Task<Data>

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

    • destroy

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

    • Protected Abstract destroyWorker

    Returns void | Promise<void>

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

    • enableTasksQueue

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

    • Private enqueueTask

    Returns number

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

    • execute

    Returns Promise<Response>

    Promise that will be fulfilled when the task is completed.

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

    • Private executeTask

    Returns void

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

    • Private flushTasksQueue

    Returns void

    -
    -

    Private flushTasksQueueByWorker

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

    • Private flushTasksQueues

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

    • Private getWorkerNodeKey

    -
    -

    Private getWorkerTasksUsage

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

    • Protected internalBusy

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

    • Protected Abstract isMain

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

    • Private pushWorkerNode

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

    • Protected Abstract registerWorkerMessageListener

    Returns void

    Returns void

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

    • Private removeWorkerNode

    Returns void

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

    • Protected Abstract sendToWorker

    Returns void

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

    • setTasksQueueOptions

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Private setWorkerNode

    Returns void

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

    • Private setWorkerNodeTasksUsage

    Returns void

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

    • Protected setupHook

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

    • Private tasksQueueSize

    Returns number

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

    • Protected workerListener

    Returns void

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

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

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

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

  • execute
  • executeTask
  • flushTasksQueue
    • -
  • flushTasksQueueByWorker
  • flushTasksQueues
  • getWorkerNodeKey
    • -
  • getWorkerTasksUsage
  • internalBusy
  • isMain
  • pushWorkerNode
    • @@ -1010,6 +1005,7 @@ Can be overridden

  • MessageHandler
  • OnlineHandler
  • PoolEvent
    • +
  • TaskFunctions
  • ThreadWorkerWithMessageChannel
  • WorkerAsyncFunction
  • WorkerChoiceStrategy