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
  • package liveness
    Definition Classes
    finagle
  • FailureAccrualFactory
  • FailureAccrualPolicy
  • FailureDetector
  • FailureDetectors
  • sessionFailureDetector

object FailureAccrualPolicy

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

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. val DefaultConsecutiveFailures: Int
  5. val DefaultMinimumRequestThreshold: Int
  6. val DefaultSuccessRateThreshold: Double
  7. val DefaultSuccessRateWindow: Duration
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  10. def consecutiveFailures(numFailures: Int, markDeadFor: Backoff): FailureAccrualPolicy

    A policy based on a maximum number of consecutive failures.

    A policy based on a maximum number of consecutive failures. If numFailures occur consecutively, checkFailures() will return a Some(Duration) to mark an endpoint dead for.

    numFailures

    number of consecutive failures

    markDeadFor

    a policy encoded Backoff to calculate the next duration returned from markDeadOnFailure()

  11. val constantBackoff: Backoff
    Attributes
    protected[this]
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. implicit val showable: Showable[FailureAccrualPolicy]
  22. def successRate(requiredSuccessRate: Double, window: Int, markDeadFor: Backoff): FailureAccrualPolicy

    Returns a policy based on an exponentially-weighted moving average success rate over a window of requests.

    Returns a policy based on an exponentially-weighted moving average success rate over a window of requests. A moving average is used so the success rate calculation is biased towards more recent requests; for an endpoint with low traffic, the window will span a longer time period and early successes and failures may not accurately reflect the current health.

    If the computed weighted success rate is less than the required success rate, markDeadOnFailure() will return Some(Duration).

    requiredSuccessRate

    successRate that must be met

    window

    window over which the success rate is tracked. window requests must occur for markDeadOnFailure() to ever return Some(Duration)

    markDeadFor

    a policy encoded Backoff to calculate the next duration returned from markDeadOnFailure()

    See also

    com.twitter.finagle.util.Ema for how the success rate is computed

  23. def successRateWithinDuration(requiredSuccessRate: Double, window: Duration, markDeadFor: Backoff): FailureAccrualPolicy

    Returns a policy based on an exponentially-weighted moving average success rate over a time window.

    Returns a policy based on an exponentially-weighted moving average success rate over a time window. A moving average is used so the success rate calculation is biased towards more recent requests.

    If the computed weighted success rate is less than the required success rate, markDeadOnFailure() will return Some(Duration).

    requiredSuccessRate

    successRate that must be met

    window

    window over which the success rate is tracked. markDeadOnFailure() will return None, until we get requests for a duration of at least window.

    markDeadFor

    a policy encoded Backoff to calculate the next duration returned from markDeadOnFailure()

    See also

    com.twitter.finagle.util.Ema for how the success rate is computed

  24. def successRateWithinDuration(requiredSuccessRate: Double, window: Duration, markDeadFor: Backoff, minRequestThreshold: Int): FailureAccrualPolicy

    Returns a policy based on an exponentially-weighted moving average success rate over a time window.

    Returns a policy based on an exponentially-weighted moving average success rate over a time window. A moving average is used so the success rate calculation is biased towards more recent requests.

    If the computed weighted success rate is less than the required success rate, markDeadOnFailure() will return Some(Duration).

    requiredSuccessRate

    successRate that must be met

    window

    duration over which the success rate is tracked. markDeadOnFailure() will return None, until we get at least minRequestThreshold requests within a window duration.

    markDeadFor

    a policy encoded Backoff to calculate the next duration returned from markDeadOnFailure()

    minRequestThreshold

    minimum number of requests in the past window for markDeadOnFailure() to return a duration

    See also

    com.twitter.finagle.util.Ema for how the success rate is computed

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

Inherited from AnyRef

Inherited from Any

Ungrouped