X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedThreadPool.html;h=1836da110382c4470026ee64325e36d2676c6b9a;hb=1cc6e9ef64f399f4ca58da8079ef72a011ac4227;hp=9eeaa2f9a11602979fe245bed7356cf42bf22d05;hpb=da7631f88ed580377ddba0882eac576bb32832eb;p=poolifier.git diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index 9eeaa2f9..1836da11 100644 --- a/docs/classes/FixedThreadPool.html +++ b/docs/classes/FixedThreadPool.html @@ -1,13 +1,13 @@ -FixedThreadPool | poolifier - v2.6.41
+FixedThreadPool | poolifier - v2.7.5
-
+
  • The search index is not available
  • poolifier - v2.7.5 +
    +
  • filePath: string

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

    -
  • +
    +
  • opts: ThreadPoolOptions = {}

    Options for this fixed thread pool.

    -
  • + +

    Returns FixedThreadPool<Data, Response>

    +
  • Defined in src/pools/thread/fixed.ts:46
  • Properties

    - -
    emitter?: PoolEmitter
    -

    Emitter on which events can be listened to.

    + +
    emitter?: EventEmitterAsyncResource
    +

    Event emitter integrated with async resource on which events can be listened to. +The async tracking tooling identifier is poolifier:<PoolType>-<WorkerType>-pool.

    Events that can currently be listened to:

    +
  • Defined in src/pools/abstract-pool.ts:73
  • filePath: string
    @@ -172,7 +182,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:128
  • max?: number
    @@ -181,7 +191,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:97
  • numberOfWorkers: number
    @@ -190,7 +200,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:127
  • opts: ThreadPoolOptions = {}
    @@ -199,11 +209,11 @@
    +
  • Defined in src/pools/thread/fixed.ts:49
  • promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
    -

    The task execution response promise map.

    +

    The task execution response promise map:

    +
  • Defined in src/pools/abstract-pool.ts:82
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -222,7 +232,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:88
  • workerNodes: IWorkerNode<Worker, Data>[] = []
    @@ -231,7 +241,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:70
  • Accessors

    @@ -246,7 +256,7 @@
    +
  • Defined in src/pools/thread/fixed.ts:154
  • +
  • Defined in src/pools/abstract-pool.ts:651
  • +
  • Defined in src/pools/abstract-pool.ts:271
  • +
  • Defined in src/pools/abstract-pool.ts:484
  • +
  • Defined in src/pools/abstract-pool.ts:477
  • +
  • Defined in src/pools/abstract-pool.ts:429
  • +
  • Defined in src/pools/thread/fixed.ts:144
  • +
  • Defined in src/pools/abstract-pool.ts:446
  • +
  • Defined in src/pools/thread/fixed.ts:149
  • Methods

    +
    + +
    + +

    Returns void

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

    Returns void

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

    Returns void

    -
    - -
    +
  • Defined in src/pools/abstract-pool.ts:1003
  • +
  • Defined in src/pools/abstract-pool.ts:1250
  • +
  • Defined in src/pools/abstract-pool.ts:1206
  • +
  • Defined in src/pools/thread/fixed.ts:136
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:940
  • + +

    Returns Promise<void>

    +
  • Defined in src/pools/thread/fixed.ts:60
  • + +

    Returns void

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

    Returns Promise<Response>

    Promise that will be fulfilled when the task is completed.

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

    Returns WorkerInfo

    The worker information.

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

    Returns boolean

    true if the worker node has back pressure, false otherwise.

    +
  • Defined in src/pools/abstract-pool.ts:1625
  • +
  • Defined in src/pools/abstract-pool.ts:667
  • -
    - +
  • Defined in src/pools/thread/fixed.ts:55
  • +
    +
    +
    + +
    +
  • Defined in src/pools/thread/fixed.ts:116
  • +
  • Defined in src/pools/thread/fixed.ts:106
  • +
    + +

    Returns Promise<void>

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

    Returns void

    +
  • Defined in src/pools/thread/fixed.ts:91
  • + +

    Returns void

    +
  • Defined in src/pools/thread/fixed.ts:77
  • +
    + +
    + +

    Returns void

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

    Returns void

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

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:551
  • +
  • Defined in src/pools/abstract-pool.ts:987
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:1495
  • @@ -885,99 +1088,63 @@ Can be overridden.

  • type
  • utilization
  • worker
  • +
  • addTaskFunction
  • afterTaskExecutionHook
  • afterWorkerNodeSetup
  • beforeTaskExecutionHook
  • -
  • checkDynamicPoolSize
  • createAndSetupDynamicWorkerNode
  • createAndSetupWorkerNode
  • createWorker
  • +
  • deregisterWorkerMessageListener
  • destroy
  • destroyWorkerNode
  • enableTasksQueue
  • execute
  • flushTasksQueue
  • getWorkerInfo
  • +
  • hasTaskFunction
  • hasWorkerNodeBackPressure
  • internalBusy
  • isMain
  • -
  • listTaskFunctions
  • +
  • listTaskFunctionNames
  • +
  • registerOnceWorkerMessageListener
  • registerWorkerMessageListener
  • +
  • removeTaskFunction
  • sendKillMessageToWorker
  • sendStartupMessageToWorker
  • sendToWorker
  • +
  • setDefaultTaskFunction
  • setTasksQueueOptions
  • setWorkerChoiceStrategy
  • setWorkerChoiceStrategyOptions
  • setupHook
  • +
  • start
  • workerListener
  • +

    Generated using TypeDoc

    -
    \ No newline at end of file +
    \ No newline at end of file