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

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

A com.twitter.finagle.ServiceFactory that accrues failures, marking itself unavailable when deemed unhealthy according to the configured policy.

This acts as a request driven circuit breaker.

Note this module fails open – that is, even if it transitions into a closed state, requests will still be allowed to flow through it. Although, when used in a typical Finagle client, there is one instance of this module per node and as such, the load balancer will avoid nodes where the status is not open.

Self Type
FailureAccrualFactory[Req, Rep]
See also

The user guide for more details.

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

Instance Constructors

  1. new FailureAccrualFactory(underlying: ServiceFactory[Req, Rep], policy: FailureAccrualPolicy, responseClassifier: ResponseClassifier, timer: Timer, statsReceiver: StatsReceiver)

    responseClassifier

    used to determine which request/response pairs are successful or not.

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 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
    FailureAccrualFactory → ServiceFactory → Function1
  6. final def apply(): Future[Service[Req, Rep]]

    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
    Definition Classes
    Any
  8. def classify(reqRep: ReqRep): ResponseClass
    Attributes
    protected
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  10. def close(deadline: Time): Future[Unit]
    Definition Classes
    FailureAccrualFactory → Closable
  11. def close(after: Duration): Future[Unit]
    Definition Classes
    Closable
  12. final def close(): Future[Unit]
    Definition Classes
    Closable
  13. def compose[A](g: (A) => ClientConnection): (A) => Future[Service[Req, Rep]]
    Definition Classes
    Function1
    Annotations
    @unspecialized()
  14. def didMarkDead(duration: Duration): Unit

    Called by FailureAccrualFactory after marking an endpoint dead.

    Called by FailureAccrualFactory after marking an endpoint dead. Override this method to perform additional actions.

    Attributes
    protected
  15. def didSucceed(): Unit
    Attributes
    protected
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  18. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  19. 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
  20. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  21. def getState: State
    Attributes
    protected[this]
  22. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  23. final def isAvailable: Boolean

    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
  24. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  25. 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
  26. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  28. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  29. def startProbing(): Unit

    Enter 'Probing' state.

    Enter 'Probing' state. The service must satisfy one request before accepting more.

    Attributes
    protected
  30. def status: Status

    The current availability Status of this ServiceFactory

    The current availability Status of this ServiceFactory

    Definition Classes
    FailureAccrualFactory → ServiceFactory
  31. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  32. 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
  33. def toString(): String
    Definition Classes
    FailureAccrualFactory → ServiceFactory → Function1 → AnyRef → Any
  34. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  35. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  36. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from ServiceFactory[Req, Rep]

Inherited from Closable

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

Inherited from AnyRef

Inherited from Any

Ungrouped