X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=0770ba514f10dfb013873fad75dea27d8b1e9942;hb=ed1ecf09c599769ed61771ec25d71c39c19ba70b;hp=36b35e12a2e51561032948b804eb98e5176c7773;hpb=d0f1dce33156fdb99f0ca3627839001909419497;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 36b35e12..0770ba51 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,18 +1,125 @@ -IPool | poolifier
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IPool<Data, Response>

-

Contract definition for a poolifier pool.

-

Type parameters

  • Data = unknown

    -

    Type of data sent to the worker. This can only be serializable data.

    -

  • Response = unknown

    -

    Type of response of execution. This can only be serializable data.

    -

Hierarchy

  • IPool

Index

Methods

Methods

destroy

  • destroy(): Promise<void>
  • -

    Shut down every current worker in this pool.

    -

    Returns Promise<void>

execute

  • execute(data: Data): Promise<Response>
  • -

    Perform the task specified in the constructor with the data parameter.

    -

    Parameters

    • data: Data
      -

      The input for the specified task. This can only be serializable data.

      -

    Returns Promise<Response>

    Promise that will be resolved when the task is successfully completed.

    -

setWorkerChoiceStrategy

  • setWorkerChoiceStrategy(workerChoiceStrategy: "ROUND_ROBIN" | "LESS_RECENTLY_USED"): void
  • -

    Set the worker choice strategy in this pool.

    -

    Parameters

    • workerChoiceStrategy: "ROUND_ROBIN" | "LESS_RECENTLY_USED"
      -

      The worker choice strategy.

      -

    Returns void

Generated using TypeDoc

\ No newline at end of file +IPool | poolifier
+
+ +
+
+
+
+ +

Interface IPool<Data, Response>

+
+

Contract definition for a poolifier pool.

+
+
+

Type Parameters

+
    +
  • +

    Data = unknown

    +

    Type of data sent to the worker. This can only be serializable data.

    +
    • +
  • +

    Response = unknown

    +

    Type of response of execution. This can only be serializable data.

    +
+
+

Hierarchy

+
    +
  • IPool
+
+
+
+ +
+
+

Methods

+
destroy +execute +setWorkerChoiceStrategy +
+
+

Methods

+
+

destroy

+
    + +
  • +

    Shutdowns every current worker in this pool.

    +
    +

    Returns Promise<void>

+
+

execute

+
    + +
  • +

    Performs the task specified in the constructor with the data parameter.

    + +

    Returns

    Promise that will be resolved when the task is successfully completed.

    +
    +
    +

    Parameters

    +
      +
    • +
      data: Data
      +

      The input for the specified task. This can only be serializable data.

      +
    +

    Returns Promise<Response>

+
+

setWorkerChoiceStrategy

+
    + +
  • +

    Sets the worker choice strategy in this pool.

    +
    +
    +

    Parameters

    +
      +
    • +
      workerChoiceStrategy: "ROUND_ROBIN" | "LESS_RECENTLY_USED" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
      +

      The worker choice strategy.

      +
    +

    Returns void

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file