X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicClusterPool.html;h=9686cbdfedd2260879658dd96617f36e37f23451;hb=493f77bdef6d66ad2fcb72b405c805274b24f3db;hp=e4dbfd435746fd91fd3246ad80c00871eef639ad;hpb=8d1797ad15cb2d87ac3c9904ce6df3db45c0c742;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index e4dbfd43..9686cbdf 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -24,9 +24,9 @@ When the maximum number of workers is reached and workers are busy, an event is

Since

2.0.0

-
+

Type Parameters

-
+
  • Defined in src/pools/cluster/dynamic.ts:16
    • @@ -69,6 +69,7 @@ When the maximum number of workers is reached and workers are busy, an event is full numberOfQueuedTasks numberOfRunningTasks +size type
    @@ -83,7 +84,6 @@ When the maximum number of workers is reached and workers are busy, an event is destroyWorker enableTasksQueue execute -findFreeWorkerNodeKey internalBusy isMain registerWorkerMessageListener @@ -103,9 +103,9 @@ When the maximum number of workers is reached and workers are busy, an event is

  • Constructs a new poolifier dynamic cluster pool.

    -
    +

    Type Parameters

    -
    +
  • Defined in src/pools/cluster/dynamic.ts:28

    • Properties

    @@ -147,7 +147,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:44

    • Readonly filePath

    filePath: string
    @@ -155,14 +155,14 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:79

    • Readonly max

    max: number

    Maximum number of workers that can be created by this pool.

    +
  • Defined in src/pools/cluster/dynamic.ts:30

    • Readonly numberOfWorkers

    numberOfWorkers: number
    @@ -170,7 +170,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:78

    • Readonly opts

    opts: ClusterPoolOptions = {}
    @@ -178,7 +178,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/cluster/fixed.ts:53

    • Protected promiseResponseMap

    promiseResponseMap: Map<string, PromiseResponseWrapper<Worker, Response>> = ...
    @@ -191,7 +191,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:54

    • Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -200,7 +200,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:64

    • Readonly workerNodes

    workerNodes: WorkerNode<Worker, Data>[] = []
    @@ -208,7 +208,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:41

    • Accessors

    @@ -222,7 +222,7 @@ When the maximum number of workers is reached and workers are busy, an event is

    Returns boolean

    +
  • Defined in src/pools/cluster/dynamic.ts:53

    • Protected full

    +
  • Defined in src/pools/cluster/dynamic.ts:48

    • Private numberOfQueuedTasks

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

    • Private numberOfRunningTasks

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

    size

    +

    type

    +
  • Defined in src/pools/cluster/dynamic.ts:38

    • Methods

    @@ -287,13 +298,13 @@ 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 afterWorkerSetup

    +
  • Defined in src/pools/cluster/fixed.ts:93

    • Protected beforeTaskExecutionHook

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

    • Protected chooseWorkerNode

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

    +
  • Defined in src/pools/cluster/fixed.ts:88

    • destroy

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

    • Protected destroyWorker

    +
  • Defined in src/pools/cluster/fixed.ts:69

    • enableTasksQueue

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

    • execute

    -

    Returns Promise<Response>

    -
    -

    findFreeWorkerNodeKey

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

    • Protected internalBusy

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

    • Protected isMain

    +
  • Defined in src/pools/cluster/fixed.ts:64

    • Protected registerWorkerMessageListener

    Returns void

    Returns void

    +
  • Defined in src/pools/cluster/fixed.ts:80

    • Protected sendToWorker

    Returns void

    +
  • Defined in src/pools/cluster/fixed.ts:75

    • 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

    • Protected setupHook

    +
  • Defined in src/pools/cluster/fixed.ts:59

    • Protected workerListener

    +

    Returns void

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

    +
    +
  • Defined in src/pools/abstract-pool.ts:543
    • @@ -666,6 +661,7 @@ Can be overridden

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

  • destroyWorker
  • enableTasksQueue
  • execute
    • -
  • findFreeWorkerNodeKey
  • internalBusy
  • isMain
  • registerWorkerMessageListener
    • @@ -700,6 +695,7 @@ Can be overridden

  • FixedClusterPool
  • FixedThreadPool
  • PoolEmitter
    • +
  • Queue
  • ThreadWorker
  • WorkerChoiceStrategyContext
  • ClusterPoolOptions
    • @@ -723,6 +719,7 @@ Can be overridden

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