X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FPoolOptions.html;h=ef3eb9652ba43b0df2f12b2de1bdaa94ca347cbd;hb=f05afd162e34836a52c48b05781750e3421424d8;hp=68adf02c15ba6a348f361dd8049ab59cd538f68d;hpb=4736ba628fabbf7e34e36ef0f55a96e86b7033ac;p=poolifier.git diff --git a/docs/interfaces/PoolOptions.html b/docs/interfaces/PoolOptions.html index 68adf02c..ef3eb965 100644 --- a/docs/interfaces/PoolOptions.html +++ b/docs/interfaces/PoolOptions.html @@ -1,4 +1,4 @@ -PoolOptions | poolifier
+PoolOptions | poolifier
-
+
  • poolifier
    • @@ -17,20 +17,25 @@

    Interface PoolOptions<Worker>

Options for a poolifier pool.

-
-
+
+
+

Type Parameters

-
    +
    • -

      Worker

+

Worker extends IWorker

+

Type of worker.

+
+

Hierarchy

@@ -38,63 +43,110 @@

Properties

-
enableEvents? -errorHandler? -exitHandler? -messageHandler? -onlineHandler? -workerChoiceStrategy? +
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 errorHandler

-
errorHandler?: ErrorHandler<Worker>
-

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

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

    Optional enableTasksQueue

    +
    enableTasksQueue?: boolean
    +

    Pool worker tasks queue.

    +
    +
    +

    Default Value

    false

    -
    -

    Optional exitHandler

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

    Optional errorHandler

    +
    errorHandler?: ErrorHandler<Worker>
    +

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

    +
    +
    +
    +

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

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

    Optional onlineHandler

    +
    onlineHandler?: OnlineHandler<Worker>

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

    -
    -
    -

    Optional workerChoiceStrategy

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

    Optional restartWorkerOnError

    +
    restartWorkerOnError?: boolean
    +

    Restart worker on error.

    +
    +
    +
    +

    Optional tasksQueueOptions

    +
    tasksQueueOptions?: TasksQueueOptions
    +

    Pool worker tasks queue options.

    +
    +
    +
    +

    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

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

    Optional workerChoiceStrategyOptions

    +
    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
    +

    The worker choice strategy options.

    +
    +
    +
    +
    -

    Settings

     +

    Settings

    Member Visibility

    @@ -104,24 +156,82 @@
    • -

    Theme

    -
    +
    +

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

    Generated using TypeDoc

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