X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FPoolOptions.html;h=0f2d3e34bb4cdf8b2f05bf5916439a50abc5a3b6;hb=e905ea64c054a25ef73885e41fc063279bc599ca;hp=cbdec6cbdc1c7ba54da75faad035e806f7e48535;hpb=70353024c44987c467dadcec306c699ce4ae1f06;p=poolifier.git diff --git a/docs/interfaces/PoolOptions.html b/docs/interfaces/PoolOptions.html index cbdec6cb..0f2d3e34 100644 --- a/docs/interfaces/PoolOptions.html +++ b/docs/interfaces/PoolOptions.html @@ -1,13 +1,13 @@ -PoolOptions | poolifier
+PoolOptions | poolifier - v2.6.44
-
+
  • The search index is not available
    • poolifier - v2.6.44 +
    @@ -17,193 +17,188 @@

    Interface PoolOptions<Worker>

    Options for a poolifier pool.

    -
    +
    +

    Type Parameters

    +
    +

    Hierarchy

    - +

    Properties

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

    Properties

    -

    Optional enableEvents

    +

    Optional enableEvents

    enableEvents?: boolean

    Pool events emission.

    - -

    Default Value

    true

    +
    +
    +

    Default Value

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

    Optional enableTasksQueue

    +

    Optional enableTasksQueue

    enableTasksQueue?: boolean
    -

    Pool worker tasks queue.

    - -

    Default Value

    false

    +

    Pool worker node tasks queue.

    +
    +
    +

    Default Value

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

    Optional errorHandler

    +

    Optional errorHandler

    errorHandler?: ErrorHandler<Worker>

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

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

    Optional exitHandler

    +

    Optional exitHandler

    exitHandler?: ExitHandler<Worker>

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

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

    Optional messageHandler

    +

    Optional messageHandler

    messageHandler?: MessageHandler<Worker>

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

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

    Optional onlineHandler

    +

    Optional onlineHandler

    onlineHandler?: OnlineHandler<Worker>

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

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

    Optional restartWorkerOnError

    +

    Optional restartWorkerOnError

    restartWorkerOnError?: boolean

    Restart worker on error.

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

    Optional tasksQueueOptions

    +

    Optional tasksQueueOptions

    tasksQueueOptions?: TasksQueueOptions
    -

    Pool worker tasks queue options.

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

    Optional workerChoiceStrategy

    -
    workerChoiceStrategy?: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
    +

    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

    +
    +
    +

    Default Value

    WorkerChoiceStrategies.ROUND_ROBIN
+
    +
  • Defined in src/pools/pool.ts:148
    • -

    Optional workerChoiceStrategyOptions

    +

    Optional workerChoiceStrategyOptions

    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions

    The worker choice strategy options.

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

    Settings

     +

    Settings

    Member Visibility

      -
      • -
      • -
      • -
    +
    • +
    • +
    • +

    • Theme

    -

    On This Page

     +

    On This Page

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

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    +
    \ No newline at end of file