X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FPoolOptions.html;h=cb88dda4e18d5bd570c2ae48e9496ed2d2f40e75;hb=2a6631992868d900762f62e4c228dce4e4ee549a;hp=3216b78dc5d5d795a04057810622e33c5622b0c3;hpb=bb3f9b66fa2241864d31937eeced22caab83d17e;p=poolifier.git diff --git a/docs/interfaces/PoolOptions.html b/docs/interfaces/PoolOptions.html index 3216b78d..cb88dda4 100644 --- a/docs/interfaces/PoolOptions.html +++ b/docs/interfaces/PoolOptions.html @@ -1,4 +1,4 @@ -PoolOptions | poolifier
+PoolOptions | poolifier

Options for a poolifier pool.

-
-
+
+
+

Type Parameters

-
+

Worker extends IWorker

+

Type of worker.

+
+

Hierarchy

@@ -38,90 +43,110 @@

Properties

-
enableEvents? -enableTasksQueue? -errorHandler? -exitHandler? -messageHandler? -onlineHandler? -tasksQueueOptions? -workerChoiceStrategy? -workerChoiceStrategyOptions? +
enableEvents? +enableTasksQueue? +errorHandler? +exitHandler? +messageHandler? +onlineHandler? +restartWorkerOnError? +tasksQueueOptions? +workerChoiceStrategy? +workerChoiceStrategyOptions?

Properties

-
-

Optional enableEvents

-
enableEvents?: boolean
+
+

Optional enableEvents

+
enableEvents?: boolean

Pool events emission.

- -

Default Value

true

+
+
+

Default Value

true

-
-

Optional Experimental enableTasksQueue

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

    Optional enableTasksQueue

    +
    enableTasksQueue?: boolean

    Pool worker tasks queue.

    - -

    Default Value

    false

    +
    +
    +

    Default Value

    false

    -
    -

    Optional errorHandler

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

    Optional errorHandler

    +
    errorHandler?: ErrorHandler<Worker>

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

    -
    -
    -

    Optional exitHandler

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

    Optional exitHandler

    +
    exitHandler?: ExitHandler<Worker>

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

    -
    -
    -

    Optional messageHandler

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

    Optional messageHandler

    +
    messageHandler?: MessageHandler<Worker>

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

    -
    -
    -

    Optional onlineHandler

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

    Optional onlineHandler

    +
    onlineHandler?: OnlineHandler<Worker>

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

    -
    -
    -

    Optional Experimental tasksQueueOptions

    -
    tasksQueueOptions?: TasksQueueOptions
    +
  • Defined in src/pools/pool.ts:119
    • +
    +

    Optional restartWorkerOnError

    +
    restartWorkerOnError?: boolean
    +

    Restart worker on error.

    +
    +
    +
    +

    Optional tasksQueueOptions

    +
    tasksQueueOptions?: TasksQueueOptions

    Pool worker tasks queue options.

    -
    -
    -

    Optional workerChoiceStrategy

    -
    workerChoiceStrategy?: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
    +
  • Defined in src/pools/pool.ts:153
    • +
    +

    Optional workerChoiceStrategy

    +
    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

    -
    -

    Optional workerChoiceStrategyOptions

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

    Optional workerChoiceStrategyOptions

    +
    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions

    The worker choice strategy options.

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

    Settings

     +

    Settings

    Member Visibility

    @@ -131,48 +156,83 @@
    • -

    Theme

    +

    Theme

    -

    On This Page

     +

    On This Page

    +
  • 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
    • +
  • StrategyPolicy
    • +
  • Task
    • +
  • TaskError
    • +
  • TaskPerformance
    • +
  • TaskStatistics
    • +
  • TaskStatisticsRequirements
    • +
  • TasksQueueOptions
    • +
  • ThreadPoolOptions
    • +
  • WorkerChoiceStrategyOptions
    • +
  • WorkerInfo
    • +
  • WorkerNode
    • +
  • WorkerOptions
    • +
  • WorkerStatistics
    • +
  • WorkerUsage
    • +
  • ErrorHandler
    • +
  • ExitHandler
    • +
  • KillBehavior
    • +
  • Measurement
    • +
  • MessageHandler
    • +
  • OnlineHandler
    • +
  • PoolEvent
    • +
  • PoolType
    • +
  • TaskFunctions
    • +
  • WorkerAsyncFunction
    • +
  • WorkerChoiceStrategy
    • +
  • WorkerFunction
    • +
  • WorkerSyncFunction
    • +
  • WorkerType
    • +
  • KillBehaviors
    • +
  • Measurements
    • +
  • PoolEvents
    • +
  • PoolTypes
    • +
  • WorkerChoiceStrategies
    • +
  • WorkerTypes
    • +
  • availableParallelism

    • Generated using TypeDoc

    \ No newline at end of file