Packages

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

    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 loadbalancer

    This package implements client side load balancing algorithms.

    This package implements client side load balancing algorithms.

    As an end-user, see the Balancers API to create instances which can be used to configure a Finagle client with various load balancing strategies.

    As an implementor, each algorithm gets its own subdirectory and is exposed via the Balancers object. Several convenient traits are provided which factor out common behavior and can be mixed in (i.e. Balancer, DistributorT, NodeT, and Updating).

    Definition Classes
    finagle
  • package aperture
    Definition Classes
    loadbalancer
  • package exp
    Definition Classes
    loadbalancer
  • Balancers
  • DefaultBalancerFactory
  • EndpointFactory
  • FlagBalancerFactory
  • LoadBalancerFactory
  • NoNodesOpenException
  • WhenNoNodesOpen
  • WhenNoNodesOpens
  • defaultBalancer
  • perHostStats

object LoadBalancerFactory

Exposes a Stack.Module which composes load balancing into the respective Stack. This is mixed in by default into Finagle's com.twitter.finagle.client.StackClient. The only necessary configuration is a LoadBalancerFactory.Dest which represents a changing collection of addresses that is load balanced over.

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

Type Members

  1. case class AddressOrdering(ordering: Ordering[Address]) extends Product with Serializable

    A class eligible for configuring a com.twitter.finagle.Stackable com.twitter.finagle.loadbalancer.LoadBalancerFactory with a finagle Address ordering.

    A class eligible for configuring a com.twitter.finagle.Stackable com.twitter.finagle.loadbalancer.LoadBalancerFactory with a finagle Address ordering. The collection of endpoints in a load balancer are sorted by this ordering. Although it's generally not a good idea to have the same ordering across process boundaries, the final ordering decision is left to the load balancer implementations. This only provides a stable ordering before we hand off the collection of endpoints to the balancer.

  2. case class Dest(va: Var[Addr]) extends Product with Serializable

    A class eligible for configuring a com.twitter.finagle.Stackable com.twitter.finagle.loadbalancer.LoadBalancerFactory with a collection of addrs to load balance.

  3. case class EnableProbation(enable: Boolean) extends Product with Serializable

    A class eligible for configuring a client's load balancer probation setting.

    A class eligible for configuring a client's load balancer probation setting. When enabled, the balancer treats removals as advisory and flags them. If a a flagged endpoint is also detected as unhealthy by Finagle's session qualifiers (e.g. fail-fast, failure accrual, etc) then the host is removed from the collection.

  4. case class ErrorLabel(label: String) extends Product with Serializable

    A class eligible for configuring a com.twitter.finagle.Stackable com.twitter.finagle.loadbalancer.LoadBalancerFactory with a label for use in error messages.

  5. case class HostStats(hostStatsReceiver: StatsReceiver) extends Product with Serializable

    A class eligible for configuring a com.twitter.finagle.Stackable com.twitter.finagle.loadbalancer.LoadBalancerFactory per host com.twitter.finagle.stats.StatsReceiver.

    A class eligible for configuring a com.twitter.finagle.Stackable com.twitter.finagle.loadbalancer.LoadBalancerFactory per host com.twitter.finagle.stats.StatsReceiver. If the per-host StatsReceiver is not null, the load balancer will broadcast stats to it (scoped with the "host:port" pair) for each host in the destination. For clients with a large host sets in their destination, this can cause unmanageable memory pressure.

  6. case class Param(loadBalancerFactory: LoadBalancerFactory) extends Product with Serializable

    A class eligible for configuring a com.twitter.finagle.Stackable com.twitter.finagle.loadbalancer.LoadBalancerFactory.

  7. case class WhenNoNodesOpenParam(whenNoNodesOpen: WhenNoNodesOpen) extends Product with Serializable

    A class eligible for configuring the LoadBalancerFactory behavior when the balancer does not find a node with Status.Open.

    A class eligible for configuring the LoadBalancerFactory behavior when the balancer does not find a node with Status.Open.

    The default is to "fail open" and pick a node at random.

    See also

    WhenNoNodesOpen

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. val role: Role
  16. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  21. object AddressOrdering extends Serializable
  22. object Dest extends Serializable
  23. implicit object EnableProbation extends Stack.Param[EnableProbation] with Serializable
  24. object ErrorLabel extends Serializable
  25. object HostStats extends Serializable
  26. object Param extends Serializable
  27. object WhenNoNodesOpenParam extends Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped