X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedClusterPool.html;h=dff66fdd08f442f39ad5e998942b04b4375a0253;hb=9d96ba4ea0e2e4b06216657cb1641551b59f58ee;hp=f12d62c8d4b6dd1ad80b5c85bbcfefcf3c7260f1;hpb=da7631f88ed580377ddba0882eac576bb32832eb;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index f12d62c8..dff66fdd 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -1,13 +1,13 @@ -FixedClusterPool | poolifier - v2.6.41
+FixedClusterPool | poolifier - v2.7.4
-
+
  • The search index is not available
  • poolifier - v2.7.4 +
    +
  • filePath: string

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

    -
  • +
    +
  • opts: ClusterPoolOptions = {}

    Options for this fixed cluster pool.

    -
  • + +

    Returns FixedClusterPool<Data, Response>

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

    - -
    emitter?: PoolEmitter
    -

    Emitter on which events can be listened to.

    + +
    emitter?: __module | 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: ClusterPoolOptions = {}
    @@ -199,11 +209,11 @@
    +
  • Defined in src/pools/cluster/fixed.ts:47
  • 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/cluster/fixed.ts:139
  • +
  • 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/cluster/fixed.ts:129
  • +
  • Defined in src/pools/abstract-pool.ts:446
  • +
  • Defined in src/pools/cluster/fixed.ts:134
  • Methods

    +
    + +
    + +

    Returns void

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

    Returns void

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

    Returns void

    -
    - -
    +
  • Defined in src/pools/abstract-pool.ts:1005
  • +
  • Defined in src/pools/abstract-pool.ts:1252
  • +
  • Defined in src/pools/abstract-pool.ts:1208
  • +
  • Defined in src/pools/cluster/fixed.ts:124
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:940
  • + +

    Returns Promise<void>

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

    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:1669
  • + +

    Returns WorkerInfo

    The worker information.

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

    Returns boolean

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

    +
  • Defined in src/pools/abstract-pool.ts:1627
  • +
  • Defined in src/pools/abstract-pool.ts:667
  • -
    - +
  • Defined in src/pools/cluster/fixed.ts:58
  • +
    +
    +
    + +
    +
  • Defined in src/pools/cluster/fixed.ts:108
  • +
  • Defined in src/pools/cluster/fixed.ts:100
  • +
    + +

    Returns Promise<void>

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

    Returns void

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

    Returns void

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

    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/cluster/fixed.ts:53
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:1497
  • @@ -881,99 +1083,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