X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=48d436c8a7e1ce36227e088badf7c1e00fb46e9f;hb=fb8fbcfd7983c1eadc39411c9b29054e6fa97d5b;hp=ac61238ccf805c177c072009a26f5d8ba56e1087;hpb=a47027a0bf90ce21b528708dadd0eb23b5537b43;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index ac61238c..48d436c8 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -1,4 +1,4 @@ -AbstractPool | poolifier - v2.6.21
+AbstractPool | poolifier - v2.6.28
  • Preparing search index...
  • -
  • The search index is not available
poolifier - v2.6.21
+
  • The search index is not available
  • poolifier - v2.6.28
    @@ -119,12 +120,14 @@ handleWorkerReadyResponse internalBusy isMain +listTaskFunctions redistributeQueuedTasks registerWorkerMessageListener removeWorkerNode +sendKillMessageToWorker sendStartupMessageToWorker +sendStatisticsMessageToWorker sendToWorker -sendWorkerStatisticsMessageToWorker setTasksQueueOptions setWorkerChoiceStrategy setWorkerChoiceStrategyOptions @@ -177,7 +180,7 @@

    Returns AbstractPool<Worker, Data, Response>

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

    @@ -186,9 +189,10 @@

    Emitter on which events can be listened to.

    Events that can currently be listened to:

      -
    • 'full': Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.
    • 'ready': Emitted when the number of workers created in the pool has reached the minimum size expected and are ready.
    • 'busy': Emitted when the number of workers created in the pool has reached the maximum size expected and are executing at least one task.
    • +
    • 'full': Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.
    • +
    • 'destroy': Emitted when the pool is destroyed.
    • 'error': Emitted when an uncaught error occurs.
    • 'taskError': Emitted when an error occurs while executing a task.
    @@ -196,7 +200,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:65
  • filePath: string
    @@ -204,7 +208,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:109
  • numberOfWorkers: number
    @@ -212,7 +216,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:108
  • opts: PoolOptions<Worker>
    @@ -220,7 +224,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:110
  • promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
    @@ -233,7 +237,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:75
  • startTimestamp: number
    @@ -241,7 +245,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:94
  • starting: boolean
    @@ -249,7 +253,15 @@
    +
  • Defined in src/pools/abstract-pool.ts:90
  • +
    + +
    taskFunctions: string[]
    +

    The task function names.

    +
    +
    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -257,7 +269,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:81
  • workerNodes: IWorkerNode<Worker, Data>[] = []
    @@ -266,7 +278,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:62
  • Accessors

    @@ -280,7 +292,7 @@

    Returns boolean

    +
  • Defined in src/pools/abstract-pool.ts:624
  • +
  • Defined in src/pools/abstract-pool.ts:615
  • +
  • Defined in src/pools/abstract-pool.ts:308
  • +
  • Defined in src/pools/abstract-pool.ts:504
  • +
  • Defined in src/pools/abstract-pool.ts:499
  • +
  • Defined in src/pools/abstract-pool.ts:451
  • +
  • Defined in src/pools/abstract-pool.ts:489
  • +
  • Defined in src/pools/abstract-pool.ts:468
  • +
  • Defined in src/pools/abstract-pool.ts:494
  • Methods

    @@ -396,7 +408,7 @@

    Throws

    https://nodejs.org/api/errors.html#class-error If the added worker node is not found.

    +
  • Defined in src/pools/abstract-pool.ts:1196
  • +
  • Defined in src/pools/abstract-pool.ts:795
  • +
  • Defined in src/pools/abstract-pool.ts:1028
  • +
  • Defined in src/pools/abstract-pool.ts:774
  • Returns TasksQueueOptions

    +
  • Defined in src/pools/abstract-pool.ts:602
  • +
  • Defined in src/pools/abstract-pool.ts:1168
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:180
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:149
  • +
  • Defined in src/pools/abstract-pool.ts:512
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:162
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:206
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:271
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:233
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:243
  • +
  • Defined in src/pools/abstract-pool.ts:889
  • +
  • Defined in src/pools/abstract-pool.ts:975
  • +
  • Defined in src/pools/abstract-pool.ts:935
  • +
  • Defined in src/pools/abstract-pool.ts:928
  • Returns undefined | Task<Data>

    +
  • Defined in src/pools/abstract-pool.ts:1238
  • +
  • Defined in src/pools/abstract-pool.ts:720
  • +
  • Defined in src/pools/abstract-pool.ts:750
  • +
  • Defined in src/pools/abstract-pool.ts:580
  • Returns number

    +
  • Defined in src/pools/abstract-pool.ts:1234
  • +
  • Defined in src/pools/abstract-pool.ts:661
  • +
  • Defined in src/pools/abstract-pool.ts:1229
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1246
  • +
  • Defined in src/pools/abstract-pool.ts:1256
  • +
  • Defined in src/pools/abstract-pool.ts:1185
  • +
  • Defined in src/pools/abstract-pool.ts:531
  • +
  • Defined in src/pools/abstract-pool.ts:543
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1139
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1127
  • +
  • Defined in src/pools/abstract-pool.ts:631
  • +
  • Defined in src/pools/abstract-pool.ts:765
  • +
    + +

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1062
  • +
  • Defined in src/pools/abstract-pool.ts:1015
  • +
  • Defined in src/pools/abstract-pool.ts:1215
  • +
    + +
    -
    - -
    +
    + +

    Returns void

    -
    - -
    +
    + +

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:917
  • +
  • Defined in src/pools/abstract-pool.ts:592
  • +
  • Defined in src/pools/abstract-pool.ts:550
  • +
  • Defined in src/pools/abstract-pool.ts:569
  • +
  • Defined in src/pools/abstract-pool.ts:758
  • +
  • Defined in src/pools/abstract-pool.ts:906
  • +
  • Defined in src/pools/abstract-pool.ts:295
  • Returns number

    +
  • Defined in src/pools/abstract-pool.ts:1242
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:850
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:824
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:811
  • Returns void

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