Packages

  • package root
    Definition Classes
    root
  • package com
    Definition Classes
    root
  • package twitter

    Start with com.twitter.finagle.

    Start with com.twitter.finagle.

    Definition Classes
    com
  • package finagle

    Finagle is an extensible RPC system.

    Finagle is an extensible RPC system.

    Services are represented by class com.twitter.finagle.Service. Clients make use of com.twitter.finagle.Service objects while servers implement them.

    Finagle contains a number of protocol implementations; each of these implement Client and/or com.twitter.finagle.Server. For example, Finagle's HTTP implementation, com.twitter.finagle.Http (in package finagle-http), exposes both.

    Thus a simple HTTP server is built like this:

    import com.twitter.finagle.{Http, Service}
import com.twitter.finagle.http.{Request, Response}
import com.twitter.util.{Await, Future}

val service = new Service[Request, Response] {
  def apply(req: Request): Future[Response] =
    Future.value(Response())
}
val server = Http.server.serve(":8080", service)
Await.ready(server)

    We first define a service to which requests are dispatched. In this case, the service returns immediately with a HTTP 200 OK response, and with no content.

    This service is then served via the Http protocol on TCP port 8080. Finally we wait for the server to stop serving.

    We can now query our web server:

    % curl -D - localhost:8080
HTTP/1.1 200 OK

    Building an HTTP client is also simple. (Note that type annotations are added for illustration.)

    import com.twitter.finagle.{Http, Service}
import com.twitter.finagle.http.{Request, Response}
import com.twitter.util.{Future, Return, Throw}

val client: Service[Request, Response] = Http.client.newService("localhost:8080")
val f: Future[Response] = client(Request()).respond {
  case Return(rep) =>
    printf("Got HTTP response %s\n", rep)
  case Throw(exc) =>
    printf("Got error %s\n", exc)
}

    Http.client.newService("localhost:8080") constructs a new com.twitter.finagle.Service instance connected to localhost TCP port 8080. We then issue a HTTP/1.1 GET request to URI "/". The service returns a com.twitter.util.Future representing the result of the operation. We listen to this future, printing an appropriate message when the response arrives.

    The Finagle homepage contains useful documentation and resources for using Finagle.

    Definition Classes
    twitter
  • object Backoff
    Definition Classes
    finagle
  • TakeWhile

class TakeWhile extends Backoff

See also

Backoff.takeUntil as the api to create this strategy.

Linear Supertypes
Backoff, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TakeWhile
  2. Backoff
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new TakeWhile(backoff: Backoff, count: Duration, maxCumulativeBackoff: Duration)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ++(that: Backoff): Backoff

    An alias for Backoff concatenation.

    An alias for Backoff concatenation.

    Definition Classes
    Backoff
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  7. final def concat(that: Backoff): Backoff

    Start creating backoffs from that once the current Backoff isExhausted.

    Start creating backoffs from that once the current Backoff isExhausted. You can combine one or more Backoffs by:

    Backoff.const(1.second).take(5)
  .concat(Backoff.linear(2.millis, 1.millis).take(7))
  .concat(Backoff.const(9.millis))
    Definition Classes
    Backoff
    Note

    The Backoffs are invoked in the same order as they are concatenated. The former Backoff needs to be finite in order to invoke the succeeding strategies.

    See also

    take on how to create a finite Backoff.

  8. def duration: Duration

    return the current backoff

    return the current backoff

    Definition Classes
    TakeWhile → Backoff
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  11. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. def isExhausted: Boolean

    return true if this is Backoff.empty, when true, calling duration will return a NoSuchElementException, calling next will return an UnsupportedOperationException.

    return true if this is Backoff.empty, when true, calling duration will return a NoSuchElementException, calling next will return an UnsupportedOperationException. This is used to terminate backoff supplies.

    Definition Classes
    TakeWhile → Backoff
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def next: Backoff

    return a new Backoff to get the next backoff

    return a new Backoff to get the next backoff

    Definition Classes
    TakeWhile → Backoff
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  21. final def take(attempt: Int): Backoff

    Only create backoffs for attempt number of times.

    Only create backoffs for attempt number of times. When attempt is reached, a Backoff.empty will be returned.

    Definition Classes
    Backoff
    Note

    Calling take with a non-positive attempt will return a Backoff.empty, where calling duration and next will throw exceptions.

  22. final def takeUntil(maxCumulativeBackoff: Duration): Backoff

    Only create backoffs until the sum of all previous backoffs is less than or equal to maxCumulativeBackoff.

    Only create backoffs until the sum of all previous backoffs is less than or equal to maxCumulativeBackoff. When maxCumulativeBackoff is reached, a Backoff.empty will be returned.

    Definition Classes
    Backoff
    Note

    Calling takeUntil with a non-positive maxCumulativeBackoff will return a Backoff.empty, where calling duration and next will throw exceptions.

  23. final def toJavaIterator: Iterator[Duration]

    Convert a Backoff into a Java-friendly representation of iterator.

    Convert a Backoff into a Java-friendly representation of iterator.

    Definition Classes
    Backoff
  24. final def toStream: Stream[Duration]

    Convert the Backoff to a Stream[Duration]

    Convert the Backoff to a Stream[Duration]

    Definition Classes
    Backoff
    Note

    This API is only recommended to be used for migrating from Stream to Backoff.

    ,

    Every element of the returned Stream will be memorized due to the nature of Stream, when using this method, your service is at risk of memory leaks.

  25. def toString(): String
    Definition Classes
    Backoff → AnyRef → Any
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from Backoff

Inherited from AnyRef

Inherited from Any

Ungrouped