Class

com.twitter.finagle.pool

SingletonPool

Related Doc: package pool

Permalink

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

A pool that maintains at most one service from the underlying ServiceFactory -- concurrent leases share the same, cached service. A new Service is established whenever the service factory fails or the current service has become unavailable.

Linear Supertypes
ServiceFactory[Req, Rep], Closable, (ClientConnection) ⇒ Future[Service[Req, Rep]], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SingletonPool
  2. ServiceFactory
  3. Closable
  4. Function1
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SingletonPool(underlying: ServiceFactory[Req, Rep], allowInterrupts: Boolean, statsReceiver: StatsReceiver)

    Permalink

    underlying

    the underlying shared resource which the pool manages.

    allowInterrupts

    Because the pool hands back a shared resource, it may be useful to manage interrupts such that they are isolated from independent service acquisition requests. Thus, setting this value to false will ensure that an outstanding dispatch to the underlying resource from the pool is uninterruptible but individual service acquisition requests are.

    statsReceiver

    the StatsReceiver that is used to report pool specific stats.

Value Members

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

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

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

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

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

    Permalink

    Reserve the use of the returned Service instance.

    Reserve the use of the returned Service instance.

    To relinquish the use of the reserved Service, the user must call Service.close().

    conn

    will be ClientConnection.nil when called on the client-side.

    Definition Classes
    SingletonPoolServiceFactory → Function1
    Annotations
    @tailrec()
  6. final def apply(): Future[Service[Req, Rep]]

    Permalink

    Reserve the use of the returned Service instance using ClientConnection.nil.

    Reserve the use of the returned Service instance using ClientConnection.nil.

    To relinquish the use of the reserved Service, the user must call Service.close().

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

    Permalink
    Definition Classes
    Any
  8. def clone(): AnyRef

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

    Permalink

    <invalid inheritdoc annotation>

    <invalid inheritdoc annotation>

    SingletonPool closes asynchronously; the underlying connection is closed once all references are returned.

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

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

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

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

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

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

    Permalink
    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]

    Permalink

    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[_]

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

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

    Permalink

    Return true if and only if status is currently Status.Open.

    Return true if and only if status is currently Status.Open.

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

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

    Permalink

    Map created services.

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  25. def status: Status

    Permalink

    The current availability Status of this ServiceFactory

    The current availability Status of this ServiceFactory

    The status of a SingletonPool is the worse of the the underlying status and the status of the currently cached service, if any.

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

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

    Permalink

    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. def toString(): String

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from ServiceFactory[Req, Rep]

Inherited from Closable

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

Inherited from AnyRef

Inherited from Any

Ungrouped