com.twitter.finagle.pool

WatermarkPool

Related Docs: object WatermarkPool | package pool

class WatermarkPool[Req, Rep] extends ServiceFactory[Req, Rep]

The watermark pool is an object pool with low & high watermarks. It keeps the number of services from a given service factory in a certain range.

This behaves as follows: the pool will persist up to the low watermark number of items (as long as they have been created), and won't start queueing requests until the high watermark has been reached. Put another way: up to lowWatermark' items may persist indefinitely, while there are at no times more than highWatermark' items in concurrent existence.

Self Type
WatermarkPool[Req, Rep]
Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. WatermarkPool
  2. ServiceFactory
  3. Closable
  4. Function1
  5. AnyRef
  6. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new WatermarkPool(factory: ServiceFactory[Req, Rep], lowWatermark: Int, highWatermark: Int = Int.MaxValue, statsReceiver: StatsReceiver = NullStatsReceiver, maxWaiters: Int = Int.MaxValue)

Value Members

  1. final def !=(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  4. def andThen[A](g: (Future[Service[Req, Rep]]) ⇒ A): (ClientConnection) ⇒ A

    Definition Classes
    Function1
    Annotations
    @unspecialized()
  5. def apply(conn: ClientConnection): Future[Service[Req, Rep]]

    Reserve the use of a given service instance.

    Reserve the use of a given service instance. This pins the underlying channel and the returned service has exclusive use of its underlying connection. To relinquish the use of the reserved Service, the user must call Service.close().

    Definition Classes
    WatermarkPoolServiceFactory → Function1
  6. final def apply(): Future[Service[Req, Rep]]

    Definition Classes
    ServiceFactory
  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  8. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. def close(deadline: Time): Future[Unit]

    Definition Classes
    WatermarkPool → Closable
  10. def close(after: Duration): Future[Unit]

    Definition Classes
    Closable
  11. final def close(): Future[Unit]

    Definition Classes
    Closable
  12. def compose[A](g: (A) ⇒ ClientConnection): (A) ⇒ Future[Service[Req, Rep]]

    Definition Classes
    Function1
    Annotations
    @unspecialized()
  13. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  14. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  15. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. def flatMap[Req1, Rep1](f: (Service[Req, Rep]) ⇒ Future[Service[Req1, Rep1]]): ServiceFactory[Req1, Rep1]

    Apply f on created services, returning the resulting Future in their stead.

    Apply f on created services, returning the resulting Future in their stead. This is useful for implementing common factory wrappers that only need to modify or operate on the underlying service.

    Definition Classes
    ServiceFactory
  17. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  18. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  19. final def isAvailable: Boolean

    Definition Classes
    ServiceFactory
  20. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  21. def map[Req1, Rep1](f: (Service[Req, Rep]) ⇒ Service[Req1, Rep1]): ServiceFactory[Req1, Rep1]

    Map created services.

    Map created services. Useful for implementing common styles of factory wrappers.

    Definition Classes
    ServiceFactory
  22. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  23. final def notify(): Unit

    Definition Classes
    AnyRef
  24. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  25. def status: Status

    The current availability Status of this ServiceFactory

    The current availability Status of this ServiceFactory

    Definition Classes
    WatermarkPoolServiceFactory
  26. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  27. final def toService: Service[Req, Rep]

    Make a service that after dispatching a request on that service, releases the service.

    Make a service that after dispatching a request on that service, releases the service.

    Definition Classes
    ServiceFactory
  28. val toString: String

    Definition Classes
    WatermarkPool → Function1 → AnyRef → Any
  29. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. final def make(): Future[Service[Req, Rep]]

    Definition Classes
    ServiceFactory
    Annotations
    @deprecated
    Deprecated

    (Since version 5.0.1) use apply() instead

Inherited from ServiceFactory[Req, Rep]

Inherited from Closable

Inherited from (ClientConnection) ⇒ Future[Service[Req, Rep]]

Inherited from AnyRef

Inherited from Any

Ungrouped