X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicThreadPool.html;h=35dd313b267e7d2887550439a3f9574075b9285b;hb=15e4d8f3cafe9f7412913b0e440921e813bdf3cd;hp=ae040b5bac053f4e71861c20b2c062425c9de990;hpb=3bd6a82e43e11294af91bbd19647944ac740169e;p=poolifier.git diff --git a/docs/classes/DynamicThreadPool.html b/docs/classes/DynamicThreadPool.html index ae040b5b..35dd313b 100644 --- a/docs/classes/DynamicThreadPool.html +++ b/docs/classes/DynamicThreadPool.html @@ -38,11 +38,11 @@ When the maximum number of threads is reached and workers are busy, an event is

Hierarchy

+
  • Defined in src/pools/thread/dynamic.ts:17
  • @@ -83,7 +83,6 @@ When the maximum number of threads is reached and workers are busy, an event is destroyWorker enableTasksQueue execute -findFreeWorkerNodeKey internalBusy isMain registerWorkerMessageListener @@ -99,7 +98,7 @@ When the maximum number of threads is reached and workers are busy, an event is
      - +
    • Constructs a new poolifier dynamic thread pool.

      @@ -126,18 +125,18 @@ When the maximum number of threads is reached and workers are busy, an event is

      Path to an implementation of a ThreadWorker file, which can be relative or absolute.

    • -
      opts: PoolOptions<ThreadWorkerWithMessageChannel> = {}
      +
      opts: PoolOptions<ThreadWorkerWithMessageChannel> = {}

      Options for this dynamic thread pool.

    -

    Returns DynamicThreadPool<Data, Response>

    +
  • Defined in src/pools/thread/dynamic.ts:29
  • Properties

    -
    emitter?: PoolEmitter
    +
    emitter?: PoolEmitter

    Emitter on which events can be listened to.

    Events that can currently be listened to:

      @@ -147,41 +146,41 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:42
  • -
    filePath: string
    +
    filePath: string

    Path to the worker file.

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

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

    +
  • Defined in src/pools/thread/dynamic.ts:31
  • -
    numberOfWorkers: number
    +
    numberOfWorkers: number

    Number of workers that this pool should manage.

    +
  • Defined in src/pools/abstract-pool.ts:76
  • -
    opts: PoolOptions<ThreadWorkerWithMessageChannel>
    +
    opts: PoolOptions<ThreadWorkerWithMessageChannel>

    Options for the pool.

    +
  • Defined in src/pools/abstract-pool.ts:78
  • -
    promiseResponseMap: Map<string, PromiseResponseWrapper<ThreadWorkerWithMessageChannel, Response>> = ...
    +
    promiseResponseMap: Map<string, PromiseResponseWrapper<ThreadWorkerWithMessageChannel, Response>> = ...

    The execution response promise map.

    +
  • Defined in src/pools/abstract-pool.ts:52
  • -
    workerChoiceStrategyContext: WorkerChoiceStrategyContext<ThreadWorkerWithMessageChannel, Data, Response>
    +
    workerChoiceStrategyContext: WorkerChoiceStrategyContext<ThreadWorkerWithMessageChannel, 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:62
  • -
    workerNodes: WorkerNode<ThreadWorkerWithMessageChannel, Data>[] = []
    +
    workerNodes: WorkerNode<ThreadWorkerWithMessageChannel, Data>[] = []

    Pool worker nodes.

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

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

    Returns boolean

    +
  • Defined in src/pools/thread/dynamic.ts:49
  • +
  • Defined in src/pools/thread/dynamic.ts:44
  • +
  • Defined in src/pools/abstract-pool.ts:195
  • +
  • Defined in src/pools/abstract-pool.ts:185
  • +
  • Defined in src/pools/thread/dynamic.ts:39
  • Methods

    +
  • Defined in src/pools/abstract-pool.ts:386
  • +
  • Defined in src/pools/thread/fixed.ts:85
  • +
  • Defined in src/pools/abstract-pool.ts:375
  • +
  • Defined in src/pools/abstract-pool.ts:419
  • +
  • Defined in src/pools/abstract-pool.ts:481
  • +
  • Defined in src/pools/thread/fixed.ts:78
  • +
  • Defined in src/pools/abstract-pool.ts:338
  • +
  • Defined in src/pools/thread/fixed.ts:54
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:254
  • -
    - -
    +
  • Defined in src/pools/abstract-pool.ts:307
  • +
  • Defined in src/pools/abstract-pool.ts:298
  • +
  • Defined in src/pools/thread/fixed.ts:49
  • Returns void

    +
  • Defined in src/pools/thread/fixed.ts:70
  • +
  • Defined in src/pools/thread/fixed.ts:62
  • +
  • Defined in src/pools/abstract-pool.ts:266
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:218
  • +
  • Defined in src/pools/abstract-pool.ts:244
  • +
  • Defined in src/pools/abstract-pool.ts:360
  • Returns void

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