X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FPoolOptions.html;h=ef3eb9652ba43b0df2f12b2de1bdaa94ca347cbd;hb=f05afd162e34836a52c48b05781750e3421424d8;hp=b7cfe9cf30f97f87c7c7fb89710262b17392386a;hpb=3bd6a82e43e11294af91bbd19647944ac740169e;p=poolifier.git diff --git a/docs/interfaces/PoolOptions.html b/docs/interfaces/PoolOptions.html index b7cfe9cf..ef3eb965 100644 --- a/docs/interfaces/PoolOptions.html +++ b/docs/interfaces/PoolOptions.html @@ -17,22 +17,25 @@

Interface PoolOptions<Worker>

Options for a poolifier pool.

-
-
+ +
+

Type Parameters

-
+ +

Hierarchy

@@ -40,92 +43,110 @@

Properties

- -
enableEvents?: boolean
+ +
enableEvents?: boolean

Pool events emission.

- -

Default Value

true

+
+
+

Default Value

true

+
  • Defined in src/pools/pool.ts:138
  • - -
    enableTasksQueue?: boolean
    + +
    enableTasksQueue?: boolean

    Pool worker tasks queue.

    - -

    Default Value

    false

    +
    +
    +

    Default Value

    false

    +
  • Defined in src/pools/pool.ts:144
  • - -
    errorHandler?: ErrorHandler<Worker>
    + +
    errorHandler?: ErrorHandler<Worker>

    A function that will listen for error event on each worker.

    -
    +
  • Defined in src/pools/pool.ts:110
  • - -
    exitHandler?: ExitHandler<Worker>
    + +
    exitHandler?: ExitHandler<Worker>

    A function that will listen for exit event on each worker.

    -
    +
  • Defined in src/pools/pool.ts:118
  • - -
    messageHandler?: MessageHandler<Worker>
    + +
    messageHandler?: MessageHandler<Worker>

    A function that will listen for message event on each worker.

    -
    +
  • Defined in src/pools/pool.ts:106
  • - -
    onlineHandler?: OnlineHandler<Worker>
    + +
    onlineHandler?: OnlineHandler<Worker>

    A function that will listen for online event on each worker.

    -
    +
  • Defined in src/pools/pool.ts:114
  • +
    + +
    restartWorkerOnError?: boolean
    +

    Restart worker on error.

    +
    +
    - -
    tasksQueueOptions?: TasksQueueOptions
    + +
    tasksQueueOptions?: TasksQueueOptions

    Pool worker tasks queue options.

    -
    +
  • Defined in src/pools/pool.ts:148
  • - -
    workerChoiceStrategy?: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
    + +
    workerChoiceStrategy?: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"

    The worker choice strategy to use in this pool.

    - -

    Default Value

    WorkerChoiceStrategies.ROUND_ROBIN

    +
    +
    +

    Default Value

    WorkerChoiceStrategies.ROUND_ROBIN

    +
  • Defined in src/pools/pool.ts:124
  • - -
    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
    + +
    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions

    The worker choice strategy options.

    -
    +
  • Defined in src/pools/pool.ts:128
  • +
  • enableEvents
  • +
  • enableTasksQueue
  • +
  • errorHandler
  • +
  • exitHandler
  • +
  • messageHandler
  • +
  • onlineHandler
  • +
  • restartWorkerOnError
  • +
  • tasksQueueOptions
  • +
  • workerChoiceStrategy
  • +
  • workerChoiceStrategyOptions
  • +
  • AbstractPool
  • +
  • AbstractWorker
  • +
  • CircularArray
  • +
  • ClusterWorker
  • +
  • DynamicClusterPool
  • +
  • DynamicThreadPool
  • +
  • FixedClusterPool
  • +
  • FixedThreadPool
  • +
  • PoolEmitter
  • +
  • Queue
  • +
  • ThreadWorker
  • +
  • WorkerChoiceStrategyContext
  • +
  • ClusterPoolOptions
  • +
  • EventLoopUtilizationMeasurementStatistics
  • +
  • IPool
  • +
  • IWorker
  • +
  • IWorkerChoiceStrategy
  • +
  • MeasurementOptions
  • +
  • MeasurementStatistics
  • +
  • MeasurementStatisticsRequirements
  • +
  • MessageValue
  • +
  • PoolInfo
  • +
  • PoolOptions
  • +
  • PromiseResponseWrapper
  • +
  • Task
  • +
  • TaskError
  • +
  • TaskPerformance
  • +
  • TaskStatistics
  • +
  • TaskStatisticsRequirements
  • +
  • TasksQueueOptions
  • +
  • ThreadPoolOptions
  • +
  • WorkerChoiceStrategyOptions
  • +
  • WorkerNode
  • +
  • WorkerOptions
  • +
  • WorkerStatistics
  • +
  • WorkerUsage
  • +
  • Draft
  • +
  • ErrorHandler
  • +
  • ExitHandler
  • +
  • KillBehavior
  • +
  • Measurement
  • +
  • MessageHandler
  • +
  • OnlineHandler
  • +
  • PoolEvent
  • +
  • PoolType
  • +
  • TaskFunctions
  • +
  • ThreadWorkerWithMessageChannel
  • +
  • WorkerAsyncFunction
  • +
  • WorkerChoiceStrategy
  • +
  • WorkerFunction
  • +
  • WorkerSyncFunction
  • +
  • WorkerType
  • +
  • KillBehaviors
  • +
  • Measurements
  • +
  • PoolEvents
  • +
  • PoolTypes
  • +
  • WorkerChoiceStrategies
  • +
  • WorkerTypes
  • Generated using TypeDoc

    \ No newline at end of file