Package org.apache.pekko.http.impl.engine.client

Class PoolMaster

java.lang.Object
org.apache.pekko.http.impl.engine.client.PoolMaster
public class PoolMaster extends Object
INTERNAL API

API for accessing the global pool master actor.

  • Constructor Summary

    Constructors
    Constructor
    Description
    PoolMaster(org.apache.pekko.actor.ActorRef ref)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static PoolMaster
    apply(org.apache.pekko.actor.ExtendedActorSystem system)
     
    scala.concurrent.Future<HttpResponse>
    dispatchRequest(PoolId poolId, HttpRequest request, org.apache.pekko.stream.Materializer fm)
    Send a request through the corresponding pool.
    scala.concurrent.Future<Object>
    poolSize()
    For testing only
    org.apache.pekko.actor.ActorRef
    ref()
     
    scala.concurrent.Future<org.apache.pekko.Done>
    shutdown(PoolId poolId)
    Shutdown the corresponding pool and signal its termination.
    scala.concurrent.Future<org.apache.pekko.Done>
    shutdownAll()
    Triggers an orderly shutdown of all host connections pools currently maintained by the pekko.actor.ActorSystem.
    void
    startPool(PoolId poolId, org.apache.pekko.stream.Materializer fm)
    Start the corresponding pool to make it ready to serve requests.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • PoolMaster

      public PoolMaster(org.apache.pekko.actor.ActorRef ref)

  • Method Details

    • apply

      public static PoolMaster apply(org.apache.pekko.actor.ExtendedActorSystem system)

    • ref

      public org.apache.pekko.actor.ActorRef ref()

    • dispatchRequest

      public scala.concurrent.Future<HttpResponse> dispatchRequest(PoolId poolId, HttpRequest request, org.apache.pekko.stream.Materializer fm)
      Send a request through the corresponding pool. If the pool is not running, it will be started automatically. If it is shutting down, it will restart as soon as the shutdown operation is complete and serve this request.

      Parameters:
      request - the request
      poolId - (undocumented)
      fm - (undocumented)
      Returns:
      the response

    • startPool

      public void startPool(PoolId poolId, org.apache.pekko.stream.Materializer fm)
      Start the corresponding pool to make it ready to serve requests. If the pool is already started, this does nothing. If it is being shutdown, it will restart as soon as the shutdown operation is complete.

      Parameters:
      poolId - (undocumented)
      fm - (undocumented)

    • shutdown

      public scala.concurrent.Future<org.apache.pekko.Done> shutdown(PoolId poolId)
      Shutdown the corresponding pool and signal its termination. If the pool is not running or is being shutting down, this does nothing.

      The shutdown will wait for all ongoing requests to be completed.

      Parameters:
      poolId - (undocumented)
      Returns:
      a Future completed when the pool has been shutdown.

    • shutdownAll

      public scala.concurrent.Future<org.apache.pekko.Done> shutdownAll()
      Triggers an orderly shutdown of all host connections pools currently maintained by the pekko.actor.ActorSystem. The returned future is completed when all pools that were live at the time of this method call have completed their shutdown process.

      If existing pool client flows are re-used or new ones materialized concurrently with or after this method call the respective connection pools will be restarted and not contribute to the returned future.

      Returns:
      (undocumented)

    • poolSize

      public scala.concurrent.Future<Object> poolSize()
      For testing only
      Returns:
      (undocumented)