X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicClusterPool.html;h=b8ddba0c1dcc0ef39549ef7cedfacdbe7e9a64e8;hb=70353024c44987c467dadcec306c699ce4ae1f06;hp=53242a4961ac606d00edf78b736aea361a0beb91;hpb=938d9c678aa8e70e5642feffb90604cf25c993fe;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index 53242a49..b8ddba0c 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
    @@ -102,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

    @@ -142,11 +143,12 @@ When the maximum number of workers is reached and workers are busy, an event is
    • 'full': Emitted when the pool is dynamic and full.
    • 'busy': Emitted when the pool is busy.
      • +
    • 'error': Emitted when an error occurs.
    +
  • Defined in src/pools/abstract-pool.ts:44

    • Readonly filePath

    filePath: string
    @@ -154,14 +156,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
    @@ -169,7 +171,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 = {}
    @@ -177,7 +179,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>> = ...
    @@ -190,7 +192,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>
    @@ -199,7 +201,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>[] = []
    @@ -207,7 +209,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

    @@ -221,7 +223,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:230

    • Private numberOfRunningTasks

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

    size

    +

    type

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

    • Methods

    @@ -286,13 +299,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:430

    • Protected afterWorkerSetup

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

    • Protected beforeTaskExecutionHook

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

    • Protected chooseWorkerNode

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

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

    • destroy

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

    • Protected destroyWorker

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

    • enableTasksQueue

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

    • execute

    -

    Returns Promise<Response>

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

    • Protected internalBusy

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

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • 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:594
    • @@ -650,6 +662,7 @@ Can be overridden

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

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

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